pyrocko.squirrel.client.fdsn

Squirrel client to access FDSN web services for seismic waveforms and metadata.

Classes

ErrorAggregate(**kwargs)	Undocumented.
ErrorEntry(**kwargs)	Undocumented.
ErrorLog(**kwargs)	Undocumented.
FDSNSource(site[, query_args, codes])	Squirrel data-source to transparently get data from FDSN web services.

class ErrorEntry(**kwargs)

Bases: Object

Undocumented.

♦ time

pyrocko.util.get_time_float (pyrocko.guts.Timestamp)

♦ order

pyrocko.squirrel.model.WaveformOrder

♦ kind

str

♦ details

str, optional

class ErrorAggregate(**kwargs)

Bases: Object

Undocumented.

♦ site

str

♦ kind

str

♦ details

str

♦ entries

list of ErrorEntry objects, default: []

♦ codes

list of pyrocko.model.codes.CodesNSLCE objects, default: []

♦ time_spans

list of tuple of 2 pyrocko.util.get_time_float (pyrocko.guts.Timestamp) objects objects, default: []

class ErrorLog(**kwargs)

Bases: Object

Undocumented.

♦ site

str

♦ entries

list of ErrorEntry objects, default: []

♦ checkpoints

list of int objects, default: []

class FDSNSource(site, query_args=None, codes=None, **kwargs)

Bases: Source

Squirrel data-source to transparently get data from FDSN web services.

Attaching an FDSNSource object to a Squirrel allows the latter to download station and waveform data from an FDSN web service should the data not already happen to be available locally.

♦ site

str

FDSN site url or alias name (see pyrocko.client.fdsn).

♦ query_args

dict of str objects, optional

Common query arguments, which are appended to all queries.

♦ codes

list of pyrocko.model.codes.CodesNSLCE objects, optional

List of codes patterns to query via POST parameters.

♦ expires

float (pyrocko.guts.Duration), optional

Expiration time [s]. Information older than this will be refreshed. This only applies to station-metadata. Waveforms do not expire. If set to None neither type of data expires.

♦ anxious

float (pyrocko.guts.Duration), default: 600.0

Anxiety period [s]. Missing waveforms will not be treated as permanently missing for orders spanning into times later than (current time - anxious). Default: 600.

♦ cache_path

str (pyrocko.has_paths.Path), optional

Directory path where any downloaded waveforms and station meta-data are to be kept. By default the Squirrel environment’s cache directory is used.

♦ shared_waveforms

bool, default: False

If True, waveforms are shared with other FDSN sources in the same Squirrel environment. If False, they are kept separate.

♦ storage_path

str (pyrocko.has_paths.Path), optional

If set, manage waveforms in the given directory rather than in the Squirrel cache.

♦ storage_scheme

str (pyrocko.squirrel.storage.StorageSchemeChoice), default: 'default'

Set layout of waveform storage. Available: 'default', 'sds'. Default: 'default'.

♦ user_credentials

tuple of 2 str objects, optional

User and password for FDSN servers requiring password authentication

♦ auth_token

str, optional

Authentication token to be presented to the FDSN server.

♦ auth_token_path

str (pyrocko.has_paths.Path), optional

Path to file containing the authentication token to be presented to the FDSN server.

♦ hotfix_module_path

str (pyrocko.has_paths.Path), optional

Path to Python module to locally patch metadata errors.

remove_waveform_promises(squirrel, from_database='selection')

Remove waveform promises from live selection or global database.

Parameters:

from_database – Remove from live selection 'selection' or global database 'global'.