PmagPy Command Line Version¶

by Lisa Tauxe, Lori Jonestrask, Nick Swanson-Hysell and Nick Jarboe

What is PmagPy?¶

PmagPy is a software package for analyzing paleomagnetic and rock magnetic data using Python. This notebook demonstrates the use of PmagPy command line scripts. This notebook demonstrates the use of PmagPy functions on the command line. For examples of how to use PmagPy scripts in a Python environment, see the PmagPy introduction.

What are paleomagnetism and rock magnetism?¶

For information on the science of paleomagnetism and rock magnetism, see textbook at: https://earthref.org/MagIC/books/Tauxe/Essentials/

Get started¶

These examples are meant to function from within the PmagPy-data directory and calls are relative to that (PmagPy directory for developers).
To specify a working directory, many programs have the command line argument -WD.

Help¶

You can get more details about any program on your command line or in a notebook. There are many options available for each program, all of which are listed in each program's help message. To call up the help message, you just need to use the command line argument -h. See the examples below:

To get help within the notebook environment:

! program_name.py -h

To get help on the command line:

program_name.py -h

If you are running Windows, you may need to run:

program_name -h

Here's an example of calling up the help message for program angle.py:

!angle.py -h

    NAME
        angle.py

    DESCRIPTION
      calculates angle between two input directions D1,D2

    INPUT (COMMAND LINE ENTRY)
           D1_dec D1_inc D1_dec D2_inc
    OUTPUT
           angle

    SYNTAX
        angle.py [-h][-i] [command line options] [< filename]

    OPTIONS
        -h prints help and quits
        -i for interactive data entry
        -f FILE input filename
        -F FILE output filename (required if -F set)
        Standard I/O

Guide to PmagPy¶

