Getting Started with SimPEG#

Prerequisite: Installing Python#

We highly recommend installing python using Anaconda. It installs python, Jupyter and other core python libraries for scientific computing.

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.

Installing SimPEG#

Conda Forge#

You can install SimPEG using the conda package manager that comes with the Anaconda distribution:

conda install SimPEG --channel conda-forge

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):

python setup.py 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.