Detailed installation instructions

Pyrocko can be installed under any operating system where its prerequisites are available. This document describes details about its requirements which are needed when a standard install is not possible or conflicts arise.

For standard install instructions, head on over to

• System specific installation instructions

Prerequisites

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

• Build requirements

  • C compiler (tested with gcc, clang and MSVC)

  • patch utility

  • NumPy (>= 1.6, with development headers)

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

  • Python (== 2.7 or >= 3.4, with development headers, Python 2 support will be dropped soon)

  • NumPy (>= 1.6, with development headers)

  • SciPy

  • matplotlib (with Qt4 or Qt5 backend)

  • pyyaml

  • PyQt4 or PyQt5 (only needed for the GUI apps)

  • 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, compile and install Pyrocko from source

The following examples will install Pyrocko system-wide with Python 3 on Linux or MacOS. For Windows source installs, please refer to Installation on Windows: From source.

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
# for single user:
python3 setup.py install --user
# system wide:
sudo python3 setup.py install

Note: If you have previously installed Pyrocko using other tools like e.g. easy_install, pip, or conda, you should first remove the old installation. Otherwise you will end up with two parallel installations 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 --ff-only
# for single user:
python3 setup.py install --user
# system wide:
sudo python3 setup.py install