ObsPy
  •  GitHub
  •  Documentation 
    • Getting Started
    • Installation
    • Tutorial
    • Gallery
    • API Documentation (latest release)
    • General Packages
      • obspy.core
      • obspy.imaging
      • obspy.realtime
      • obspy.signal
      • obspy.station
      • obspy.taup
      • obspy.xseed
    • Waveform Import/Export
      • obspy.css
      • obspy.datamark
      • obspy.gse2
      • obspy.mseed
      • obspy.sac
      • obspy.seisan
      • obspy.seg2
      • obspy.segy
      • obspy.sh
      • obspy.wav
      • obspy.y
    • Database and Web Service Clients
      • obspy.arclink
      • obspy.db
      • obspy.earthworm
      • obspy.fdsn
      • obspy.iris
      • obspy.neic
      • obspy.neries
      • obspy.pde
      • obspy.seedlink
      • obspy.seishub
    • API Documentation (current master)
    • General Packages
      • obspy.core
      • obspy.imaging
      • obspy.realtime
      • obspy.signal
      • obspy.station
      • obspy.taup
      • obspy.xseed
    • Waveform Import/Export
      • obspy.css
      • obspy.datamark
      • obspy.gse2
      • obspy.mseed
      • obspy.sac
      • obspy.seisan
      • obspy.seg2
      • obspy.segy
      • obspy.sh
      • obspy.wav
      • obspy.y
    • Event Data Import/Export
      • obspy.core.quakeml
      • obspy.ndk
      • obspy.pde
    • Database and Web Service Clients
      • obspy.arclink
      • obspy.db
      • obspy.earthworm
      • obspy.fdsn
      • obspy.iris
      • obspy.neic
      • obspy.neries
      • obspy.seedlink
      • obspy.seishub
  •  Mailing Lists 
    • Announcements Mailing List (public)
    •  Subscribe
    •  Archive
    • Users Mailing List (public)
    •  Subscribe
    •  Archives
    •  Post a message
  •  Developer Resources 
    • Gitter
    • How to contribute
    • Coding Style Guide
    • All Releases
    • Code Analysis
    • PEP8
    • Python Coverage
    • C Coverage
    • Coveralls
    • -
    • Continuous Integration
    • Test Reports
    •  Travis CI
    • AppVeyor
index| modules| next| previous
  1. ObsPy Documentation (0.10.1)
  2. ObsPy Library Reference
  3. obspy.arclink - ArcLink/WebDC request client for ObsPy
  4. obspy.arclink.client

obspy.arclink.client.Client¶

class Client(host=u'webdc.eu', port=18002, user=None, password=u'', institution=u'Anonymous', timeout=20, dcid_keys={u'TEST': u'XYZ', u'BIA': u'OfH9ekhi'}, dcid_key_file=None, debug=False, command_delay=0, status_delay=0.5)[source]¶

Bases: future.types.newobject.newobject

The ArcLink/WebDC client.

Parameters:
  • host (str, optional) Host name of the remote ArcLink server (default host is 'webdc.eu').
  • port (int, optional) Port of the remote ArcLink server (default port is 18002).
  • timeout (int, optional) Seconds before a connection timeout is raised (default is 20 seconds).
  • user (str) The user name is used for identification with the ArcLink server. This entry is also used for usage statistics within the data centers, so please provide a meaningful user id such as your email address.
  • password (str, optional) A password used for authentication with the ArcLink server (default is an empty string).
  • institution (str, optional) A string containing the name of the institution of the requesting person (default is an 'Anonymous').
  • dcid_keys (dict, optional) Dictionary of data center ids (DCID) and passwords used for decoding encrypted waveform requests.
  • dcid_key_file (str, optional) Simple text configuration file containing lines of data center ids (DCIDs) and password pairs separated by a equal sign, e.g. for DCID BIA and password OfH9ekhi use "BIA=OfH9ekhi". If not set, passwords found in a file called $HOME/dcidpasswords.txt will be used automatically.
  • debug (bool, optional) Enables verbose output of the connection handling (default is False).
  • command_delay (float, optional) Delay between each command send to the ArcLink server (default is 0).
  • status_delay (float, optional) Delay in seconds between each status request (default is 0.5 seconds).

