simpeg-drivers 0.1.0b1__tar.gz

simpeg_drivers-0.1.0b1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Mira Geoscience
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

simpeg_drivers-0.1.0b1/PKG-INFO

@@ -0,0 +1,36 @@
+Metadata-Version: 2.1
+Name: simpeg-drivers
+Version: 0.1.0b1
+Summary: Application to run SimPEG inversions with geoh5 files from Geoscience Analyst.
+Home-page: https://www.mirageoscience.com/mining-industry-software/python-integration/
+License: MIT
+Author: Mira Geoscience
+Author-email: support@mirageoscience.com
+Maintainer: Benjamin Kary
+Maintainer-email: benjamink@mirageoscience.com
+Requires-Python: >=3.10,<3.11
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Requires-Dist: Pillow (>=10.1.0,<10.2.0)
+Requires-Dist: dask[distributed] (==2022.10.*)
+Requires-Dist: discretize (>=0.10.0,<0.11.0)
+Requires-Dist: distributed (==2022.10.*)
+Requires-Dist: geoana (>=0.4.0,<0.5.0)
+Requires-Dist: geoapps-utils (>=0.3.0rc1,<0.4.0)
+Requires-Dist: geoh5py (>=0.9.0rc1,<0.10.0)
+Requires-Dist: h5py (>=3.2.1,<4.0.0)
+Requires-Dist: mira-simpeg (>=0.19.0.8a3,<0.20.0.0)
+Requires-Dist: mkl (==2022.1.*)
+Requires-Dist: numpy (>=1.23.5,<1.24.0)
+Requires-Dist: octree-creation-app (>=0.1.0rc1,<0.2.0)
+Requires-Dist: param-sweeps (>=0.1.7rc1,<0.2.0)
+Requires-Dist: pydantic (>=2.5.2,<2.6.0)
+Requires-Dist: pydiso (>=0.0.3,<0.1.0)
+Requires-Dist: pymatsolver (>=0.2.0,<0.3.0)
+Requires-Dist: scipy (>=1.10.1,<1.11.0)
+Requires-Dist: tqdm (>=4.66.1,<5.0.0)
+Requires-Dist: tzdata (==2023.4)
+Requires-Dist: zarr (>=2.14.2,<2.15.0)
+Project-URL: Documentation, https://mirageoscience-simpeg-drivers.readthedocs-hosted.com/
+Project-URL: Repository, https://github.com/MiraGeoscience/simpeg-drivers

simpeg_drivers-0.1.0b1/README.rst

