Quick References

A brief glance at ObsPlus’ main features.

Events

obsplus.get_event_client(events)

Extract an event client from various inputs.

obsplus.EventBank([base_path, ...])

A class to interact with a directory of event files.

obsplus.events_to_df

A class to extract dataframes from nested object trees.

obsplus.picks_to_df

A class to extract dataframes from nested object trees.

obsplus.json_to_cat(cjson)

Convert a dictionary to a catalog

obsplus.cat_to_json(catalog)

Convert events (catalog or event) to json string.

Stations

obsplus.get_station_client(stations)

Extract a station client from various inputs.

obsplus.stations_to_df

A class to extract dataframes from nested object trees.

Waveforms

obsplus.get_waveform_client(waveforms)

Extract a waveform client from various inputs.

obsplus.WaveBank([base_path, ...])

A class to interact with a directory of waveform files.

Datasets

obsplus.datasets.dataset.DataSet([base_path])

Abstract Base Class for downloading and serving datasets.

obsplus.load_dataset(name[, silent])

Get a loaded dataset.

obsplus.Fetcher(waveforms[, stations, ...])

A class for serving up data from various sources.

Utils

obsplus.DataFrameExtractor(cls[, ...])

A class to extract dataframes from nested object trees.

obsplus.utils.yield_obj_parent_attr(obj[, ...])

Recurse an object, yield a tuple of object, parent, attr.

obsplus.utils.time.to_utc(value)

Convert an object or sequence to a UTCDateTime object.

obsplus.utils.time.to_datetime64(value[, ...])

Convert time value to a numpy datetime64, or array of such.