Detailed installation instructions

Pyrocko can be installed on every operating system where its prerequisites are available. This document describes how to install Pyrocko on Unix-like operating systems, like Linux and Mac OS X.

Explicit listings of the commands needed to install Pyrocko are given in section

• System specific installation instructions

Prerequisites

The following software packages must be installed before Pyrocko can be installed from source:

• Try to use normal system packages for these Python modules:

  • Python (== 2.7 or >= 3.4, with development headers)
  • NumPy (>= 1.6, with development headers)
  • SciPy
  • matplotlib (with Qt4 or Qt5 backend)
  • pyyaml
  • PyQt4 or PyQt5 (only needed for the GUI apps)
  • future (Python2/3 compatibility layer)
  • requests

• Optional Python modules:

  • progressbar2
  • Jinja2 (required for the fomosto report subcommand)
  • nosetests (to run the unittests)
  • coverage (unittest coverage report)

• Manually install these optional software tools:

  • GMT (4 or 5, only required for the pyrocko.plot.automap module)
  • slinktool (optionally, if you want to use the pyrocko.streaming.slink module)
  • rdseed (optionally, if you want to use the pyrocko.io.rdseed module)
  • QSEIS (optional, needed for the Fomosto qseis.2006a backend)
  • QSSP (optional, needed for the Fomosto qssp.2010 backend)
  • PSGRN/PSCMP (optional, needed for the Fomosto psgrn.pscmp backend)

Download and install Pyrocko

Use git to download the software package and the included script setup.py to install:

cd ~/src/   # or wherever you keep your source packages
git clone https://git.pyrocko.org/pyrocko/pyrocko.git pyrocko
cd pyrocko
sudo python setup.py install

Note: If you have previously installed Pyrocko using other tools like e.g. easy_install or pip, you should manually remove the old installation - otherwise you will end up with two parallel installations of Pyrocko which will cause trouble.

Updating

If you later would like to update Pyrocko, run the following commands (this assumes that you have used git to download Pyrocko):

cd ~/src/pyrocko   # assuming the Pyrocko source package is here
git pull origin master
sudo python setup.py install