squirrel.client

class Source(**kwargs)

Bases: pyrocko.guts.Object

Undocumented.

update_channel_inventory(squirrel, constraint)

Let local inventory be up-to-date with remote for a given constraint.

update_event_inventory(squirrel, constraint)

Let local inventory be up-to-date with remote for a given constraint.

update_waveform_promises(squirrel, constraint)

Let local inventory be up-to-date with remote for a given constraint.

class Constraint(**kwargs)

Bases: pyrocko.guts.Object

Undocumented.

♦ tmin

builtins.float (pyrocko.guts.Timestamp), optional

♦ tmax

builtins.float (pyrocko.guts.Timestamp), optional

contains(constraint)

Check if the constraint completely includes a more restrictive one.

expand(constraint)

Widen constraint to include another given constraint.

class FileFormat(dummy) → str

Bases: pyrocko.guts.StringChoice

Any str out of ['detect', 'datacube', 'mseed', 'pyrocko_events', 'pyrocko_stations', 'sac', 'stationxml', 'tdms_idas', 'virtual', 'yaml'].

class ContentKind(dummy) → str

Bases: pyrocko.guts.StringChoice

Any str out of ['waveform', 'station', 'channel', 'response', 'event'].

class Local(*args, **kwargs)

Bases: pyrocko.squirrel.client.base.Source, pyrocko.has_paths.HasPaths

Undocumented.

♦ paths

list of builtins.str (pyrocko.has_paths.Path) objects, default: []

♦ kinds

list of builtins.str (ContentKind) objects, optional

♦ format

builtins.str (FileFormat), default: 'detect'

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

Bases: pyrocko.squirrel.client.base.Source

Squirrel source to access data through an FDSN web service.

♦ site

str

♦ query_args

dict of str objects, optional

♦ expires

builtins.float (pyrocko.guts.Duration), optional

♦ cache_path

str, optional

♦ shared_waveforms

bool, default: True

♦ user_credentials

tuple of 2 str objects, optional

♦ auth_token

str, optional

♦ auth_token_path

str, optional

update_channel_inventory(squirrel, constraint=None)

Let local inventory be up-to-date with remote for a given constraint.

update_waveform_promises(squirrel, constraint)

Let local inventory be up-to-date with remote for a given constraint.

class CatalogSource(catalog, query_args=None, **kwargs)

Bases: pyrocko.squirrel.client.base.Source

Undocumented.

♦ catalog

str

♦ query_args

dict of str objects, optional

♦ expires

builtins.float (pyrocko.guts.Duration), optional

♦ anxious

builtins.float (pyrocko.guts.Duration), optional

♦ cache_path

str, optional

update_event_inventory(squirrel, constraint=None)

Let local inventory be up-to-date with remote for a given constraint.