Contents

1 Windows pip install

These are the install instructions for Windows/pip. If this isn’t your operating system, or you want a developer install, go back to the Cookbook and select the correct link.

1.1 Install Python

First, you will need to download a scientific Python distribution. We strongly recommend Anaconda.

• Download and install Anaconda Python 3. Select an install for Just Me, not for all users. You should select “Add Anaconda to my PATH environment variable” in Advanced Installation Options (if available). Otherwise, stick with the defaults.
• Open your command line (Command Prompt). See this Cookbook section for more information on finding Command Prompt)
• Note: if you did not add Anaconda Python to your PATH as recommended above, you will open the “Anaconda Prompt” instead).
• Download a few non-default Python packages. Run the following commands:
   
      conda install future wxPython cartopy pandas  
      conda install matplotlib=2.2.3  
      pip install --upgrade pip setuptools

• When running these commands you may see some warnings about dependencies, but you can just ignore them!

1.2 Test your python

To make sure that you have installed Python successfully, type python on your command line. You should see something like this:

(Type “quit()” and then hit enter to end your python session)

1.3 Install PmagPy

• Install pmagpy and pmagpy-cli:
   
    pip install --upgrade pmagpy --no-deps  
    pip install --upgrade pmagpy-cli --no-deps

• If you are getting weird install errors, try uninstalling and then force reinstalling with this:
   
    pip uninstall pmagpy pmagpy-cli  
    pip install pmagpy --upgrade --no-deps --force-reinstall --no-cache-dir  
    pip install pmagpy-cli --upgrade --no-deps --force-reinstall --no-cache-dir

1.4 Test PmagPy

Test core functionality:

• On your command line, type “python” to start the interpreter. You will import pmagpy and then run a simple calculation. Importing pmagpy may take over a minute the first time, so be patient! It will be much faster in subsequent runs.
  >>> from pmagpy import pmag  
  >>> pmag.angle([350.0,10.0],[320.0,20.0])  
  array([30.59060998])  
  >>>

Test the GUIs:

• On the command line, open Pmag GUI by running:
  pmag_gui

If any of these commands don’t work, go back and carefully follow the install instructions. If you still have a problem, try the Troubleshooting section. If you don’t find an answer there, check out the existing Github issues and create a new one if necessary.

1.5 Finishing up

Accessing example data files:

There are many data files used in the examples of programs and for use with the textbook Essentials of Paleomagnetism. You may want to copy the data files to your Desktop or another convenient location. To do this, navigate on the command line to your desired destination folder (for help, see this Cookbook section). Then, use the command:

This will copy all of the PmagPy example files to your current directory. NB: If you have a developer install, you can simply navigate to PmagPy/data_files, and move_data_files will not be needed.

1.6 Keeping PmagPy up-to-date

To stay up to date with new features and bug fixes, you should periodically update both PmagPy packages.

To check the currently installed version number for pmagpy (or any other Python package), run:

If you ever need to uninstall pmagpy or pmagpy-cli:

or

2 Next steps

Back to the Cookbook!