the functions in this notebook are listed alphabetically so here is a handy guide by function:
Calculations:
- angle.py : calculates the angle between two vectors
- apwp.py : returns predicted paleolatitudes, directions and pole latitude/longitude from apparent polar wander paths of Besse and Courtillot (2002).
- b_vdm.py : converts B (in microT) and (magnetic) latitude to V(A)DM (see vdm_b.py)
- bootams.py : calculates bootstrap statistics for tensor data
- cart_dir.py : converts cartesian coordinates (x,y,z) to declination, inclination, intensity (see dir_cart.py)
- di_eq.py : maps declination, inclinatitions to X,Y for plotting in equal area projections
- di_geo.py : rotates declination, inclination in specimen coordinates to geographic
- di_rot.py : rotates directions to a coordinate system with D,I as center
- di_tilt.py : rotates directions to stratigraphic coordinates
- di_vgp.py : converts direction to Virtual Geomagnetic Pole (see vgp_di.py)
- dia_vgp.py : converts direction and $\alpha_{95}$ to Virtual Geomagnetic Pole and dp,dm
- dipole_pinc.py : calculates inclination given latitude assuming geocentric axial dipole
- dipole_plat.py : calculates latitude given inclination assuming geocentric axial dipole
- dir_cart.py : converts declination, inclination, intensity to cartesian coordinates (see cart_dir.py)
- eigs_s.py : converts eigenparameters to equivalent 6 element tensor (see s_eigs.py)
- eq_di.py : takes X,Y from equal area projection (e.g., from digitized coordinates) and converts to declination, inclination
- fcalc.py : returns the value from an F table, given the degrees of freedom.
- fisher.py : generates sets of directions drawn from Fisher distributions with vertical true mean
- fishrot.py : generates sets of directions drawn from Fisher distributions with arbitrary true mean
- gaussian.py : generates data drawn from a normal distribution
- gobing.py : calculates Bingham statistics from a set of directions
- gofish.py : calculates Fisher statistics from a set of directions
- gokent.py : calculates Kent statistics from a set of directions
- goprinc.py : calculates principal directions statistics
- igrf.py : calculates geomagnetic field vectors for location, age given a field model (e.g., IGRF)
- incfish.py : estimates the true mean inclination from inclination only data
- pca.py : calculates the best-fit line or plane for demagnetization data and associated statistics
- pt_rot.py : rotates point given finite rotation pole
- scalc.py : calculates VGP scatter
- s_eigs.py : takes a 6 element tensor and calculates eigen parameters (see eigs_s.py)
- s_geo.py : rotates 6 element tensors to geographic coordinates
- s_hext.py : calculates Hext statistics from 6 element tensors
- s_tilt.py : rotates 6 element tensors to stratigraphic coordinates
- squish.py: flattens inclination data given flattening factor (see unsquish.py)
- sundec.py : calulates direction to sun for location, date, time and sun azimuth
- tk03.py : generates sets of directions consistent with the TK03 field model
- uniform.py : generates sets of uniformly distributed directions
- unsquish.py : unsquishes flattened inclinations, given flattening factor (see squish.py)
- vector_mean : calculates vector mean for sets of vectors (declination, inclination, intensity)
- vdm_b.py : calculates intensity at given location from specified virtual dipole moment (see b_vdm.py)
- vgp_di.py : calculates direction at given location from virtual geomagnetic pole (see di_vgp.py)
- watsons_f.py : calculates Watson's F statistic for testing for common mean
Plots:
- ani_depthplot.py : plots anisotropy data against depth in stratigraphic section (Xmas tree plots)
- aniso_magic.py : makes plots of anisotropy data and bootstrapped confidences
- biplot_magic.py : plots different columns against each other in MagIC formatted data files
- chi_magic.py : plots magnetic susceptibility data in MagIC format as function of field, frequency or temperature
- common_mean.py : graphical approach to testing two sets of directions for common mean using bootstrap
- core_depthplot.py : plots MagIC formatted data
- curie.py : makes plots of Curie Temperature data and provides estimates for Tc
- dayplot_magic.py : makes Day et al. (1977) and other plots with hysteresis statistics
- dmag_magic.py : plots remanence against demagnetization step for MagIC formatted files
- eqarea.py and eqarea_magic.py : makes equal area projections for directions
- eqarea_ell.py : makes equal area projections for directions with specified confidence ellipses
- find_ei.py : finds the inclination unflattening factor that unsquishes directions to match TK03 distribution
- fishqq.py: makes a Quantile-Quantile plot for directions against uniform and exponential distributions
- foldtest.py & foldtest_magic.py : finds tilt correction that maximizes concentration of directions, with bootstrap confidence bounds.
- forc_diagram.py: plots FORC diagrams for both conventional and irregular FORCs
- hysteresis_magic.py : makes plots of hysteresis data (not FORCs).
- irm_unmix.py : analyzes IRM acquisition data in terms of coercivity distributions
- irmaq_magic.py : plots IRM acquistion data
- lnp_magic.py : plots lines and planes for site level data and calculates best fit mean and alpha_95
- lowes.py : makes a plot of the Lowe's spectrum for a geomagnetic field model
- lowrie.py and lowrie_magic.py : makes plots of Lowrie's (1990) 3D-IRM demagnetization experiments
- plot_cdf.py : makes a cumulative distribution plot of data
- plotdi_a.py : makes equal are plots of directions and their $\alpha_{95}$s
- plot_geomagia.py : makes plots from files downloaded from the geomagia website
- plot_magic_keys.py : plots data from MagIC formatted data files
- qqplot.py : makes a Quantile-Quantile plot for data against a normal distribution
- qqunf.py : makes a Quantile-Quantile plot for data against a uniform distribution
- quick_hyst.py : makes quick hysteresis plots
- revtest.py & revtest_magic.py : performs a bootstrap reversals test
- thellier_magic.py : makes plots of thellier-thellier data.
- watsons_v.py : makes a graph for Watson's V test for common mean
- zeq.py and zeq_magic.py : makes quicky zijderveld plots for measurement data
Maps:
- cont_rot.py : makes plots of continents after rotation to specified coordinate system
- plot_magmap.py : makes a color contour plot of geomagnetic field models
- plot_map_pts.py : plots points on maps
- polemap_magic.py : reads in MagIC formatted file with paleomagnetic poles and plots them
- vgpmap_magic.py : reads in MagIC formatted file with virtual geomagnetic poles and plots them
Working with MagIC:
- combine_magic.py : combines two MagIC formatted files of same type
- grab_magic_key.py : prints out a single column from a MagIC format file
- magic_select.py : selects data from MagIC format file given conditions (e.g., method_codes contain string)
- download_magic.py : unpacks a contribution text file downloaded from the MagIC website
- upload_magic.py : prepares a directory with a MagIC contribution for uploading to MagIC
- Conversion scripts : convert many laboratory measurement formats to the MagIC data model 3 format
  - _2g_bin_magic.py : converts 2G binary files to MagIC
  - aarm_magic.py : takes a MagIC formated measurements.txt file with anisotropy of ARM data and calculates the tensors and stores in a MagIC formatted specimens.txt file.
  - atrm_magic.py : takes a MagIC formated measurements.txt file with anisotropy of TRM data and calculates the tensors and stores in a MagIC formatted specimens.txt file.
  - agm_magic.py : converts Princeton Measurements alternating gradient force magnetization (AGM) files to MagIC.
  - bgc_magic.py : convert Berkeley Geochronology Center files to MagIC.
  - cit_magic.py : convert Cal Tech format files to MagIC.
  - generic_magic.py : converts generic files to MagIC.
  - huji_magic.py : converts Hebrew University, Jerusalem, Israel files to MagIC.
  - huji_sample_magic.py : converts HUJI files to a MagIC format.
  - jr6_jr6_magic.py : converts the AGICO JR6 spinner .jr6 files to MagIC
  - jr6_txt_magic.py : converts the AGICO JR6 .txt files to MagIC
  - k15_magic.py : converts 15 measurement anisotropy of magnetic susceptibility files to MagIC.
  - ldeo_magic.py : converts Lamont-Doherty files to MagIC.
  - livdb_magic.py : converts Liverpool files to MagIC.
  - mst_magic.py : converts Curie Temperature experimental data to MagIC
  - sio_magic.py : converts Scripps Institution of Oceanography data files to MagIC
  - sufar4_magic.py : converts AGICO SUFAR program (ver.1.2.) ascii files to MagIC
  - tdt_magic.py : converts Thellier Tool files to MagIC
  - utrecht_magic.py : converts Fort Hoofddijk, Utrecht University Robot files to MagIC
  - orientation_magic.py : converts an "orient.txt" formatted file with field notebook information into MagIC formatted files
  - azdip_magic.py : converts an "azdip" formatted file to a samples.txt file format