Notes

The following ArcLink servers may be accessed (also see http://www.orfeus-eu.org/eida/eida_advanced_users.html; maybe partly restricted access only):

  • WebDC: webdc.eu:18001, webdc.eu:18002
  • ODC: eida.knmi.nl:18002
  • GFZ: eida.gfz-potsdam.de:18001
  • RESIF: eida.resif.fr:18001
  • INGV:
  • ETHZ: eida.ethz.ch:18001
  • BGR: eida.bgr.de:18001
  • IPGP: eida.ipgp.fr:18001
  • USP: seisrequest.iag.usp.br:18001

Attributes

__dict__
__doc__ unicode(string [, encoding[, errors]]) -> object
__module__ str(object) -> string
__weakref__ list of weak references to the object (if defined)
status_delay float(x) -> floating point number

Public Methods

getInventory Returns information about the available networks and stations in that particular space/time region.
getMetadata Returns poles, zeros, normalization factor and sensitivity and station coordinates for a single channel at a given time.
getNetworks Returns a dictionary of available networks within the given time span.
getPAZ Returns poles, zeros, normalization factor and sensitivity for a single channel at a given time.
getQC Retrieve QC information of ArcLink streams.
getRouting Get primary ArcLink host for given network/stations/time combination.
getStations Returns a dictionary of available stations in the given network(s).
getWaveform Retrieves waveform data via ArcLink and returns an ObsPy Stream object.
next
saveResponse Writes response information into a file.
saveWaveform Writes a retrieved waveform directly into a file.

Private Methods

_Client__parsePAZ
_bye
_fetch
_findRoute Searches routing table for requested stream id and date/times.
_hello
_readln
_reconnect
_request
_writeln

Special Methods

__init__ Initializes an ArcLink client.
__long__
__native__ Hook for the future.utils.native() function
__nonzero__
__unicode__

By the ObsPy Development Team and many Awesome Contributors™  |  Built with Bootstrap and Glyphicons  |  Copyright 2008-2015

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

  • Adolfo Inza
  • Alessia Maggi
  • Anthony Lomax
  • Benjamin Sullivan
  • Celso Reyes
  • Charles J. Ammon
  • Christian Sippl
  • Conny Hammer
  • Elliott Sales de Andrade
  • Emiliano Russo
  • Fabrizio Bernardi
  • Gaute Hope
  • Henri Martin
  • Joachim Wassermann
  • Lars Krieger
  • Leonardo Uieda
  • Lukas Heiniger
  • Marcus Walther
  • Mark C. Williams
  • Martin van Driel
  • Nathaniel C. Miller
  • Paul Käufl
  • Philippe Lesage
  • Sebastian Heimann
  • Simon Kremers
  • Sven Egdorf
  • Thomas Lecocq
  • Tom Richter
  • Victor Kress
  • Ólafur St. Arnarsson
  • Alberto Michelini
  • Andreas Köhler
  • Arthur Snoke
  • Bernhard Morgenstern
  • Chad Trabant
  • Chris Scheingraber
  • Claudio Satriano
  • David Ketchum
  • Emanuel Antunes
  • Fabian Engels
  • Felix Bernauer
  • Heiner Igel
  • Joachim Saul
  • John Leeman
  • Laura Ermert
  • Lion Krischer
  • Marc Grunberg
  • Marius Isken
  • Markus Bank
  • Moritz Beyreuther
  • Nicolas Rothenhäusler
  • Peter Danecek
  • Robert Barsch
  • Seyed Kasra Hosseini Zad
  • Stefan Stange
  • Sébastien Bonaimé
  • Tobias Megies
  • Tommaso Fabbri
  • Yannik Behr

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)