simpeg-drivers: # TODO: SHORT DESCRIPTION

The simpeg-drivers library # TODO: PACKAGE DESCRIPTION

Table of Contents

• Documentation
• Installation
  • Install Conda
  • Within a conda environment
  • Install with conda
  • Install with PyPI
    • From PyPI
    • From a Git tag or branch
    • From a local copy of the sources
• Setup for development
• License
• Third Party Software
• Copyright

Documentation

Online documentation

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.

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:

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:

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:

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:

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:

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:

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.

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.

Copyright

Copyright (c) 2024 Mira Geoscience Ltd.