other handy scripts
- chartmaker.py : script for making chart to guide IZZI lab experiment

PmagPy Command Line Version¶

What is PmagPy?¶

What are paleomagnetism and rock magnetism?¶

Get started¶

Help¶

Guide to PmagPy¶

_2g_bin_magic.py¶

aarm_magic.py¶

agm_magic.py¶

angle.py¶

ani_depthplot.py¶

aniso_magic.py¶

apwp.py¶

atrm_magic.py¶

azdip_magic.py¶

bgc_magic.py¶

b_vdm.py¶

bootams.py¶

cart_dir.py¶

chartmaker.py¶

chi_magic.py¶

cit_magic.py¶

combine_magic.py¶

common_mean.py¶

cont_rot.py¶

core_depthplot.py¶

curie.py¶

dayplot_magic.py¶

demag_gui.py¶

di_eq.py¶

di_geo.py¶

di_rot.py¶

di_tilt.py¶

di_vgp.py¶

dipole_pinc.py¶

dipole_plat.py¶

dir_cart.py¶

dmag_magic.py¶

download_magic.py¶

eigs_s.py¶

eq_di.py¶

eqarea.py¶

eqarea_ell.py¶

eqarea_magic.py¶

find_ei.py¶

fisher.py¶

fishqq.py¶

fishrot.py¶

foldtest.py¶

foldtest_magic.py¶

forc_diagram.py¶

gaussian.py¶

generic_magic.py¶

gobing.py¶

gofish.py¶

gokent.py¶

goprinc.py¶

grab_magic_key.py¶

histplot.py¶

huji_magic.py¶

huji_sample_magic.py¶

hysteresis_magic.py¶

iodp_dscr_magic.py¶

iodp_jr6_magic.py¶

iodp_srm_magic.py¶

igrf.py¶

install_etopo.py¶

incfish.py¶

irmaq_magic.py¶

jr6_jr6_magic.py¶

jr6_txt_magic.py¶

k15_magic.py¶

kly4s_magic.py¶

ldeo_magic.py¶

livdb_magic.py¶

lnp_magic.py¶

lowes.py¶

lowrie.py¶

lowrie_magic.py¶

magic_select.py¶