obspy.clients.arclink.client.Client¶
-
class
Client
(user, host='webdc.eu', port=18002, password='', institution='Anonymous', timeout=20, dcid_keys={}, dcid_key_file=None, debug=False, command_delay=0, status_delay=0.5)[source]¶ Bases:
object
The ArcLink/WebDC client.
Parameters: - 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.
- 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). - 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 passwordOfH9ekhi
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: arclink.ipgp.fr:18001
- USP: seisrequest.iag.usp.br:18001
Attributes
__dict__
__doc__
__module__
__weakref__
list of weak references to the object (if defined) max_status_requests
Public Methods
get_inventory
Returns information about the available networks and stations in that particular space/time region. get_metadata
Returns poles, zeros, normalization factor and sensitivity and station coordinates for a single channel at a given time. get_networks
Returns a dictionary of available networks within the given time span. get_paz
Returns poles, zeros, normalization factor and sensitivity for a single channel at a given time. get_qc
Retrieve QC information of ArcLink streams. get_routing
Get primary ArcLink host for given network/stations/time combination. get_stations
Returns a dictionary of available stations in the given network(s). get_waveforms
Retrieves waveform data via ArcLink and returns an ObsPy Stream object. save_response
Writes response information into a file. save_waveforms
Writes a retrieved waveform directly into a file. Private Methods
Warning
Private methods are mainly for internal/developer use and their API might change without notice.
_Client__parse_paz
_bye
_fetch
_find_route
Searches routing table for requested stream id and date/times. _hello
_read_ln
_reconnect
_request
_write_ln
Special Methods
__dir__
Default dir() implementation. __format__
Default object formatter. __init__
Initializes an ArcLink client. __init_subclass__
This method is called when a class is subclassed. __new__
Create and return a new object. __reduce__
Helper for pickle. __reduce_ex__
Helper for pickle. __sizeof__
Size of object in memory, in bytes. __subclasshook__
Abstract classes can override this to customize issubclass().