@@ -0,0 +1,150 @@
+|coverage| |maintainability| |precommit_ci| |docs| |style| |version| |status| |pyversions|
+
+
+.. |docs| image:: https://readthedocs.org/projects/simpeg-drivers/badge/
+    :alt: Documentation Status
+    :target: https://simpeg-drivers.readthedocs.io/en/latest/?badge=latest
+
+.. |coverage| image:: https://codecov.io/gh/MiraGeoscience/simpeg-drivers/branch/develop/graph/badge.svg
+    :alt: Code coverage
+    :target: https://codecov.io/gh/MiraGeoscience/simpeg-drivers
+
+.. |style| image:: https://img.shields.io/badge/code%20style-black-000000.svg
+    :alt: Coding style
+    :target: https://github.com/pf/black
+
+.. |version| image:: https://img.shields.io/pypi/v/simpeg-drivers.svg
+    :alt: version on PyPI
+    :target: https://pypi.python.org/pypi/simpeg-drivers/
+
+.. |status| image:: https://img.shields.io/pypi/status/simpeg-drivers.svg
+    :alt: version status on PyPI
+    :target: https://pypi.python.org/pypi/simpeg-drivers/
+
+.. |pyversions| image:: https://img.shields.io/pypi/pyversions/simpeg-drivers.svg
+    :alt: Python versions
+    :target: https://pypi.python.org/pypi/simpeg-drivers/
+
+.. |precommit_ci| image:: https://results.pre-commit.ci/badge/github/MiraGeoscience/simpeg-drivers/develop.svg
+    :alt: pre-commit.ci status
+    :target: https://results.pre-commit.ci/latest/github/MiraGeoscience/simpeg-drivers/develop
+
+.. |maintainability| image:: https://api.codeclimate.com/v1/badges/_token_/maintainability
+   :target: https://codeclimate.com/github/MiraGeoscience/simpeg-drivers/maintainability
+   :alt: Maintainability
+
+
+simpeg-drivers: # TODO: SHORT DESCRIPTION
+=========================================================================
+The **simpeg-drivers** library # TODO: PACKAGE DESCRIPTION
+
+.. contents:: Table of Contents
+   :local:
+   :depth: 3
+
+Documentation
+^^^^^^^^^^^^^
+`Online documentation <https://simpeg-drivers.readthedocs.io/en/latest/>`_
+
+
+Installation
+^^^^^^^^^^^^
+**simpeg-drivers** is currently written for Python 3.10 or higher.
+
+Install Conda
+-------------
+
+To install **simpeg-drivers**, you need to install **Conda** first.
+
+We recommend to install **Conda** using `miniforge`_.
+
+.. _miniforge: https://github.com/conda-forge/miniforge
+
+Within a conda environment
+--------------------------
+
+You can install (or update) a conda environment with all the requires packages to run **simpeg-drivers**.
+To do so you can directly run the **Install_or_Update.bat** file by double left clicking on it.
+
+Install with conda
+------------------
+
+You can install the package using ``conda`` and the ``.lock`` files from a conda prompt:
+
+.. code-block:: bash
+
+  conda env create -n my-env -f environments/[the_desired_env].lock.yml
+
+Install with PyPI
+-----------------
+
+You should not install the package from PyPI, as the app requires conda packages to run.
+Still, you can install it in a conda environment without its dependencies (``--no-deps``).
+
+From PyPI
+~~~~~~~~~
+
+To install the **simpeg-drivers** package published on PyPI:
+
+.. code-block:: bash
+
+    pip install -U --no-deps simpeg-drivers
+
+From a Git tag or branch
+~~~~~~~~~~~~~~~~~~~~~~~~
+If the package is not on PiPY yet, you can install it from a Git tag:
+
+.. code-block:: bash
+
+    pip install -U --no-deps --force-reinstall https://github.com/MiraGeoscience/simpeg-drivers/archive/refs/tags/TAG.zip
+
+Or to install the latest changes available on a given Git branch:
+
+.. code-block:: bash
+
+    pip install -U --no-deps --force-reinstall https://github.com/MiraGeoscience/simpeg-drivers/archive/refs/heads/BRANCH.zip
+
+.. note::
+    The ``--force-reinstall`` option is used to make sure the updated version
+    of the sources is installed, and not the cached version, even if the version number
+    did not change. The ``-U`` or ``--upgrade`` option is used to make sure to get the latest version,
+    on not merely reinstall the same version. As the package is aimed to be in a **Conda environment**, the option ``--no-deps`` is used to avoid installing the dependencies with pip, as they will be installed with conda.
+
+From a local copy of the sources
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+If you have a git clone of the package sources locally,
+you can install **simpeg-drivers** from the local copy of the sources with:
+
+.. code-block:: bash
+
+    pip install -U --force-reinstall path/to/project_folder_with_pyproject_toml
+
+Or in **editable mode**, so that you can edit the sources and see the effect immediately at runtime:
+
+.. code-block:: bash
+
+    pip install -e -U --force-reinstall path/to/project_folder_with_pyproject_toml
+
+Setup for development
+^^^^^^^^^^^^^^^^^^^^^
+To configure the development environment and tools, please see `README-dev.rst`_.
+
+.. _README-dev.rst: README-dev.rst
+
+License
+^^^^^^^
+# TODO: ADD LICENSE TERMS
+
+Third Party Software
+^^^^^^^^^^^^^^^^^^^^
+The simpeg-drivers Software may provide links to third party libraries or code (collectively “Third Party Software”)
+to implement various functions. Third Party Software does not comprise part of the Software.
+The use of Third Party Software is governed by the terms of such software license(s).
+Third Party Software notices and/or additional terms and conditions are located in the
+`THIRD_PARTY_SOFTWARE.rst`_ file.
+
+.. _THIRD_PARTY_SOFTWARE.rst: THIRD_PARTY_SOFTWARE.rst
+
+Copyright
+^^^^^^^^^
+Copyright (c) 2024 Mira Geoscience Ltd.

