PmagPy-Cookbook

This repository contains the cookbook for installing and using PmagPy. The cookbook can be viewed as a webpage at https://earthref.org/PmagPy/cookbook/. PmagPy is a software package written in Python that contains programs and function libraries used for the analysis and plotting of paleomagnetic and rock magnetic data. The PmagPy code is hosted here: https://github.com/PmagPy/PmagPy

Project Information

This documentation of the PmagPy software is updated from that in the book entitled Essentials of Paleomagnetism by Tauxe et al., (2010). This cookbook was designed and written by Lisa Tauxe as a companion website to the the book Essentials of Paleomagnetism which is now availible as the 3rd web edition (https://earthref.org/MAGIC/books/Tauxe/Essentials/). Chapter references to this companion book are, for example, “Essentials Chapter X”.

The files in the cookbook were first added to this Github repository on January 14, 2014 and at that point represented a version of the cookbook that was last updated on May 24, 2013. The vast majority of the content was written and generated by Lisa Tauxe with contributions from other "chefs," in particular, the MagIC Database Team (Cathy Constable, Anthony Koppers, Rupert Minnett, Nick Jarboe, Lori Jonestrask, Ron Shaar, and Nick Swanson-Hysell).

Generating website after edits to the cookbook

1. Execute the htlatex command (this comes with standard latex distributions) as follows:

   % htlatex PmagPy "xhtml,1,sections+,charset=utf-8" " -cmozhtf -utf8"

2. This command will regenerate PmagPy.html and the .png files that are called upon in the .html

3. If the above fails, try:

   % htlatex PmagPy "html,1,sections+"

4. For more information on the formatting the htlatex command, see stackexchange

5. do htlatex on any other .tex files that were modified, for example:

   % htlatex osx_developer.tex

6. Commit the changes to the files: git commit -a -m "describe changes here"

7. Push the changes: git push