Installing

Which Python?

You’ll need Python 3.7 or greater. See Supported Python versions if you require support for older versions.

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

The required dependencies should be installed automatically when you install Harmonica using conda or pip. Optional dependencies have to be installed manually.

Note

See Supported dependency versions for the our policy of oldest supported versions of each dependency.

Required:

Optional:

The examples in the Gallery also use:

  • boule

  • ensaio for downloading sample datasets

  • pygmt for plotting maps

  • pyproj for cartographic projections

  • ensaio for downloading sample datasets

Installing with conda

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

conda install harmonica --channel conda-forge

Installing with pip

Alternatively, you can also use the pip package manager:

pip install harmonica

Installing the latest development version

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

pip install https://github.com/fatiando/harmonica/archive/main.zip

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

git clone https://github.com/fatiando/harmonica.git
cd harmonica
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:

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

import harmonica
harmonica.test()