Getting Started with SimPEG#

Prerequisite: Installing Python#

SimPEG is written in Python! We highly recommend installing it using Anaconda (or the alternative Mambaforge). It installs Python, Jupyter and other core Python libraries for scientific computing. If you and Python are not yet acquainted, we highly recommend checking out Software Carpentry.

Note

As of version 0.11.0, we will no longer ensure compatibility with Python 2.7. Please use the latest version of Python 3 with SimPEG. For more information on the transition of the Python ecosystem to Python 3, please see the Python 3 Statement.

https://upload.wikimedia.org/wikipedia/commons/thumb/c/c3/Python-logo-notext.svg/220px-Python-logo-notext.svg.png

Installing SimPEG#

Conda Forge#

SimPEG is available through conda-forge and you can install is using the conda package manager that comes with the Anaconda distribution:

conda install SimPEG --channel conda-forge

Installing through conda/mamba is our recommended method of installation.

Note

If you find yourself wanting a faster package manager than conda check out the mamba project at https://mamba.readthedocs.io/. It usually is able to set up environments much quicker than conda and can be used as a drop-in replacement (i.e. replace conda commands with mamba).

PyPi#

SimPEG is on pypi! First, make sure your version of pip is up-to-date

pip install --upgrade pip

Then you can install SimPEG

pip install SimPEG

To update SimPEG, you can run

pip install --upgrade SimPEG

Installing from Source#

First (you need git):

git clone https://github.com/simpeg/simpeg

Second (from the root of the SimPEG repository):

pip install .

If you are interested in contributing to SimPEG, please check out the page on Contributing

Success?#

If you have been successful at downloading and installing SimPEG, you should be able to download and run any of the examples and tutorials.

If not, you can reach out to other people developing and using SimPEG on the google forum or on slack.