simpeg_drivers-0.1.0b1/THIRD_PARTY_SOFTWARE.rst

@@ -0,0 +1,10 @@
+The simpeg_drivers repository and source distributions bundle several libraries that are
+compatibly licensed.  We list these here.
+
+# TODO
+
++---------+--------------+----------------------------------+-------------------------------------------------------------------+
+| Name    | License      | URL                              | Description                                                       |
++---------+--------------+----------------------------------+-------------------------------------------------------------------+
+|         |              |                                  |                                                                   |
++---------+--------------+----------------------------------+-------------------------------------------------------------------+

simpeg_drivers-0.1.0b1/pyproject.toml

@@ -0,0 +1,138 @@
+[tool.poetry]
+name = "simpeg-drivers"
+version = "0.1.0-beta.1"
+description = "Application to run SimPEG inversions with geoh5 files from Geoscience Analyst."
+license = "MIT"
+authors = ["Mira Geoscience <support@mirageoscience.com>"]
+maintainers = [
+    "Benjamin Kary <benjamink@mirageoscience.com>",
+    "Dominique Fournier <dominiquef@mirageoscience.com>",
+]
+repository = "https://github.com/MiraGeoscience/simpeg-drivers"
+documentation = "https://mirageoscience-simpeg-drivers.readthedocs-hosted.com/"
+homepage = "https://www.mirageoscience.com/mining-industry-software/python-integration/"
+
+packages = [
+     { include = "simpeg_drivers" },
+     { include = "simpeg_drivers-assets" },
+]
+
+include = [
+    "COPYING",
+    "COPYING.LESSER",
+    "LICENSE",
+    "README.rst",
+    "THIRD_PARTY_SOFTWARE.rst",
+]
+
+[tool.poetry.dependencies]
+python = "^3.10, <3.11"
+
+dask = {version = "2022.10.*", extras = ["distributed"]}
+discretize = "~0.10.0"
+distributed = "2022.10.*"  # because conda-lock doesn't take dask extras into account
+numpy = "~1.23.5" # also in geoh5py, simpeg
+scipy = "~1.10.1"
+
+## Pip dependencies from Git repositories
+#----------------------------------------
+geoh5py = {version = "~0.9.0rc1", source = "pypi", allow-prereleases = true}
+#geoh5py = {url = "https://github.com/MiraGeoscience/geoh5py/archive/refs/heads/release/0.9.0.zip#sha256="}
+#geoh5py = {url = "http://localhost:8888/geoh5py.tar.gz#sha256="}
+
+octree-creation-app = {version = "~0.1.0rc1", source = "pypi", allow-prereleases = true}
+#octree-creation-app = {url = "https://github.com/MiraGeoscience/octree-creation-app/archive/refs/heads/release/0.1.0.zip#sha256="}
+#octree-creation-app = {url = "http://localhost:8888/octree-creation-app.tar.gz#sha256="}
+
+geoapps-utils = {version = "~0.3.0rc1", source = "pypi", allow-prereleases = true}
+#geoapps-utils = {url = "https://github.com/MiraGeoscience/geoapps-utils/archive/refs/heads/release/0.3.0.zip#sha256="}
+#geoapps-utils = {url = "http://localhost:8888/geoapps-utils.tar.gz#sha256="}
+
+mira-simpeg = {version = "~0.19.0.8a3", source = "pypi", allow-prereleases = true}
+#mira-simpeg = {url = "https://github.com/MiraGeoscience/simpeg/archive/refs/heads/release/0.19.0.8.zip#sha256="}
+#mira-simpeg = {url = "http://localhost:8888/mira-simpeg.tar.gz#sha256="}
+
+param-sweeps = {version = "~0.1.7rc1", source = "pypi", allow-prereleases = true}
+#param-sweeps = {url = "https://github.com/MiraGeoscience/param-sweeps/archive/refs/heads/release/0.1.7.zip#sha256="}
+#param-sweeps = {url = "http://localhost:8888/param-sweeps.tar.gz#sha256="}
+
+## indirect dependencies, forcing them here for installation through Conda not pip
+#---------------------------------------------------------------------------------
+Pillow = "~10.1.0"  # from geoh5py
+geoana = "~0.4.0"  # from simpeg
+h5py = "^3.2.1"  # from geoh5py
+mkl = "2022.1.*"  # from simpeg
+pydantic = "~2.5.2"  # from geoapps-utils
+pydiso = "~0.0.3"  # from simpeg
+pymatsolver = "~0.2.0"  # from simpeg
+tqdm = "^4.66.1"  # from simpeg
+zarr = "~2.14.2"  # from simpeg using Dask
+
+# force some versions to resolve incompatible resolution between PyPI and Conda
+tzdata = "2023.4"  # through pandas from SimPEG
+
+## about pip dependencies
+# to be specified to work with conda-lock
+# - from PyPI: my_package = { version = "1.2.3", source = "pypi" }
+# - from URL:
+#   - for a tags:   my_package = { url = "https://github.com/ORGANISATION/REPO/archive/refs/tags/VERSION_TAG.zip#sha256=" }
+#   - for a branch: my_package = { url = "https://github.com/ORGANISATION/REPO/archive/refs/heads/BRANCH.zip#sha256=" }
+# Note - conda-lock does not support the syntax: my_package = { git = ... }
+#        while poetry2conda supports only { git = "...", tag = "..." }, and not { url = ... }
+
+[tool.poetry.group.dev.dependencies]
+Pygments = "*"
+ipywidgets = "^7.6.5"
+jupyter-book = "^0.13"
+jupytext = "^1.14"
+pylint = "*"
+pytest = "*"
+pytest-cov = "*"
+readthedocs-sphinx-ext = "*"
+sphinx = "^5.0"
+tomli = "*"
+
+[tool.conda-lock]
+platforms = ['win-64', 'linux-64']
+channels = ['conda-forge']
+
+[tool.conda-lock.dependencies]
+libblas = "*=*mkl"  # because simpeg already brings in the MKL
+
+[tool.isort]
+profile = "black"
+
+[tool.black]
+# defaults are just fine
+
+[tool.mypy]
+warn_unused_configs = true
+ignore_missing_imports = true
+scripts_are_modules = true
+show_error_context = true
+show_column_numbers = true
+check_untyped_defs = true
+
+plugins = [
+    "numpy.typing.mypy_plugin",
+]
+
+[tool.coverage.run]
+branch = true
+source = ["simpeg_drivers"]
+
+[tool.coverage.report]
+exclude_lines = [
+    "raise NotImplementedError",
+    "pass",
+    "if TYPE_CHECKING",
+    "pragma: no cover"
+]
+
+[tool.coverage.html]
+skip_empty = true
+skip_covered = true
+
+[build-system]
+requires = ["poetry-core>=1.0.0", "setuptools"]
+build-backend = "poetry.core.masonry.api"

