pyrocko.squirrel.client.fdsn

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

Classes

Archive(**kwargs)

Undocumented.

ErrorAggregate(**kwargs)

Undocumented.

ErrorEntry(**kwargs)

Undocumented.

ErrorLog(**kwargs)

Undocumented.

FDSNSource(site[, query_args])

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

MSeedArchive(**kwargs)

Undocumented.

class Archive(**kwargs)[source]

Bases: Object

Undocumented.

class MSeedArchive(**kwargs)[source]

Bases: Archive

Undocumented.

template

str, default: '%(tmin_year)s/%(tmin_month)s/%(tmin_day)s/trace_%(network)s_%(station)s_%(location)s_%(channel)s_%(block_tmin_us)s_%(block_tmax_us)s.mseed'

class ErrorEntry(**kwargs)[source]

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)[source]

Bases: Object

Undocumented.

site

str

kind

str

details

str

entries

list of ErrorEntry objects, default: []

codes

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

time_spans

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

class ErrorLog(**kwargs)[source]

Bases: Object

Undocumented.

site

str

entries

list of ErrorEntry objects, default: []

checkpoints

list of int objects, default: []

class FDSNSource(site, query_args=None, **kwargs)[source]

Bases: Source, HasPaths

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.

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.

cache_path

str, 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.

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, 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')[source]

Remove waveform promises from live selection or global database.

Parameters:

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