Skip to content

Latest commit

 

History

History
208 lines (144 loc) · 7.47 KB

intro.md

File metadata and controls

208 lines (144 loc) · 7.47 KB
Raw
title
PmagPy

PmagPy: An open source package for paleomagnetic data analysis

PmagPy is a set of tools written in Python for the analysis of paleomagnetic data. It facilitates interpretation of demagnetization data, paleointensity data, and data from other types of rock magnetic experiments. The package is hosted on Github (https://github.com/PmagPy/PmagPy) and can be pip installed via PyPi (https://pypi.org/project/pmagpy/). 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) and enables manipulation of downloaded MagIC data sets as well as preparation of new contributions for uploading to the MagIC database. Utilizing PmagPy within Jupyter notebooks enables fully documented and nicely illustrated data analysis.

::::{grid} 1 1 2 3 :class-container: text-center :gutter: 3

:::{grid-item-card} :link: installation/PmagPy_install :link-type: doc :class-header: bg-light

Installation 🪴 ^^^

Instructions for how to install PmagPy for your use case.

:::

:::{grid-item-card} :link: documentation_notebooks/PmagPy_introduction :link-type: doc :class-header: bg-light

Documentation notebooks ✏️ ^^^

See capabilities of PmagPy functions within these documentation Jupyter notebooks. :::

:::{grid-item-card} :link: example_notebooks/template_notebooks :link-type: doc :class-header: bg-light

Example notebooks 📓 ^^^

See example template notebooks that analyze datasets from the MagIC database using PmagPy.

:::

:::{grid-item-card} :link: https://jupyterhub.earthref.org/ :class-header: bg-light

Live notebooks 🚀 ^^^

Launch PmagPy notebooks on the Earthref JupyterHub :::

:::{grid-item-card} :link: https://github.com/PmagPy/PmagPy-Standalone-OSX/releases/latest/ :class-header: bg-light

GUIs 🎁 ^^^

Download and use Pmag GUI to analyze data and prepare data for MagIC. :::

:::{grid-item-card} :link: https://www2.earthref.org/MagIC/ :class-header: bg-light

MagIC database ⚡ ^^^

Develop new contributions and analyze existing datasets in the MagIC database. :::

::::

PmagPy is comprised of:

  • Function modules for paleomagnetic data analysis These function modules enable paleomagnetic data analysis (pmagpy.pmag) and plotting (pmagpy.pmagplotlib) as well as interactive higher level data analysis (pmagpy.ipmag). The functions within these modules are at the heart of the GUI and command line programs. With pmagpy as part of your Python installation (which can be accomplished through pip installation pip install pmagpy), these modules can be imported (e.g. import pmagpy.ipmag as ipmag). These functions can be used within Jupyter Notebooks (see examples in the documentation notebooks) and are documented within the API Reference.
  • A graphical user interface (GUI) program The PmagPy application enables users to get data into the MagIC database format as well as analyze demagnetization and paleointensity data.
  • Command line programs The PmagPy command line programs enable all sorts of paleomagnetic data analysis and wrangling. They are contained within the programs folder of the PmagPy repository (https://github.com/PmagPy/PmagPy) and can be pip installed (pip install pmagpy-cli).

Citing PmagPy

Users of PmagPy should cite the open access article {cite:p}Tauxe2016a:

Tauxe, L., R. Shaar, L. Jonestrask, N. L. Swanson-Hysell, R. Minnett, A. A. P. Koppers, C. G. Constable, N. Jarboe, K. Gaastra, and L. Fairchild (2016), PmagPy: Software package for paleomagnetic data analysis and a bridge to the Magnetics Information Consortium (MagIC) Database, Geochem. Geophys. Geosyst., 17, doi:10.1002/2016GC006307.

Connect with us

We are an open source community that welcomes discussion, feedback, and contributions of many kinds.

::::{grid} 1 1 2 2 :class-container: text-center :gutter: 3

:::{grid-item-card} :class-header: bg-light

🌍 About our team

^^^

The code base for the PmagPy project has been built up over the years by Lisa Tauxe (@ltauxe; Professor Emerita at the Scripps Institution of Oceanography). Nick Swanson-Hysell (@swanson-hysell; Associate Professor at UC Berkeley), Lori Jonestrask (@moonshoes87), and Ron Shaar (@ronshaar, Senior Lecturer at the Hebrew University of Jerusalem) have made substantial contributions to the project as have others in the open community of contributors. :::

:::{grid-item-card} :class-header: bg-light

🙌 Contribute and raise issues

^^^

We welcome anyone to join us in improving PmagPy and helping one another learn as we conduct reproducible research in rock magnetism and paleomagnetism. You can do this be contributing code, improving documentation, or raising issues.

Check out our contributing guide. :::

::::

Analyzed with PmagPy

Below are just a few of the hundreds of papers that have conducted analysis with PmagPy. You can find more on {bdg-primary}Google Scholar.

::::{card-carousel} 3

:::{card} :margin: 3 :class-body: text-center :class-header: bg-light text-center :link: https://www.nature.com/articles/s41550-021-01469-y Moon rocks ^^^

:height: 100

Nature Astronomy: The palaeoinclination of the ancient lunar magnetic field from an Apollo 17 basalt {cite:p}Nichols2021a +++ Explore this paper {fas}arrow-right :::

:::{card} :margin: 3 :class-body: text-center :class-header: bg-light text-center :link: https://doi.org/10.1130/B32012.1

Supercontinents ^^^

:height: 100

GSAB: Paleomagnetism of the Chuar Group...with implications for the makeup and breakup of Rodinia {cite:p}Eyster2020a +++ Explore this paper {fas}arrow-right :::

:::{card} :margin: 3 :class-body: text-center :class-header: bg-light text-center :link: https://doi.org/10.1029/2018GC007509

Ancient fields ^^^

:height: 100

G^3: Archeointensity of the Four Corners Region of the American Southwest {cite:p}Jones2020b +++ Explore this paper {fas}arrow-right :::

::::

Learn more about paleomagnetism 📖

The online textbook Essentials of Paleomagnetism is a place to learn more about Earth's geomagnetic field, rock magnetism, paleomagnetism, statistics associated with paleomagnetic data, and more. The problems within the book call upon the reader to use PmagPy functions.

Acknowledgements

::::{grid} 2 2 2 2

:::{grid-item} :columns: 4

:class: m-auto
:width: 150px

:::

:::{grid-item} :columns: 7 PmagPy has been developed in the context of research supported by grants from the National Science Foundation awarded to Lisa Tauxe and Nick Swanson-Hysell. Current development is supported by the National Science Foundation through its support for the MagIC database and PmagPy. :::

::::