# ObsPy Documentation Contents

- ObsPy Tutorial
  - Introduction to ObsPy
    - 1. Python Introduction for Seismologists
    - 2. UTCDateTime
    - 3. Reading Seismograms
    - 4. Waveform Plotting Tutorial
    - 5. Retrieving Data from Data Centers
    - 6. Filtering Seismograms
    - 7. Downsampling Seismograms
    - 8. Merging Seismograms
    - 9. Beamforming - FK Analysis
    - 10. Seismogram Envelopes
    - 11. Plotting Spectrograms
    - 12. Trigger/Picker Tutorial
    - 13. Poles and Zeros, Frequency Response
    - 14. Seismometer Correction/Simulation
    - 15. Clone an Existing Dataless SEED File
    - 16. Export Seismograms to MATLAB
    - 17. Export Seismograms to ASCII
    - 18. Anything to MiniSEED
    - 19. Beachball Plot
    - 20. Basemap Plots
    - 21. Interfacing R from Python
    - 22. Coordinate Conversions
    - 23. Hierarchical Clustering
    - 24. Visualizing Probabilistic Power Spectral Densities
    - 25. Array Response Function
    - 26. Continuous Wavelet Transform
    - 27. Time Frequency Misfit
    - 28. Visualize Data Availability of Local Waveform Archive
    - 29. Travel Time and Ray Path Plotting
    - 30. Cross Correlation Pick Correction
    - 31. Handling custom defined tags in QuakeML and the ObsPy Catalog/Event framework
    - 32. Handling custom defined tags in StationXML with the Obspy Inventory
    - 33. Creating a StationXML file from Scratch
    - 34. Connecting to a SeedLink Server
  - Advanced Exercise
    - Advanced Exercise
- ObsPy Library Reference
  - obspy.core - Core classes of ObsPy
    - Waveform Data
    - Event Metadata
    - Station Metadata
    - Classes & Functions
    - Modules
  - obspy.db - A seismic waveform indexer and database for ObsPy
    - Modules
    - Scripts
  - obspy.geodetics - Various geodetic utilities for ObsPy
    - Classes & Functions
    - Modules
  - obspy.imaging - Plotting routines for ObsPy
    - Seismograms
    - Spectrograms
    - Beachballs
    - Saving plots into files
    - Classes & Functions
    - Modules
    - Scripts
  - obspy.realtime - Real time support for ObsPy
    - Modules
  - obspy.signal - Signal processing routines for ObsPy
    - Filter
    - Instrument Correction
    - Trigger
    - Classes & Functions
    - Modules
  - obspy.taup - Ray theoretical travel times and paths
    - Basic Usage
    - Plotting
    - Phase naming in obspy.taup
    - Building custom models
    - Classes & Functions
    - Modules
  - obspy.scripts.flinnengdahl
  - obspy.scripts.runtests
  - obspy.scripts.reftekrescue
  - obspy.scripts.print
  - obspy.scripts.sds_html_report
    - Example
  - obspy.db.scripts.indexer
  - obspy.imaging.scripts.scan
  - obspy.imaging.scripts.plot
  - obspy.imaging.scripts.mopad
  - obspy.io.mseed.scripts.recordanalyzer
  - obspy.io.xseed.scripts.dataless2xseed
  - obspy.io.xseed.scripts.xseed2dataless
  - obspy.io.xseed.scripts.dataless2resp
  - obspy.clients.arclink - ArcLink/WebDC request client for ObsPy
    - Basic Usage
    - Further Resources
    - Classes & Functions
    - Modules
  - obspy.clients.earthworm - Earthworm Wave Server client for ObsPy.
    - Basic Usage
    - Classes & Functions
    - Modules
  - obspy.clients.fdsn - FDSN web service client for ObsPy
    - Basic FDSN Client Usage
    - Basic Routing Clients Usage
    - Classes & Functions
    - Modules
  - obspy.clients.filesystem - Local filesystem (e.g. SDS) client for ObsPy
    - Classes & Functions
    - Modules
  - obspy.clients.iris - IRIS web service client for ObsPy
    - Local Alternatives
    - Web service Interfaces
    - Classes & Functions
    - Modules
  - obspy.clients.neic - CWB query module for ObsPy
    - Classes & Functions
    - Modules
  - obspy.clients.nrl - Nominal Response Library client for ObsPy
    - Basic Usage
    - Classes & Functions
    - Modules
    - Scripts
  - obspy.clients.seedlink - SeedLink client for ObsPy
    - Classes & Functions
    - Modules
  - obspy.clients.seishub - SeisHub database client for ObsPy
    - Basic Example
    - Advanced Examples
    - Classes & Functions
    - Modules
  - obspy.clients.syngine - IRIS Syngine client for ObsPy
    - Basic Usage
    - Bulk Requests
    - Other Useful Methods
    - Classes & Functions
    - Modules
  - obspy.io.cmtsolution - CMTSOLUTION file format support for ObsPy
    - Example
    - Modules
  - obspy.io.cnv - CNV file format support for ObsPy
    - Modules
  - obspy.io.iaspei - Read support for IASPEI formats
    - Modules
  - obspy.io.gse2 - GSE2/GSE1 and GSE2 bulletin support for ObsPy
    - Reading waveform data
    - Writing waveform data
    - Reading bulletin
    - Modules
  - obspy.io.json - JSON write support for ObsPy
    - Classes & Functions
    - Modules
  - obspy.io.kml - Keyhole Markup Language (KML) write support for ObsPy
    - Modules
  - obspy.io.ndk - NDK file support for ObsPy
    - Acquiring NDK Files
    - Basic Usage
    - Modules
  - obspy.io.nied.fnetmt
    - obspy.io.nied.fnet - F-net moment tensor file read support for ObsPy
  - obspy.io.nlloc - NonLinLoc file format support for ObsPy
    - Example
    - Modules
  - obspy.io.nordic - Nordic file format support for ObsPy
    - Modules
  - obspy.io.pde - NEIC PDE Bulletin read support for ObsPy
    - Modules
  - obspy.io.seiscomp - SeisComP3 inventory and event file support for ObsPy
    - Modules
  - obspy.io.scardec - SCARDEC file format support for ObsPy
    - Example
    - Modules
  - obspy.io.shapefile - ESRI shapefile write support for ObsPy
    - Modules
  - obspy.io.quakeml
    - obspy.io.quakeml - QuakeML read and write support for ObsPy
  - obspy.io.zmap - ZMAP read and write support for ObsPy
    - Usage Example
    - Reading ZMAP
    - Writing ZMAP
    - The ZMAP Format
    - Modules
  - obspy.io.arclink - Arclink inventory files read support for ObsPy
    - Modules
  - obspy.io.css - CSS read support for ObsPy
    - Modules
  - obspy.io.kml - Keyhole Markup Language (KML) write support for ObsPy
    - Modules
  - obspy.io.sac.sacpz
    - obspy.io.sac.sacpz - SACPZ write support for ObsPy
  - obspy.io.seiscomp - SeisComP3 inventory and event file support for ObsPy
    - Modules
  - obspy.io.shapefile - ESRI shapefile write support for ObsPy
    - Modules
  - obspy.io.stationtxt - FDSNWS station text file read and write support for ObsPy
    - Example
    - Modules
  - obspy.io.stationxml - StationXML read and write support for ObsPy
    - Modules
  - obspy.io.xseed - (X)SEED and RESP support for ObsPy
    - Allocate a Parser object and read/write
    - The Parser Object
    - Classes & Functions
    - Modules
    - Scripts
- ChangeLog
- Contributors
- ObsPy Coding Style Guide
  - Import Conventions
  - Naming
  - Doc Strings / Comments
  - Function/Method Definitions
  - Reference Conventions
  - Tests
  - Citations
  - Miscellaneous
- Gallery
  - Colormap comparison
- Citations

# Indices and tables

- Index
- Module Index
- Search Page

### Thank you!

We would like to thank our contributors, whose efforts make this software what it is. These people have helped by writing code and documentation, and by testing. They have created and maintained this product, its associated libraries and applications, our build tools and our web sites.

#### Contributors

- Ackerley, Nick
- Allgeyer, Sebastien
- Ammon, Charles J.
- Antunes, Emanuel
- Arnarsson, Ólafur St.
- Bank, Markus
- Barsch, Robert
- Behr, Yannik
- Bernardi, Fabrizio
- Bernauer, Felix
- Bes de Berc, Maxime
- Beyreuther, Moritz
- Boltz, Shawn
- Bonaimé, Sébastien
- Carothers, Lloyd
- Chamberlain, Calum
- Chambers, Derrick
- Chen, Zhao
- Clark, Adam
- Danecek, Peter
- Egdorf, Sven
- Engels, Fabian
- Ermert, Laura
- Eulenfeld, Tom

- Fabbri, Tommaso
- Falco, Nicholas
- Fee, Jeremy
- Grellier, Clément
- Grunberg, Marc
- Hammer, Conny
- Heimann, Sebastian
- Heiniger, Lukas
- Hope, Gaute
- Igel, Heiner
- Inza, Adolfo
- Isken, Marius
- Ketchum, David
- Koymans, Mathijs
- Kremers, Simon
- Kress, Victor
- Krieger, Lars
- Krischer, Lion
- Kula, Damian
- Käufl, Paul
- Köhler, Andreas
- Lecocq, Thomas
- Leeman, John
- Legovini, Paride

- Lesage, Philippe
- Li, Yulin
- Lomax, Anthony
- Lopes, Rui L.
- MacCarthy, Jonathan
- Maggi, Alessia
- Martin, Henri
- Medlin, Andrew
- Megies, Tobias
- Meschede, Matthias
- Michelini, Alberto
- Miller, Nathaniel C.
- Morgenstern, Bernhard
- Nof, Ran Novitsky
- Panning, Mark P.
- Parker, Tom
- Pestourie, Romain
- Rapagnani, Giovanni
- Reyes, Celso
- Ringler, Adam
- Rothenhäusler, Nicolas
- Russo, Emiliano
- Sales de Andrade, Elliott

- Satriano, Claudio
- Saul, Joachim
- Scheingraber, Chris
- Schneider, Simon
- Sippl, Christian
- Snoke, Arthur
- Stange, Stefan
- Stähler, Simon C.
- Sullivan, Benjamin
- Tian, Dongdong
- Trabant, Chad
- Trani, Luca
- Uieda, Leonardo
- Walker, Andrew
- Walther, Marcus
- Wassermann, Joachim
- Williams, Mark C.
- Winkelman, Andrew
- Zaccarelli, Riccardo
- Zad, Seyed Kasra Hosseini
- Zhu, Lijun
- van Driel, Martin
- van Wijk, Kasper

#### Funds

ObsPy was partially funded by the

- German Science Foundation (DFG) via grant DFG IG 16/9-1
- German Ministry for Education and Research (BMBF), GEOTECHNOLOGIEN grant 03G0646H.
- NERA project (Network of European Research Infrastructures for Earthquake Risk Assessment and Mitigation) under the European Community's Seventh Framework Programme (FP7/2007-2013) grant agreement n° 262330
- Leibniz Institute for Applied Geophysics (LIAG)
- VERCE EU-FP7 project (no. 283543)