simpeg_drivers-0.1.0b1/simpeg_drivers/__init__.py

@@ -0,0 +1,100 @@
+# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+#  Copyright (c) 2023-2024 Mira Geoscience Ltd.
+#  All rights reserved.
+#
+#  This file is part of simpeg-drivers.
+#
+#  The software and information contained herein are proprietary to, and
+#  comprise valuable trade secrets of, Mira Geoscience, which
+#  intend to preserve as trade secrets such software and information.
+#  This software is furnished pursuant to a written license agreement and
+#  may be used, copied, transmitted, and stored only in accordance with
+#  the terms of such license and with the inclusion of the above copyright
+#  notice.  This software and information or any other copies thereof may
+#  not be provided or otherwise made available to any other person.
+#
+# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+
+# pylint: disable=unused-import
+# flake8: noqa
+
+from __future__ import annotations
+
+__version__ = "0.1.0-beta.1"
+
+from pathlib import Path
+
+from SimPEG import dask
+
+from simpeg_drivers.constants import default_ui_json
+from simpeg_drivers.params import InversionBaseParams
+
+
+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 = {
+    "direct current 3d": (
+        "simpeg_drivers.electricals.direct_current.three_dimensions.driver",
+        "DirectCurrent3DDriver",
+    ),
+    "direct current 2d": (
+        "simpeg_drivers.electricals.direct_current.two_dimensions.driver",
+        "DirectCurrent2DDriver",
+    ),
+    "direct current pseudo 3d": (
+        "simpeg_drivers.electricals.direct_current.pseudo_three_dimensions.driver",
+        "DirectCurrentPseudo3DDriver",
+    ),
+    "induced polarization 3d": (
+        "simpeg_drivers.electricals.induced_polarization.three_dimensions.driver",
+        "InducedPolarization3DDriver",
+    ),
+    "induced polarization 2d": (
+        "simpeg_drivers.electricals.induced_polarization.two_dimensions.driver",
+        "InducedPolarization2DDriver",
+    ),
+    "induced polarization pseudo 3d": (
+        "simpeg_drivers.electricals.induced_polarization.pseudo_three_dimensions.driver",
+        "InducedPolarizationPseudo3DDriver",
+    ),
+    "joint surveys": (
+        "simpeg_drivers.joint.joint_surveys.driver",
+        "JointSurveyDriver",
+    ),
+    "fem": (
+        "simpeg_drivers.airborne_electromagnetics.frequency_domain.driver",
+        "FrequencyDomainElectromagneticsDriver",
+    ),
+    "joint cross gradient": (
+        "simpeg_drivers.joint.joint_cross_gradient.driver",
+        "JointCrossGradientDriver",
+    ),
+    "tdem": (
+        "simpeg_drivers.electromagnetics.time_domain.driver",
+        "TimeDomainElectromagneticsDriver",
+    ),
+    "magnetotellurics": (
+        "simpeg_drivers.natural_sources.magnetotellurics.driver",
+        "MagnetotelluricsDriver",
+    ),
+    "tipper": ("simpeg_drivers.natural_sources.tipper.driver", "TipperDriver"),
+    "gravity": ("simpeg_drivers.potential_fields.gravity.driver", "GravityDriver"),
+    "magnetic scalar": (
+        "simpeg_drivers.potential_fields.magnetic_scalar.driver",
+        "MagneticScalarDriver",
+    ),
+    "magnetic vector": (
+        "simpeg_drivers.potential_fields.magnetic_vector.driver",
+        "MagneticVectorDriver",
+    ),
+}

simpeg_drivers-0.1.0b1/simpeg_drivers/components/__init__.py

@@ -0,0 +1,27 @@
+# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+#  Copyright (c) 2023-2024 Mira Geoscience Ltd.
+#  All rights reserved.
+#
+#  This file is part of simpeg-drivers.
+#
+#  The software and information contained herein are proprietary to, and
+#  comprise valuable trade secrets of, Mira Geoscience, which
+#  intend to preserve as trade secrets such software and information.
+#  This software is furnished pursuant to a written license agreement and
+#  may be used, copied, transmitted, and stored only in accordance with
+#  the terms of such license and with the inclusion of the above copyright
+#  notice.  This software and information or any other copies thereof may
+#  not be provided or otherwise made available to any other person.
+#
+# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+
+# pylint: disable=unused-import
+# flake8: noqa
+
+from __future__ import annotations
+
+from .data import InversionData
+from .meshes import InversionMesh
+from .models import InversionModel, InversionModelCollection
+from .topography import InversionTopography
+from .windows import InversionWindow