First contributions

If you want to contribute to the project there are a number of ways to do it:

If you want to have a go at adding a feature (which would be great) then please fork the repo on github, and create your own feature branch. We are trying to follow the github flow branching model, so you might want to install their command-line tools.

Then when you are done, create a pull request and we can integrate it back so everyone can use it :)


We are trying to migrate to a truly pep8-friendly coding style, to that end I would recommend installing flake8. Our main two developers use the atom text editor along with linter-flake8, although I often use vim as well. Up to you.

We use obspy heavily, so try to follow their style guide, including the standard import conventions for numpy and matplotlib:

import numpy as np
import matplotlib.pyplot as plt

As usual:


As you will have seen from the API, docs are good. We generate the docs using sphinx which can then be compiled either locally, or by readthedocs. In this way, docstrings are including in the source code.