pmagpy-cli 3.7.0

Analysis tools for paleo/rock magnetic data

## What is it

PmagPy is a comprehensive set of tools for analyzing paleomagnetic data. It facilitates interpretation of demagnetization data, Thellier-type experimental data and data from other types of rock magnetic experiments. PmagPy can be used to create a wide variety of useful plots. It is designed to work with the MagIC database (https://earthref.org/MagIC), allowing manipulation of downloaded data sets as well as preparation of new contributions for uploading to the MagIC database. It also supports the use of IPython/Jupyter notebooks for fully documented and nicely illustrated data analysis.

## Main features

PmagPy is comprised of:

• GUI programs for getting data into MagIC database format (pmag_gui), analyzing demagnetization data (demag_gui) and analyzing paleointensity data (thellier_gui). These GUIs are also availible for download as executable programs outside of this repository: - [Mac PmagPy Executable Application](https://github.com/PmagPy/PmagPy-Standalone-OSX/releases/latest) - [Windows PmagPy Executable Application](https://github.com/PmagPy/PmagPy-Standalone-Windows/releases/latest)

• Command line programs for all sorts of paleomagnetic data analysis and wrangling (contained within the programs folder of the repository and pip installed as pmagpy-cli).

• The pmagpy function module for paleomagnetic data analysis (pmagpy.pmag) and plotting (pmagpy.pmagplotlib) as well as a function module that further enables paleomagnetic data analysis within interactive computing environments such as the Jupyter notebook (pmagpy.ipmag). The functions within these modules are at the heart of the GUI and command line programs. With pmagpy in the python path (which is accomplished using pip, see below), these modules are can be imported (e.g. `import pmagpy.ipmag as ipmag`).

• Example data files that are used in the examples provided in the PmagPy cookbook http://earthref.org/PmagPy/cookbook

Use of all these features is described in the cookbook and the underlying science behind the data and code can be explored in the book Essentials of Paleomagnetism: Third Web Edition (http://earthref.org/MagIC/books/Tauxe/Essentials/).

## How to get it

Much more complete documentation for PmagPy installation and use is available in the PmagPy cookbook: http://earthref.org/PmagPy/cookbook

### Stand alone applications If you do not need the full PmagPy functionality, and you only want to use Pmag GUI, MagIC GUI, Thellier GUI, and Demag GUI, there a standalone download for which Python does not need to be installed.

#### OSX Standalone download

To get started, download the zip file and put the resulting folder on your desktop. Inside the PmagPy-Standalone folder you will have one folder each for Pmag GUI and MagIC GUI. Open the appropriate folder and double click the icon (depending on your security settings, you may have to right click the icon and then select “ok” the first time you open it). You’ll find the latest stable release at: https://github.com/PmagPy/PmagPy-Standalone-OSX/releases/latest

#### Windows Standalone download

In order to install this software, you will need to download and install Microsoft Visual C++ Redistributable Package. This provides some backend dependencies that let our software run. Next, get started by downloading the zip file (see links below) and putting the resulting folder on your desktop. You’ll need to “extract all” files. Inside the PmagPy-Standalone folder you will find icons for installing Pmag GUI and MagIC GUI. Double click the program you wish to use and you will be guided the the install process. You’ll find the latest stable release at: https://github.com/PmagPy/PmagPy-Standalone-Windows/releases/latest

### Full PmagPy install

To get the full use of PmagPy functionality, you will first have to have a Python installation with some standard scientific modules. You can follow instructions to do so [here](https://earthref.org/PmagPy/cookbook/#x1-60001.2). Once you have Python installed:

• Find and open your command line (for help finding your command prompt, see the [documentation](http://earthref.org/PmagPy/#command_line))

• Update pip: type on the command line: `pip install --upgrade pip`

• Install or update pmagpy: use the command: `pip install --upgrade pmagpy`

• Install or update pmagpy-cli, use the command: `pip install --upgrade pmagpy-cli`

• To uninstall, use the commands: `pip uninstall pmagpy` and `pip uninstall pmagpy-cli`

• If you run into trouble, use pip to uninstall both pmagpy and pmagpy-cli, then try again to install first pmagpy and then pmagpy-cli

If you want access to the master branch rather than the latest release you can: - either clone the repository or download the latest release and then add the directory of the main repository folder (and the program directory for access to the command line programs) to their path. On a Mac, this can be done by adding these lines to the bash_profile (edited as necessary for where the PmagPy directory is on your local machine): `export PATH=~/PmagPy:./:$PATH`; `export PATH=~/PmagPy/programs:./:$PATH`

## Background and support

The code base for the PmagPy project has been built up over many years by Lisa Tauxe (Distinguished Professor of Geophysics at the Scripps Institution of Oceanography) supported by grants from the National Science Foundation. Ron Shaar (Senior Lecturer at the Hebrew University of Jerusalem), Lori Jonestrask and Nick Swanson-Hysell (Assistant Professor at UC Berkeley) have also made substantial contributions to the project.

## More information

This code and the PmagPy cookbook (http://earthref.org/PmagPy/cookbook) are companions to the the book Essentials of Paleomagnetism: Third Web Edition (http://earthref.org/MagIC/books/Tauxe/Essentials/) written by Lisa Tauxe with contributions from Subir K. Banerjee, Robert F. Butler and Rob van der Voo. The printed version of the book came out in January, 2010 from University of California Press (http://www.ucpress.edu/book.php?isbn=9780520260313).

## Licensing

This code can be freely used, modified, and shared. It is licensed under a 3-clause BSD license. See [license.txt](https://github.com/ltauxe/PmagPy/blob/master/license.txt) for details.