obspy.clients.iris.client.Client

class Client(base_url='http://service.iris.edu/irisws', user='', password='', timeout=20, debug=False, user_agent='ObsPy/1.4.0 (Linux-5.15.0-1022-azure-x86_64-with-glibc2.31, Python 3.9.14)', major_versions={})[source]

Bases: object

IRIS Web service request client.

Parameters:

base_url (str, optional) – Base URL of the IRIS Web service (default is 'http://service.iris.edu/irisws').
user (str, optional) – The user name used for authentication with the Web service (default an empty string).
password (str, optional) – A password used for authentication with the Web service (default is an empty string).
timeout (int, optional) – Seconds before a connection timeout is raised (default is 10 seconds).
debug (bool, optional) – Enables verbose output (default is False).
user_agent (str, optional) – Sets an client identification string which may be used on server side for statistical analysis (default contains the current module version and basic information about the used operation system, e.g. 'ObsPy 0.4.7.dev-r2432 (Windows-7-6.1.7601-SP1, Python 2.7.1)'.
major_versions (dict) – Allows to specify custom major version numbers for individual services (e.g. major_versions={‘evalresp’: 2, ‘sacpz’: 3}), otherwise the latest version at time of implementation will be used.

Example

>>> from obspy.clients.iris import Client
>>> client = Client()
>>> result = client.distaz(stalat=1.1, stalon=1.2, evtlat=3.2,
...                        evtlon=1.4)
>>> print(result['distance'])
2.10256
>>> print(result['backazimuth'])
5.46944
>>> print(result['azimuth'])
185.47695

Public Methods

`distaz`	Low-level interface for distaz Web service of IRIS (http://service.iris.edu/irisws/distaz/) - release 1.0.3 (2016).
`evalresp`	Low-level interface for evalresp Web service of IRIS (http://service.iris.edu/irisws/evalresp/) - release 1.0.0 (2011-08-11).
`flinnengdahl`	Low-level interface for flinnengdahl Web service of IRIS (http://service.iris.edu/irisws/flinnengdahl/) - release 1.1 (2011-06-08).
`resp`	Low-level interface for resp Web service of IRIS (http://service.iris.edu/irisws/resp/) - 1.4.1 (2011-04-14).
`sacpz`	Low-level interface for sacpz Web service of IRIS (http://service.iris.edu/irisws/sacpz/) - release 1.1.1 (2012-1-9).
`timeseries`	Low-level interface for timeseries Web service of IRIS (http://service.iris.edu/irisws/timeseries/)- release 1.3.5 (2012-06-07).
`traveltime`	Low-level interface for traveltime Web service of IRIS (http://service.iris.edu/irisws/traveltime/) - release 1.1.1 (2012-05-15).

Private Methods

Warning

Private methods are mainly for internal/developer use and their API might change without notice.

Client._fetch(service, data=None, headers={}, param_list=[], **params)[source]

Send a HTTP request via urllib2.

Parameters:

service (str) – Name of service
data (str) – Channel list as returned by availability Web service
headers (dict, optional) – Additional header information for request

Client._to_file_or_data(filename, data, binary=False)[source]

Either writes data into a file if filename is given or directly returns it.

Parameters:

filename (str or file) – File or object being written to. If None, a string will be returned.
data (str or bytes) – The data being written or returned.
binary (bool, optional) – Whether to write the data as binary or text. Defaults to binary.

Special Methods

Client.__delattr__(name, /): Implement delattr(self, name).

Client.__dir__(): Default dir() implementation.

Client.__eq__(value, /): Return self==value.

Client.__format__(format_spec, /): Default object formatter.

Client.__ge__(value, /): Return self>=value.

Client.__getattribute__(name, /): Return getattr(self, name).

Client.__gt__(value, /): Return self>value.

Client.__hash__(): Return hash(self).

Client.__init__(base_url='http://service.iris.edu/irisws', user='', password='', timeout=20, debug=False, user_agent='ObsPy/1.4.0 (Linux-5.15.0-1022-azure-x86_64-with-glibc2.31, Python 3.9.14)', major_versions={})[source]

Initializes the IRIS Web service client.

See obspy.clients.iris for all parameters.

Client.__init_subclass__()

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

Client.__le__(value, /): Return self<=value.

Client.__lt__(value, /): Return self<value.

Client.__ne__(value, /): Return self!=value.

Client.__new__(**kwargs)

Client.__reduce__(): Helper for pickle.

Client.__reduce_ex__(protocol, /): Helper for pickle.

Client.__repr__(): Return repr(self).

Client.__setattr__(name, value, /): Implement setattr(self, name, value).

Client.__sizeof__(): Size of object in memory, in bytes.

Client.__str__(): Return str(self).

Client.__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).