Skip to content
Tom Winder edited this page Oct 12, 2021 · 232 revisions

TravisCI Status
AppVeyor Status
Coverage Status
PyPI Version
Supported Python versions
Conda
DOI
Gitter LGPLv3
Announcements Mailing List
Discourse status
Twitter Follow
Liberapay patrons

Clone this wiki locally

ObsPy is an open-source project dedicated to provide a Python framework for processing seismological data. It provides parsers for common file formats, clients to access data centers and seismological signal processing routines which allow the manipulation of seismological time series.

The goal of the ObsPy project is to facilitate rapid application development for seismology.

Contents

Acknowledging

Please support the project by acknowledging the use of it. This helps us keep it alive. If you use ObsPy (directly or as a dependency of another package) for work resulting in an academic publication, we would be grateful if one of the following papers is cited:

You can also cite the used ObsPy version:
DOIs for released ObsPy versions (e.g. for ObsPy 1.2.0: 10.5281/zenodo.3674646)

News

More details on important news/announcement can be found on our discourse forum in the future.

Older News get archived in the News Archive.

[Jul 9 2020] ObsPy discourse has landed!

We started our own self-hosted Discourse server for all discussions around ObsPy: https://discourse.obspy.org/

This replaces our old users mailing list. You can login with existing GitHub, Google or Twitter accounts, or create a new user bound to an email address directly on site.

[Mar 6 2020] Release of ObsPy 1.2.0

This is a major release with a lot of new features, bug fixes, and general improvements and we strongly recommend all users to update. Follow these link to learn more:

Getting Started

The ObsPy Gallery and its related ObsPy Tutorial are maybe the best point to get a first impression of what ObsPy is all about. The tutorial is a collection of short example programs with explanations and program output. For help getting started with Python, have a look at this collection of links to Tutorials.

ObsPy Tutorial notebooks -- and much more on specific seismology topics -- can also be found on Seismo-Live, both as a static preview and as interactively runnable version.

Link to Seismo-Live

from obspy import read
st = read()  # load example seismogram
st.filter(type='highpass', freq=3.0)
st = st.select(component='Z')
st.plot()

Example waveform Plot

Installation

ObsPy is currently running and tested on Linux (32 and 64 bit), Windows (32 bit and/or 64 bit) and Mac OS X.

ObsPy runs on Python 2.7, 3.5, 3.6, 3.7 and 3.8. We highly recommend and only officially support the latest release of each series. We recommend you use the latest version of python 3 if possible.

For individual users we strongly recommend Installation via Anaconda.

System administrators can also install system packages (where available, see below). Detailed information on installing the latest stable version of ObsPy on various operating systems:

If you run into problems when following the above installation instructions, you can ask for help in our discourse: https://discourse.obspy.org/c/installation-issues/5

If you intend on making changes to ObsPy or develop for it, read this:

If you intend on performing parallel processing with Python and Obspy, please read the following:

Stay Informed, Get in Touch!

New: ObsPy Discourse

Since July 2020 we also have a discourse at https://discourse.obspy.org/. You can discuss, get in touch with other ObsPy users and ask for help there. This has replaced the old users mailing list. It has the complete users mailing list archive as a read-only category in it, so you can search through older user discussion on there.

It also has a category for announcements. These will be mirrored on the new read-only mailing list (see below) but on our discourse there is the option to comment/reply to announcements and you have full control over what you get email notifications from our discourse for.

Please keep all conversations in English on our discourse forum, thanks!

Mailing List

If you do not want to use the above option to keep in touch and well informed with announcements, you can also subscribe to the new read-only mailing list on the official python.org mailman server. If you are using ObsPy we strongly recommend you join the discourse or at least the mailing list to stay informed. The mailing list will contain important changes and bug fixes and similar announcements only and thus is very low volume.

Follow us on Twitter

For more frequent news and general information on Python in seismology/science, follow us on twitter!

Twitter Follow

Gitter Chat

You can also get in touch with people in our gitter chat room: https://gitter.im/obspy/obspy

Documentation

Use Cases / Applications Using ObsPy

If you want to showcase and/or discuss your projects built on top of ObsPy, you can now also do so in our Discourse: https://discourse.obspy.org/c/obspy-related-projects/7

Feel free to add your own project to the list.

miscellaneous..

Developer Corner

General information on how to contribute to the project can be found here.