Installing¶

Which Python?¶

You’ll need Python 3.6 or greater.

We recommend using the Anaconda Python distribution to ensure you have all dependencies installed and the conda package manager available. Installing Anaconda does not require administrative rights to your computer and doesn’t interfere with any other Python installations in your system.

Dependencies¶

numpy
attrs

When installing Boule via conda or pip, missing dependencies will be installed automatically. You only need to install them manually if using the latest development version from GitHub.

Installing with conda¶

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

conda install boule --channel conda-forge

Installing with pip¶

Alternatively, you can also use the pip package manager:

pip install boule

Installing the latest development version¶

You can use pip to install the latest source from Github:

pip install https://github.com/fatiando/boule/archive/master.zip

Alternatively, you can clone the git repository locally and install from there:

git clone https://github.com/fatiando/boule.git
cd boule
pip install .

Testing your install¶

We ship a full test suite with the package. To run the tests, you’ll need to install some extra dependencies first:

pytest

After that, you can test your installation by running the following inside a Python interpreter:

import boule
boule.test()

Boule v0.3.1