__init__.py

# '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
#  Copyright (c) 2023-2026 Mira Geoscience Ltd.                                     '
#                                                                                   '
#  This file is part of simpeg-drivers package.                                     '
#                                                                                   '
#  simpeg-drivers is distributed under the terms and conditions of the MIT License  '
#  (see LICENSE file at the root of this source code package).                      '
#                                                                                   '
# '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''


from __future__ import annotations

import logging
from pathlib import Path

from packaging.version import Version


try:
    from ._version import __version__
except ModuleNotFoundError:  # pragma: no cover
    from datetime import datetime

    __date_str = datetime.today().strftime("%Y%m%d")
    __version__ = "0.0.0.dev0+" + __date_str


logging.basicConfig(level=logging.INFO)


__all__ = ["DRIVER_MAP", "assets_path", "public_version"]


def public_version() -> str:
    """Return the current public version."""
    return Version(__version__).public


def assets_path() -> Path:
    """Return the path to the assets folder."""

    parent = Path(__file__).parent
    folder_name = f"{parent.name}-assets"
    assets_folder = parent.parent / folder_name
    if not assets_folder.is_dir():
        raise RuntimeError(f"Assets folder not found: {assets_folder}")

    return assets_folder


DRIVER_MAP = {
    "apparent conductivity": (
        "simpeg_drivers.natural_sources.apparent_conductivity",
        {"forward": "AppConForwardDriver", "inversion": "AppConInversionDriver"},
    ),
    "direct current 3d": (
        "simpeg_drivers.electricals.direct_current.three_dimensions",
        {
            "forward": "DC3DForwardDriver",
            "inversion": "DC3DInversionDriver",
        },
    ),
    "direct current 2d": (
        "simpeg_drivers.electricals.direct_current.two_dimensions",
        {
            "forward": "DC2DForwardDriver",
            "inversion": "DC2DInversionDriver",
        },
    ),
    "direct current pseudo 3d": (
        "simpeg_drivers.electricals.direct_current.two_dimensions",
        {
            "forward": "DC2DForwardDriver",
            "inversion": "DC2DInversionDriver",
        },
    ),
    "fdem": (
        "simpeg_drivers.electromagnetics.frequency_domain",
        {
            "forward": "FDEMForwardDriver",
            "inversion": "FDEMInversionDriver",
        },
    ),
    "fem": (
        "simpeg_drivers.electromagnetics.frequency_domain",
        {
            "forward": "FDEMForwardDriver",
            "inversion": "FDEMInversionDriver",
        },
    ),
    "fdem 1d": (
        "simpeg_drivers.electromagnetics.frequency_domain_1d",
        {
            "forward": "FDEM1DForwardDriver",
            "inversion": "FDEM1DInversionDriver",
        },
    ),
    "gravity": (
        "simpeg_drivers.potential_fields.gravity",
        {"forward": "GravityForwardDriver", "inversion": "GravityInversionDriver"},
    ),
    "induced polarization 3d": (
        "simpeg_drivers.electricals.induced_polarization.three_dimensions",
        {
            "forward": "IP3DForwardDriver",
            "inversion": "IP3DInversionDriver",
        },
    ),
    "induced polarization 2d": (
        "simpeg_drivers.electricals.induced_polarization.two_dimensions",
        {
            "forward": "IP2DForwardDriver",
            "inversion": "IP2DInversionDriver",
        },
    ),
    "induced polarization pseudo 3d": (
        "simpeg_drivers.electricals.induced_polarization.two_dimensions",
        {
            "forward": "IP2DForwardDriver",
            "inversion": "IP2DInversionDriver",
        },
    ),
    "joint cross gradient": (
        "simpeg_drivers.joint.joint_cross_gradient",
        {"inversion": "JointCrossGradientDriver"},
    ),
    "joint petrophysics": (
        "simpeg_drivers.joint.joint_petrophysics",
        {"inversion": "JointPetrophysicsDriver"},
    ),
    "joint surveys": (
        "simpeg_drivers.joint.joint_surveys",
        {"inversion": "JointSurveysDriver"},
    ),
    "magnetic scalar": (
        "simpeg_drivers.potential_fields.magnetic_scalar",
        {
            "forward": "MagneticForwardDriver",
            "inversion": "MagneticInversionDriver",
        },
    ),
    "magnetic vector": (
        "simpeg_drivers.potential_fields.magnetic_vector",
        {
            "forward": "MagneticVectorForwardDriver",
            "inversion": "MagneticVectorInversionDriver",
        },
    ),
    "magnetotellurics": (
        "simpeg_drivers.natural_sources.magnetotellurics",
        {
            "forward": "MTForwardDriver",
            "inversion": "MTInversionDriver",
        },
    ),
    "tdem": (
        "simpeg_drivers.electromagnetics.time_domain",
        {
            "forward": "TDEMForwardDriver",
            "inversion": "TDEMInversionDriver",
        },
    ),
    "tdem 1d": (
        "simpeg_drivers.electromagnetics.time_domain_1d",
        {
            "forward": "TDEM1DForwardDriver",
            "inversion": "TDEM1DInversionDriver",
        },
    ),
    "tipper": (
        "simpeg_drivers.natural_sources.tipper",
        {"forward": "TipperForwardDriver", "inversion": "TipperInversionDriver"},
    ),
    "plate simulation": (
        "simpeg_drivers.plate_simulation",
        {"forward": "PlateSimulationDriver"},
    ),
    "plate sweep": (
        "simpeg_drivers.plate_simulation.sweep",
        {"forward": "PlateSweepDriver"},
    ),
    "plate match": (
        "simpeg_drivers.plate_simulation.match",
        {"forward": "PlateMatchDriver"},
    ),
}