pyrocko.squirrel.client.local

Data-source definition providing access local data.

Classes

ContentKind(...)

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

FileFormat(...)

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

LocalData(*args, **kwargs)

A collection of local files attachable as a Squirrel data-source.
class FileFormat(...) → str[source]

Bases: StringChoice

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

Variables:

  • choices – Allowed choices (list of str).

  • ignore_case – Whether to behave case-insensitive (bool, default: False).

class ContentKind(...) → str[source]

Bases: StringChoice

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

Variables:

  • choices – Allowed choices (list of str).

  • ignore_case – Whether to behave case-insensitive (bool, default: False).

class LocalData(*args, **kwargs)[source]

Bases: Source

A collection of local files attachable as a Squirrel data-source.

♦ paths

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

Directory and file paths to add to the Squirrel instance. See Squirrel.add().

♦ kinds

list of str (ContentKind) objects, optional

Content kinds to be added to the Squirrel selection. By default all known content kinds are added.

♦ include

str, optional

If not None, files are only included if their paths match the given regular expression pattern.

♦ exclude

str, optional

If not None, files are only included if their paths do not match the given regular expression pattern.

♦ format

str (FileFormat), default: 'detect'

Assume files are of given format.