obspy.clients.iris.client.Client

class Client(base_url='http://service.iris.edu/irisws', user='', password='', timeout=20, debug=False, user_agent='ObsPy/1.1.1 (Linux-4.16.13-300.fc28.ppc64le-ppc64le-with-fedora-31-Rawhide, Python 3.7.3)', 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

Attributes

__dict__

__doc__

__module__

__weakref__

list of weak references to the object (if defined)

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.

_fetch

Send a HTTP request via urllib2.

_to_file_or_data

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

Special Methods

__dir__

Default dir() implementation.

__format__

Default object formatter.

__init__

Initializes the IRIS Web service 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().