Installing PmagPy

Installing PmagPy#

You have several options for using PmagPy, depending on what you want to do with it.

  • If you only want the graphical user interfaces (GUIs) — Pmag GUI, Demag GUI, and Thellier GUI — without the rest of PmagPy’s functionality, you can download a standalone application that doesn’t require Python (see Standalone GUI download).

  • If you want the full PmagPy library, the command-line programs, and the ability to use PmagPy in Jupyter notebooks, do a pip install.

  • If you want to actively contribute to PmagPy or follow the latest commits between releases, do a developer install from a local clone of the repository.

You can also use PmagPy without installing anything by going to the Jupyter notebooks hosted at the EarthRef JupyterHub:

  • If you don’t have an EarthRef account, go to https://earthref.org/log-in and create one with your ORCID. (If you don’t have an ORCID, you can create one there too.)

  • Once logged in, go to https://jupyterhub.earthref.org and log in with your EarthRef account.

  • Click on the PmagPy Online - Setup.ipynb link and follow the instructions.

  • To learn more about Jupyter notebooks and Python, the Python for Earth Sciences class is a good starting point.

pip install#

If you already have a working Python environment on your computer or in a cloud environment like Google Colab, you can install PmagPy with:

pip install pmagpy

Or, to also get the optional mapping libraries (cartopy and shapely) for map-making functions:

pip install pmagpy[maps]

To get the associated command-line programs, install pmagpy-cli:

pip install pmagpy-cli

For guidance on getting set up a Python environment with the necessary dependencies, the pip install page walks through the recommended approach (conda for the scientific Python packages, then pip for PmagPy on top) along with notes for macOS, Windows, and Linux.

Standalone GUI download#

If you only want to use Pmag GUI, MagIC GUI, Thellier GUI, and Demag GUI, you can download a standalone application that doesn’t require Python.

Standalone GUI binaries are available only for macOS and Windows. Linux users should use the pip install instead — it works smoothly on Linux when combined with conda for the GUI dependencies.

PmagPy developer install#

If you want to work directly from the current code in the repository — to contribute, follow development between releases, or test a feature branch — do a developer install.

If you have an existing pip install in the same Python environment, uninstall it first to avoid conflicts:

pip uninstall pmagpy pmagpy-cli

Getting help#

If you run into trouble during installation, see the troubleshooting page.

To report a bug or request a feature, open a GitHub issue. For broader contribution questions, including how to submit pull requests, see the contribution guidelines.

Next steps#

Once you have PmagPy installed: