Table of Contents

• Tutorial
  • Introduction to ObsPy
    • Python Introduction for Seismologists
    • UTCDateTime
    • Reading Seismograms
    • Waveform Plotting Tutorial
    • Retrieving Data from Data Centers
    • Filtering Seismograms
    • Downsampling Seismograms
    • Merging Seismograms
    • Beamforming - FK Analysis
    • Seismogram Envelopes
    • Plotting Spectrograms
    • Trigger/Picker Tutorial
    • Poles and Zeros, Frequency Response
    • Seismometer Correction/Simulation
    • Clone an Existing Dataless SEED File
    • Export Seismograms to MATLAB
    • Export Seismograms to ASCII
    • Anything to MiniSEED
    • Beachball Plot
    • Cartopy Plots
    • Interfacing R from Python
    • Coordinate Conversions
    • Hierarchical Clustering
    • Visualizing Probabilistic Power Spectral Densities
    • Array Response Function
    • Continuous Wavelet Transform
    • Time Frequency Misfit
    • Visualize Data Availability of Local Waveform Archive
    • Travel Time and Ray Path Plotting
    • Cross-Correlation Pick Correction
    • Cross-Correlation Detector
    • Handling custom defined tags in QuakeML and the ObsPy Catalog/Event framework
    • Handling custom defined tags in StationXML with the Obspy Inventory
    • Creating a StationXML file from Scratch
    • Connecting to a SeedLink Server
  • Advanced Exercise
    • Advanced Exercise
• Gallery
  • Colormap comparison
• API Overview
  • obspy.core - Core classes of ObsPy
    • Waveform Data
    • Event Metadata
    • Station Metadata
  • Classes & Functions
    • obspy.core.stream.read
    • obspy.core.stream.Stream
    • obspy.core.trace.Trace
    • obspy.core.trace.Stats
    • obspy.core.utcdatetime.UTCDateTime
    • obspy.core.event.read_events
    • obspy.core.event.Catalog
    • obspy.core.event.Event
    • obspy.core.inventory.inventory.read_inventory
    • obspy.core.inventory.inventory.Inventory
  • Modules
    • obspy.core.trace
    • obspy.core.stream
    • obspy.core.utcdatetime
    • obspy.core.event
    • obspy.core.inventory
    • obspy.core.util
    • obspy.core.preview
  • obspy.geodetics - Various geodetic utilities for ObsPy
  • Classes & Functions
    • obspy.geodetics.base.calc_vincenty_inverse
    • obspy.geodetics.base.degrees2kilometers
    • obspy.geodetics.base.gps2dist_azimuth
    • obspy.geodetics.base.inside_geobounds
    • obspy.geodetics.base.kilometers2degrees
    • obspy.geodetics.base.locations2degrees
    • obspy.geodetics.flinnengdahl.FlinnEngdahl
  • Modules
    • obspy.geodetics.base
    • obspy.geodetics.flinnengdahl
  • obspy.imaging - Plotting routines for ObsPy
    • Seismograms
    • Spectrograms
    • Beachballs
    • Saving plots into files
  • Classes & Functions
    • obspy.imaging.scripts.scan.Scanner
    • obspy.imaging.scripts.scan.scan
    • obspy.imaging.cm.pqlx
  • Modules
    • obspy.imaging.beachball
    • obspy.imaging.cm
    • obspy.imaging.maps
    • obspy.imaging.mopad_wrapper
    • obspy.imaging.source
    • obspy.imaging.spectrogram
    • obspy.imaging.util
    • obspy.imaging.waveform
  • Scripts
    • obspy.imaging.scripts.scan
    • obspy.imaging.scripts.plot
    • obspy.imaging.scripts.mopad
  • obspy.realtime - Real time support for ObsPy
  • Modules
    • obspy.realtime.rttrace
    • obspy.realtime.rtmemory
    • obspy.realtime.signal
  • obspy.signal - Signal processing routines for ObsPy
    • Filter
    • Instrument Correction
    • Trigger
  • Classes & Functions
    • obspy.signal.array_analysis.array_processing
    • obspy.signal.array_analysis.array_rotation_strain
    • obspy.signal.trigger.ar_pick
    • obspy.signal.filter.bandpass
    • obspy.signal.filter.bandstop
    • obspy.signal.trigger.carl_sta_trig
    • obspy.signal.trigger.classic_sta_lta
    • obspy.signal.trigger.coincidence_trigger
    • obspy.signal.invsim.corn_freq_2_paz
    • obspy.signal.invsim.cosine_taper
    • obspy.signal.trigger.delayed_sta_lta
    • obspy.signal.filter.envelope
    • obspy.signal.interpolation.interpolate_1d
    • obspy.signal.interpolation.weighted_average_slopes
    • obspy.signal.invsim.estimate_magnitude
    • obspy.signal.invsim.evalresp
    • obspy.signal.filter.highpass
    • obspy.signal.filter.lowpass
    • obspy.signal.invsim.paz_to_freq_resp
    • obspy.signal.trigger.pk_baer
    • obspy.signal.polarization.polarization_analysis
    • obspy.signal.regression.linear_regression
    • obspy.signal.spectral_estimation.PPSD
    • obspy.signal.quality_control.MSEEDMetadata
    • obspy.signal.trigger.recursive_sta_lta
    • obspy.signal.rotate.rotate_ne_rt
    • obspy.signal.invsim.simulate_seismometer
    • obspy.signal.util.util_geo_km
    • obspy.signal.util.util_lon_lat
    • obspy.signal.cross_correlation.correlate
    • obspy.signal.trigger.z_detect
  • Modules
    • obspy.signal.array_analysis
    • obspy.signal.calibration
    • obspy.signal.cpxtrace
    • obspy.signal.cross_correlation
    • obspy.signal.detrend
    • obspy.signal.differentiate_and_integrate
    • obspy.signal.filter
    • obspy.signal.freqattributes
    • obspy.signal.hoctavbands
    • obspy.signal.interpolation
    • obspy.signal.invsim
    • obspy.signal.konnoohmachismoothing
    • obspy.signal.polarization
    • obspy.signal.quality_control
    • obspy.signal.regression
    • obspy.signal.rotate
    • obspy.signal.spectral_estimation
    • obspy.signal.tf_misfit
    • obspy.signal.trigger
    • obspy.signal.util
  • obspy.taup - Ray theoretical travel times and paths
    • Basic Usage
    • Plotting
    • Phase naming in obspy.taup
    • Building custom models
  • Classes & Functions
    • obspy.taup.tau.TauPyModel
    • obspy.taup.velocity_layer.VelocityLayer
    • obspy.taup.helper_classes.SlownessLayer
    • obspy.taup.helper_classes.TimeDist
    • obspy.taup.helper_classes.TimeDistGeo
    • obspy.taup.helper_classes.CriticalDepth
  • Modules
    • obspy.taup.c_wrappers
    • obspy.taup.helper_classes
    • obspy.taup.ray_paths
    • obspy.taup.seismic_phase
    • obspy.taup.slowness_layer
    • obspy.taup.slowness_model
    • obspy.taup.tau_branch
    • obspy.taup.tau_model
    • obspy.taup.taup_create
    • obspy.taup.taup_geo
    • obspy.taup.taup_path
    • obspy.taup.taup_pierce
    • obspy.taup.taup_time
    • obspy.taup.tau
    • obspy.taup.utils
    • obspy.taup.velocity_layer
    • obspy.taup.velocity_model
  • obspy.scripts.flinnengdahl
  • obspy.scripts.runtests
  • obspy.scripts.reftekrescue
  • obspy.scripts.print
  • obspy.scripts.sds_html_report
    • Example
  • 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.earthworm - Earthworm Wave Server client for ObsPy.
    • Basic Usage
  • Classes & Functions
    • obspy.clients.earthworm.client.Client
  • Modules
    • obspy.clients.earthworm.client
  • obspy.clients.fdsn - FDSN web service client for ObsPy
    • Basic FDSN Client Usage
    • Basic Routing Clients Usage
  • Classes & Functions
    • obspy.clients.fdsn.client.Client
    • obspy.clients.fdsn.routing.routing_client.RoutingClient
    • obspy.clients.fdsn.mass_downloader.download_helpers._SlotsEqualityComparisionObject
  • Modules
    • obspy.clients.fdsn.client
    • obspy.clients.fdsn.routing
    • obspy.clients.fdsn.routing.routing_client
    • obspy.clients.fdsn.routing.routing_client.BaseRoutingClient
    • obspy.clients.fdsn.routing.eidaws_routing_client
    • obspy.clients.fdsn.routing.eidaws_routing_client.EIDAWSRoutingClient
    • obspy.clients.fdsn.routing.federator_routing_client
    • obspy.clients.fdsn.routing.federator_routing_client.FederatorRoutingClient
    • obspy.clients.fdsn.mass_downloader
    • obspy.clients.fdsn.mass_downloader.domain
    • obspy.clients.fdsn.mass_downloader.mass_downloader.MassDownloader
    • obspy.clients.fdsn.mass_downloader.restrictions
    • obspy.clients.fdsn.mass_downloader.download_helpers
  • obspy.clients.filesystem - Local filesystem (SDS or TSINDEX) client for ObsPy
  • Classes & Functions
    • obspy.clients.filesystem.sds.Client
    • obspy.clients.filesystem.tsindex.Client
    • obspy.clients.filesystem.tsindex.Indexer
    • obspy.clients.filesystem.tsindex.TSIndexDatabaseHandler
  • Modules
    • obspy.clients.filesystem.sds
    • obspy.clients.filesystem.tsindex
  • obspy.clients.iris - IRIS web service client for ObsPy
    • Local Alternatives
    • Web service Interfaces
  • Classes & Functions
    • obspy.clients.iris.client.Client
  • Modules
    • obspy.clients.iris.client
  • obspy.clients.neic - CWB query module for ObsPy
  • Classes & Functions
    • obspy.clients.neic.client.Client
  • Modules
    • obspy.clients.neic.client
  • obspy.clients.nrl - Nominal Response Library client for ObsPy
    • Basic Usage
  • Classes & Functions
    • obspy.clients.nrl.client.NRL
  • Modules
    • obspy.clients.nrl.client
  • Scripts
  • obspy.clients.seedlink - SeedLink client for ObsPy
  • Classes & Functions
    • obspy.clients.seedlink.basic_client.Client
    • obspy.clients.seedlink.easyseedlink.EasySeedLinkClient
    • obspy.clients.seedlink.slclient.SLClient
    • obspy.clients.seedlink.slpacket.SLPacket
    • obspy.clients.seedlink.client.slnetstation.SLNetStation
    • obspy.clients.seedlink.client.seedlinkconnection.SeedLinkConnection
    • obspy.clients.seedlink.client.slstate.SLState
  • Modules
    • obspy.clients.seedlink.basic_client
    • obspy.clients.seedlink.easyseedlink
    • obspy.clients.seedlink.slclient
    • obspy.clients.seedlink.slpacket
    • obspy.clients.seedlink.seedlinkexception
    • obspy.clients.seedlink.client.seedlinkconnection
    • obspy.clients.seedlink.client.slnetstation
    • obspy.clients.seedlink.client.slstate
  • obspy.clients.syngine - IRIS Syngine client for ObsPy
    • Basic Usage
    • Bulk Requests
    • Other Useful Methods
  • Classes & Functions
    • obspy.clients.syngine.client.Client
  • Modules
    • obspy.clients.syngine.client
  • obspy.io.ah - AH (Ad Hoc) read support for ObsPy
  • Modules
    • obspy.io.ah.core
  • obspy.io.alsep - Apollo seismic data support for ObsPy
    • Reading
  • Modules
    • obspy.io.alsep.assign
    • obspy.io.alsep.core
    • obspy.io.alsep.define
  • obspy.io.ascii - SLIST and TSPAIR support for ObsPy
  • Modules
    • obspy.io.ascii.core
  • obspy.io.css - CSS read support for ObsPy
  • Modules
    • obspy.io.css.core
    • obspy.io.css.station
  • obspy.io.dmc - INGV DMX file format reader for ObsPy
    • Reading the waveforms
  • Modules
    • obspy.io.dmx.core
  • obspy.io.gcf - Guralp Compressed Format, GCF, read and write support for ObsPy
    • Reading
    • Writing
    • Utilities
  • Modules
    • obspy.io.gcf.core
  • obspy.io.gse2 - GSE2/GSE1 and GSE2 bulletin support for ObsPy
    • Reading waveform data
    • Writing waveform data
    • Reading bulletin
  • Modules
    • obspy.io.gse2.bulletin
    • obspy.io.gse2.core
    • obspy.io.gse2.libgse2
    • obspy.io.gse2.libgse1
    • obspy.io.gse2.paz
  • obspy.io.kinemetrics - Evt format support for ObsPy
    • Reading
    • Writing
  • Modules
    • obspy.io.kinemetrics.core
  • obspy.io.mseed - MiniSEED read and write support for ObsPy
    • Reading
    • Writing
    • Encoding Support
    • Utilities
  • Modules
    • obspy.io.mseed.core
    • obspy.io.mseed.util
  • Scripts
    • obspy.io.mseed.scripts.recordanalyzer
  • obspy.io.nied.knet - K-NET/KiK-net read support for ObsPy
  • obspy.io.pdas - PDAS file read support for ObsPy
  • Modules
    • obspy.io.pdas.core
  • obspy.io.reftek - REFTEK130 read support for ObsPy
    • Reading
  • Modules
    • obspy.io.reftek.core
    • obspy.io.reftek.util
    • obspy.io.reftek.packet
  • obspy.io.rg16 - Receiver Gather v1.6 read support for ObsPy
    • Instrument Orientation
    • Reading the waveforms
  • Modules
    • obspy.io.rg16.core
    • obspy.io.rg16.util
  • obspy.io.sac - SAC read and write support for ObsPy
    • Reading
    • Writing
  • Modules
    • obspy.io.sac.core
    • obspy.io.sac.sacpz
    • obspy.io.sac.header
    • obspy.io.sac.arrayio
    • obspy.io.sac.sactrace
    • obspy.io.sac.util
  • obspy.io.seisan - SEISAN read support for ObsPy
    • Reading
  • Modules
    • obspy.io.seisan.core
  • obspy.io.seg2 - SEG-2 read support for ObsPy
  • Modules
    • obspy.io.seg2.seg2
  • obspy.io.segy - SEG Y and SU read and write support for ObsPy
    • Reading
    • Writing
  • Classes & Functions
    • obspy.io.segy.header.TRACE_HEADER_FORMAT
  • Modules
    • obspy.io.segy.core
    • obspy.io.segy.segy
    • obspy.io.segy.util
    • obspy.io.segy.header
    • obspy.io.segy.pack
    • obspy.io.segy.unpack
  • obspy.io.sh - Q and ASC read and write, EVT read support (Seismic Handler)
    • Reading
    • Writing
  • Modules
    • obspy.io.sh.core
    • obspy.io.sh.evt
  • obspy.io.wav - WAV (audio) read and write support for ObsPy
    • Reading
    • Writing
  • Modules
    • obspy.io.wav.core
  • obspy.io.win - WIN read support for ObsPy
  • Modules
    • obspy.io.win.core
  • obspy.io.y - Nanometrics Y file read support for ObsPy
  • Modules
    • obspy.io.y.core
  • obspy.io.cmtsolution - CMTSOLUTION file format support for ObsPy
    • Example
  • Modules
    • obspy.io.cmtsolution.core
  • obspy.io.cnv - CNV file format support for ObsPy
  • Modules
    • obspy.io.cnv.core
  • obspy.io.focmec - FOCMEC file format support for ObsPy
  • Modules
    • obspy.io.focmec.core
  • obspy.io.gse2 - GSE2/GSE1 and GSE2 bulletin support for ObsPy
    • Reading waveform data
    • Writing waveform data
    • Reading bulletin
  • Modules
    • obspy.io.gse2.bulletin
    • obspy.io.gse2.core
    • obspy.io.gse2.libgse2
    • obspy.io.gse2.libgse1
    • obspy.io.gse2.paz
  • obspy.io.hypodd - HypoDD read support for ObsPy
    • Usage Example
  • Modules
    • obspy.io.hypodd.pha
  • obspy.io.iaspei - Read support for IASPEI formats
  • Modules
    • obspy.io.iaspei.core
  • obspy.io.json - JSON write support for ObsPy
  • Classes & Functions
    • obspy.io.json.core.get_dump_kwargs
    • obspy.io.json.core._write_json
    • obspy.io.json.default.Default
  • Modules
    • obspy.io.json.core
    • obspy.io.json.default
  • obspy.io.kml - Keyhole Markup Language (KML) write support for ObsPy
  • Modules
    • obspy.io.kml.core
  • obspy.io.ndk - NDK file support for ObsPy
    • Acquiring NDK Files
    • Basic Usage
  • Modules
    • obspy.io.ndk.core
  • obspy.io.nied.fnet - F-net moment tensor file read support for ObsPy
  • obspy.io.nied.knet - K-NET/KiK-net read support for ObsPy
  • obspy.io.nlloc - NonLinLoc file format support for ObsPy
    • Example
  • Modules
    • obspy.io.nlloc.core
    • obspy.io.nlloc.util
  • obspy.io.nordic - Nordic file format support for ObsPy
  • Modules
    • obspy.io.nordic.core
  • obspy.io.pde - NEIC PDE Bulletin read support for ObsPy
  • Modules
    • obspy.io.pde.mchedr
  • obspy.io.quakeml - QuakeML read and write support for ObsPy
  • obspy.io.quakeml.core._is_quakeml
    • _is_quakeml()
  • obspy.io.quakeml.core._read_quakeml
    • _read_quakeml()
  • obspy.io.quakeml.core._read_seishub_event_xml
    • _read_seishub_event_xml()
  • obspy.io.quakeml.core._write_quakeml
    • _write_quakeml()
  • obspy.io.quakeml.core.Pickler
    • Pickler
    • obspy.io.quakeml.core.Pickler.dump
    • obspy.io.quakeml.core.Pickler.dumps
  • obspy.io.quakeml.core.Unpickler
    • Unpickler
    • obspy.io.quakeml.core.Unpickler.xml_root
    • obspy.io.quakeml.core.Unpickler.load
    • obspy.io.quakeml.core.Unpickler.loads
  • obspy.io.scardec - SCARDEC file format support for ObsPy
    • Example
  • Modules
    • obspy.io.scardec.core
  • obspy.io.seiscomp - SeisComP XML inventory and event file support for ObsPy
  • Modules
    • obspy.io.seiscomp.core
    • obspy.io.seiscomp.event
    • obspy.io.seiscomp.inventory
  • obspy.io.shapefile - ESRI shapefile write support for ObsPy
  • Modules
    • obspy.io.shapefile.core
  • obspy.io.zmap - ZMAP read and write support for ObsPy
    • Usage Example
    • Reading ZMAP
    • Writing ZMAP
    • The ZMAP Format
  • Modules
    • obspy.io.zmap.core
  • obspy.io.css - CSS read support for ObsPy
  • Modules
    • obspy.io.css.core
    • obspy.io.css.station
  • obspy.io.kml - Keyhole Markup Language (KML) write support for ObsPy
  • Modules
    • obspy.io.kml.core
  • obspy.io.sac.sacpz - SACPZ write support for ObsPy
  • obspy.io.seiscomp - SeisComP XML inventory and event file support for ObsPy
  • Modules
    • obspy.io.seiscomp.core
    • obspy.io.seiscomp.event
    • obspy.io.seiscomp.inventory
  • obspy.io.shapefile - ESRI shapefile write support for ObsPy
  • Modules
    • obspy.io.shapefile.core
  • obspy.io.stationtxt - FDSNWS station text file read and write support for ObsPy
    • Example
  • Modules
    • obspy.io.stationtxt.core
  • obspy.io.stationxml - StationXML read and write support for ObsPy
  • Modules
    • obspy.io.stationxml.core
  • obspy.io.xseed - (X)SEED and RESP support for ObsPy
    • Allocate a Parser object and read/write
    • The Parser Object
  • Classes & Functions
    • obspy.io.xseed.parser.Parser
  • Modules
    • obspy.io.xseed.core
    • obspy.io.xseed.fields
    • obspy.io.xseed.parser
    • obspy.io.xseed.utils
  • Scripts
    • obspy.io.xseed.scripts.dataless2resp
    • obspy.io.xseed.scripts.dataless2xseed
    • obspy.io.xseed.scripts.xseed2dataless
• Changelog
  • 1.4.0 (doi: 10.5281/zenodo.6645832)
  • 1.3.1 (doi: 10.5281/zenodo.7193374)
  • 1.3.0 (doi: 10.5281/zenodo.6327346)
  • 1.2.2 (doi: 10.5281/zenodo.3921997)
  • 1.2.1 (doi: 10.5281/zenodo.3706479)
  • 1.2.0 (doi: 10.5281/zenodo.3674646)
• Citations
• Coding Style Guide
  • Pre-Commit Hooks
  • Import Conventions
  • Naming
  • Doc Strings / Comments
  • Function/Method Definitions
    • format_exception()
  • Reference Conventions
  • Tests
  • Citations
  • Miscellaneous
• Contributing to ObsPy
  • Getting Started
  • Submitting a Pull Request
  • Submitting an Issue
  • Additional Resources
• Contributor Covenant Code of Conduct
  • Our Pledge
  • Our Standards
  • Our Responsibilities
  • Scope
  • Enforcement
  • Attribution
• Contributors
  • Hall of Fame
  • Funds
  • Quotes