# http://pyrocko.org - GPLv3
#
# The Pyrocko Developers, 21st Century
# ---|P------/S----------~Lg----------
'''
Squirrel main classes.
'''
import sys
import os
import time
import math
import logging
import threading
import queue
from collections import defaultdict
from pyrocko.guts import Object, Int, List, Tuple, String, Timestamp, Dict
from pyrocko import util, trace
from pyrocko import progress
from pyrocko.plot import nice_time_tick_inc_approx_secs
from . import model, io, cache, dataset
from .model import to_kind_id, WaveformOrder, to_kind, to_codes, \
STATION, CHANNEL, RESPONSE, EVENT, WAVEFORM, codes_patterns_list, \
codes_patterns_for_kind
from .client import fdsn, catalog
from .selection import Selection, filldocs
from .database import abspath
from .operators.base import Operator, CodesPatternFiltering
from . import client, environment, error
logger = logging.getLogger('psq.base')
guts_prefix = 'squirrel'
def nonef(f, xs):
xs_ = [x for x in xs if x is not None]
if xs_:
return f(xs_)
else:
return None
def make_task(*args):
return progress.task(*args, logger=logger)
def lpick(condition, seq):
ft = [], []
for ele in seq:
ft[int(bool(condition(ele)))].append(ele)
return ft
def len_plural(obj):
return len(obj), '' if len(obj) == 1 else 's'
def blocks(tmin, tmax, deltat, nsamples_block=100000):
tblock = nice_time_tick_inc_approx_secs(
util.to_time_float(deltat * nsamples_block))
iblock_min = int(math.floor(tmin / tblock))
iblock_max = int(math.ceil(tmax / tblock))
for iblock in range(iblock_min, iblock_max):
yield iblock * tblock, (iblock+1) * tblock
def gaps(avail, tmin, tmax):
assert tmin < tmax
data = [(tmax, 1), (tmin, -1)]
for (tmin_a, tmax_a) in avail:
assert tmin_a < tmax_a
data.append((tmin_a, 1))
data.append((tmax_a, -1))
data.sort()
s = 1
gaps = []
tmin_g = None
for t, x in data:
if s == 1 and x == -1:
tmin_g = t
elif s == 0 and x == 1 and tmin_g is not None:
tmax_g = t
if tmin_g != tmax_g:
gaps.append((tmin_g, tmax_g))
s += x
return gaps
def order_key(order):
return (order.codes, order.tmin, order.tmax)
def _is_exact(pat):
return not ('*' in pat or '?' in pat or ']' in pat or '[' in pat)
def prefix_tree(tups):
if not tups:
return []
if len(tups[0]) == 1:
return sorted((tup[0], []) for tup in tups)
d = defaultdict(list)
for tup in tups:
d[tup[0]].append(tup[1:])
sub = []
for k in sorted(d.keys()):
sub.append((k, prefix_tree(d[k])))
return sub
def match_time_span(tmin, tmax, obj):
return (obj.tmin is None or tmax is None or obj.tmin <= tmax) \
and (tmin is None or obj.tmax is None or tmin < obj.tmax)
[docs]class Batch(object):
'''
Batch of waveforms from window-wise data extraction.
Encapsulates state and results yielded for each window in window-wise
waveform extraction with the :py:meth:`Squirrel.chopper_waveforms` method.
*Attributes:*
.. py:attribute:: tmin
Start of this time window.
.. py:attribute:: tmax
End of this time window.
.. py:attribute:: i
Index of this time window in sequence.
.. py:attribute:: n
Total number of time windows in sequence.
.. py:attribute:: igroup
Index of this time window's sequence group.
.. py:attribute:: ngroups
Total number of sequence groups.
.. py:attribute:: traces
Extracted waveforms for this time window.
'''
def __init__(self, tmin, tmax, i, n, igroup, ngroups, traces):
self.tmin = tmin
self.tmax = tmax
self.i = i
self.n = n
self.igroup = igroup
self.ngroups = ngroups
self.traces = traces
[docs]class Squirrel(Selection):
'''
Prompt, lazy, indexing, caching, dynamic seismological dataset access.
:param env:
Squirrel environment instance or directory path to use as starting
point for its detection. By default, the current directory is used as
starting point. When searching for a usable environment the directory
``'.squirrel'`` or ``'squirrel'`` in the current (or starting point)
directory is used if it exists, otherwise the parent directories are
search upwards for the existence of such a directory. If no such
directory is found, the user's global Squirrel environment
``'$HOME/.pyrocko/squirrel'`` is used.
:type env:
:py:class:`~pyrocko.squirrel.environment.Environment` or
:py:class:`str`
:param database:
Database instance or path to database. By default the
database found in the detected Squirrel environment is used.
:type database:
:py:class:`~pyrocko.squirrel.database.Database` or :py:class:`str`
:param cache_path:
Directory path to use for data caching. By default, the ``'cache'``
directory in the detected Squirrel environment is used.
:type cache_path:
:py:class:`str`
:param persistent:
If given a name, create a persistent selection.
:type persistent:
:py:class:`str`
This is the central class of the Squirrel framework. It provides a unified
interface to query and access seismic waveforms, station meta-data and
event information from local file collections and remote data sources. For
prompt responses, a profound database setup is used under the hood. To
speed up assemblage of ad-hoc data selections, files are indexed on first
use and the extracted meta-data is remembered in the database for
subsequent accesses. Bulk data is lazily loaded from disk and remote
sources, just when requested. Once loaded, data is cached in memory to
expedite typical access patterns. Files and data sources can be dynamically
added to and removed from the Squirrel selection at runtime.
Queries are restricted to the contents of the files currently added to the
Squirrel selection (usually a subset of the file meta-information
collection in the database). This list of files is referred to here as the
"selection". By default, temporary tables are created in the attached
database to hold the names of the files in the selection as well as various
indices and counters. These tables are only visible inside the application
which created them and are deleted when the database connection is closed
or the application exits. To create a selection which is not deleted at
exit, supply a name to the ``persistent`` argument of the Squirrel
constructor. Persistent selections are shared among applications using the
same database.
**Method summary**
Some of the methods are implemented in :py:class:`Squirrel`'s base class
:py:class:`~pyrocko.squirrel.selection.Selection`.
.. autosummary::
~Squirrel.add
~Squirrel.add_source
~Squirrel.add_fdsn
~Squirrel.add_catalog
~Squirrel.add_dataset
~Squirrel.add_virtual
~Squirrel.update
~Squirrel.update_waveform_promises
~Squirrel.advance_accessor
~Squirrel.clear_accessor
~Squirrel.reload
~pyrocko.squirrel.selection.Selection.iter_paths
~Squirrel.iter_nuts
~Squirrel.iter_kinds
~Squirrel.iter_deltats
~Squirrel.iter_codes
~pyrocko.squirrel.selection.Selection.get_paths
~Squirrel.get_nuts
~Squirrel.get_kinds
~Squirrel.get_deltats
~Squirrel.get_codes
~Squirrel.get_counts
~Squirrel.get_time_span
~Squirrel.get_deltat_span
~Squirrel.get_nfiles
~Squirrel.get_nnuts
~Squirrel.get_total_size
~Squirrel.get_stats
~Squirrel.get_content
~Squirrel.get_stations
~Squirrel.get_channels
~Squirrel.get_responses
~Squirrel.get_events
~Squirrel.get_waveform_nuts
~Squirrel.get_waveforms
~Squirrel.chopper_waveforms
~Squirrel.get_coverage
~Squirrel.pile
~Squirrel.snuffle
~Squirrel.glob_codes
~pyrocko.squirrel.selection.Selection.get_database
~Squirrel.print_tables
'''
def __init__(
self, env=None, database=None, cache_path=None, persistent=None):
if not isinstance(env, environment.Environment):
env = environment.get_environment(env)
if database is None:
database = env.expand_path(env.database_path)
if cache_path is None:
cache_path = env.expand_path(env.cache_path)
if persistent is None:
persistent = env.persistent
Selection.__init__(
self, database=database, persistent=persistent)
self.get_database().set_basepath(os.path.dirname(env.get_basepath()))
self._content_caches = {
'waveform': cache.ContentCache(),
'default': cache.ContentCache()}
self._cache_path = cache_path
self._sources = []
self._operators = []
self._operator_registry = {}
self._pending_orders = []
self._pile = None
self._n_choppers_active = 0
self.downloads_enabled = True
self._names.update({
'nuts': self.name + '_nuts',
'kind_codes_count': self.name + '_kind_codes_count',
'coverage': self.name + '_coverage'})
with self.transaction('create tables') as cursor:
self._create_tables_squirrel(cursor)
def _create_tables_squirrel(self, cursor):
cursor.execute(self._register_table(self._sql(
'''
CREATE TABLE IF NOT EXISTS %(db)s.%(nuts)s (
nut_id integer PRIMARY KEY,
file_id integer,
file_segment integer,
file_element integer,
kind_id integer,
kind_codes_id integer,
tmin_seconds integer,
tmin_offset integer,
tmax_seconds integer,
tmax_offset integer,
kscale integer)
''')))
cursor.execute(self._register_table(self._sql(
'''
CREATE TABLE IF NOT EXISTS %(db)s.%(kind_codes_count)s (
kind_codes_id integer PRIMARY KEY,
count integer)
''')))
cursor.execute(self._sql(
'''
CREATE UNIQUE INDEX IF NOT EXISTS %(db)s.%(nuts)s_file_element
ON %(nuts)s (file_id, file_segment, file_element)
'''))
cursor.execute(self._sql(
'''
CREATE INDEX IF NOT EXISTS %(db)s.%(nuts)s_index_file_id
ON %(nuts)s (file_id)
'''))
cursor.execute(self._sql(
'''
CREATE INDEX IF NOT EXISTS %(db)s.%(nuts)s_index_tmin_seconds
ON %(nuts)s (kind_id, tmin_seconds)
'''))
cursor.execute(self._sql(
'''
CREATE INDEX IF NOT EXISTS %(db)s.%(nuts)s_index_tmax_seconds
ON %(nuts)s (kind_id, tmax_seconds)
'''))
cursor.execute(self._sql(
'''
CREATE INDEX IF NOT EXISTS %(db)s.%(nuts)s_index_kscale
ON %(nuts)s (kind_id, kscale, tmin_seconds)
'''))
cursor.execute(self._sql(
'''
CREATE TRIGGER IF NOT EXISTS %(db)s.%(nuts)s_delete_nuts
BEFORE DELETE ON main.files FOR EACH ROW
BEGIN
DELETE FROM %(nuts)s WHERE file_id == old.file_id;
END
'''))
# trigger only on size to make silent update of mtime possible
cursor.execute(self._sql(
'''
CREATE TRIGGER IF NOT EXISTS %(db)s.%(nuts)s_delete_nuts2
BEFORE UPDATE OF size ON main.files FOR EACH ROW
BEGIN
DELETE FROM %(nuts)s WHERE file_id == old.file_id;
END
'''))
cursor.execute(self._sql(
'''
CREATE TRIGGER IF NOT EXISTS
%(db)s.%(file_states)s_delete_files
BEFORE DELETE ON %(db)s.%(file_states)s FOR EACH ROW
BEGIN
DELETE FROM %(nuts)s WHERE file_id == old.file_id;
END
'''))
cursor.execute(self._sql(
'''
CREATE TRIGGER IF NOT EXISTS %(db)s.%(nuts)s_inc_kind_codes
BEFORE INSERT ON %(nuts)s FOR EACH ROW
BEGIN
INSERT OR IGNORE INTO %(kind_codes_count)s VALUES
(new.kind_codes_id, 0);
UPDATE %(kind_codes_count)s
SET count = count + 1
WHERE new.kind_codes_id
== %(kind_codes_count)s.kind_codes_id;
END
'''))
cursor.execute(self._sql(
'''
CREATE TRIGGER IF NOT EXISTS %(db)s.%(nuts)s_dec_kind_codes
BEFORE DELETE ON %(nuts)s FOR EACH ROW
BEGIN
UPDATE %(kind_codes_count)s
SET count = count - 1
WHERE old.kind_codes_id
== %(kind_codes_count)s.kind_codes_id;
END
'''))
cursor.execute(self._register_table(self._sql(
'''
CREATE TABLE IF NOT EXISTS %(db)s.%(coverage)s (
kind_codes_id integer,
time_seconds integer,
time_offset integer,
step integer)
''')))
cursor.execute(self._sql(
'''
CREATE UNIQUE INDEX IF NOT EXISTS %(db)s.%(coverage)s_time
ON %(coverage)s (kind_codes_id, time_seconds, time_offset)
'''))
cursor.execute(self._sql(
'''
CREATE TRIGGER IF NOT EXISTS %(db)s.%(nuts)s_add_coverage
AFTER INSERT ON %(nuts)s FOR EACH ROW
BEGIN
INSERT OR IGNORE INTO %(coverage)s VALUES
(new.kind_codes_id, new.tmin_seconds, new.tmin_offset, 0)
;
UPDATE %(coverage)s
SET step = step + 1
WHERE new.kind_codes_id == %(coverage)s.kind_codes_id
AND new.tmin_seconds == %(coverage)s.time_seconds
AND new.tmin_offset == %(coverage)s.time_offset
;
INSERT OR IGNORE INTO %(coverage)s VALUES
(new.kind_codes_id, new.tmax_seconds, new.tmax_offset, 0)
;
UPDATE %(coverage)s
SET step = step - 1
WHERE new.kind_codes_id == %(coverage)s.kind_codes_id
AND new.tmax_seconds == %(coverage)s.time_seconds
AND new.tmax_offset == %(coverage)s.time_offset
;
DELETE FROM %(coverage)s
WHERE new.kind_codes_id == %(coverage)s.kind_codes_id
AND new.tmin_seconds == %(coverage)s.time_seconds
AND new.tmin_offset == %(coverage)s.time_offset
AND step == 0
;
DELETE FROM %(coverage)s
WHERE new.kind_codes_id == %(coverage)s.kind_codes_id
AND new.tmax_seconds == %(coverage)s.time_seconds
AND new.tmax_offset == %(coverage)s.time_offset
AND step == 0
;
END
'''))
cursor.execute(self._sql(
'''
CREATE TRIGGER IF NOT EXISTS %(db)s.%(nuts)s_remove_coverage
BEFORE DELETE ON %(nuts)s FOR EACH ROW
BEGIN
INSERT OR IGNORE INTO %(coverage)s VALUES
(old.kind_codes_id, old.tmin_seconds, old.tmin_offset, 0)
;
UPDATE %(coverage)s
SET step = step - 1
WHERE old.kind_codes_id == %(coverage)s.kind_codes_id
AND old.tmin_seconds == %(coverage)s.time_seconds
AND old.tmin_offset == %(coverage)s.time_offset
;
INSERT OR IGNORE INTO %(coverage)s VALUES
(old.kind_codes_id, old.tmax_seconds, old.tmax_offset, 0)
;
UPDATE %(coverage)s
SET step = step + 1
WHERE old.kind_codes_id == %(coverage)s.kind_codes_id
AND old.tmax_seconds == %(coverage)s.time_seconds
AND old.tmax_offset == %(coverage)s.time_offset
;
DELETE FROM %(coverage)s
WHERE old.kind_codes_id == %(coverage)s.kind_codes_id
AND old.tmin_seconds == %(coverage)s.time_seconds
AND old.tmin_offset == %(coverage)s.time_offset
AND step == 0
;
DELETE FROM %(coverage)s
WHERE old.kind_codes_id == %(coverage)s.kind_codes_id
AND old.tmax_seconds == %(coverage)s.time_seconds
AND old.tmax_offset == %(coverage)s.time_offset
AND step == 0
;
END
'''))
def _delete(self):
'''Delete database tables associated with this Squirrel.'''
with self.transaction('delete tables') as cursor:
for s in '''
DROP TRIGGER %(db)s.%(nuts)s_delete_nuts;
DROP TRIGGER %(db)s.%(nuts)s_delete_nuts2;
DROP TRIGGER %(db)s.%(file_states)s_delete_files;
DROP TRIGGER %(db)s.%(nuts)s_inc_kind_codes;
DROP TRIGGER %(db)s.%(nuts)s_dec_kind_codes;
DROP TABLE %(db)s.%(nuts)s;
DROP TABLE %(db)s.%(kind_codes_count)s;
DROP TRIGGER IF EXISTS %(db)s.%(nuts)s_add_coverage;
DROP TRIGGER IF EXISTS %(db)s.%(nuts)s_remove_coverage;
DROP TABLE IF EXISTS %(db)s.%(coverage)s;
'''.strip().splitlines():
cursor.execute(self._sql(s))
Selection._delete(self)
[docs] @filldocs
def add(self,
paths,
kinds=None,
format='detect',
include=None,
exclude=None,
check=True):
'''
Add files to the selection.
:param paths:
Iterator yielding paths to files or directories to be added to the
selection. Recurses into directories. If given a ``str``, it
is treated as a single path to be added.
:type paths:
:py:class:`list` of :py:class:`str`
:param kinds:
Content types to be made available through the Squirrel selection.
By default, all known content types are accepted.
:type kinds:
:py:class:`list` of :py:class:`str`
:param format:
File format identifier or ``'detect'`` to enable auto-detection
(available: %(file_formats)s).
:type format:
str
:param include:
If not ``None``, files are only included if their paths match the
given regular expression pattern.
:type format:
str
:param exclude:
If not ``None``, files are only included if their paths do not
match the given regular expression pattern.
:type format:
str
:param check:
If ``True``, all file modification times are checked to see if
cached information has to be updated (slow). If ``False``, only
previously unknown files are indexed and cached information is used
for known files, regardless of file state (fast, corrresponds to
Squirrel's ``--optimistic`` mode). File deletions will go
undetected in the latter case.
:type check:
bool
:Complexity:
O(log N)
'''
if isinstance(kinds, str):
kinds = (kinds,)
if isinstance(paths, str):
paths = [paths]
kind_mask = model.to_kind_mask(kinds)
Selection.add(
self, util.iter_select_files(
paths,
show_progress=False,
include=include,
exclude=exclude,
pass_through=lambda path: path.startswith('virtual:')
), kind_mask, format)
self._load(check)
self._update_nuts()
[docs] def reload(self):
'''
Check for modifications and reindex modified files.
Based on file modification times.
'''
self._set_file_states_force_check()
self._load(check=True)
self._update_nuts()
[docs] def add_virtual(self, nuts, virtual_paths=None):
'''
Add content which is not backed by files.
:param nuts:
Content pieces to be added.
:type nuts:
iterator yielding :py:class:`~pyrocko.squirrel.model.Nut` objects
:param virtual_paths:
List of virtual paths to prevent creating a temporary list of the
nuts while aggregating the file paths for the selection.
:type virtual_paths:
:py:class:`list` of :py:class:`str`
Stores to the main database and the selection.
'''
if isinstance(virtual_paths, str):
virtual_paths = [virtual_paths]
if virtual_paths is None:
if not isinstance(nuts, list):
nuts = list(nuts)
virtual_paths = set(nut.file_path for nut in nuts)
Selection.add(self, virtual_paths)
self.get_database().dig(nuts)
self._update_nuts()
def add_volatile(self, nuts):
if not isinstance(nuts, list):
nuts = list(nuts)
paths = list(set(nut.file_path for nut in nuts))
io.backends.virtual.add_nuts(nuts)
self.add_virtual(nuts, paths)
self._volatile_paths.extend(paths)
def _load(self, check):
for _ in io.iload(
self,
content=[],
skip_unchanged=True,
check=check):
pass
def _update_nuts(self, transaction=None):
transaction = transaction or self.transaction('update nuts')
with make_task('Aggregating selection') as task, \
transaction as cursor:
self._conn.set_progress_handler(task.update, 100000)
nrows = cursor.execute(self._sql(
'''
INSERT INTO %(db)s.%(nuts)s
SELECT NULL,
nuts.file_id, nuts.file_segment, nuts.file_element,
nuts.kind_id, nuts.kind_codes_id,
nuts.tmin_seconds, nuts.tmin_offset,
nuts.tmax_seconds, nuts.tmax_offset,
nuts.kscale
FROM %(db)s.%(file_states)s
INNER JOIN nuts
ON %(db)s.%(file_states)s.file_id == nuts.file_id
INNER JOIN kind_codes
ON nuts.kind_codes_id ==
kind_codes.kind_codes_id
WHERE %(db)s.%(file_states)s.file_state != 2
AND (((1 << kind_codes.kind_id)
& %(db)s.%(file_states)s.kind_mask) != 0)
''')).rowcount
task.update(nrows)
self._set_file_states_known(transaction)
self._conn.set_progress_handler(None, 0)
[docs] def add_source(self, source, check=True):
'''
Add remote resource.
:param source:
Remote data access client instance.
:type source:
subclass of :py:class:`~pyrocko.squirrel.client.base.Source`
'''
self._sources.append(source)
source.setup(self, check=check)
[docs] def add_fdsn(self, *args, **kwargs):
'''
Add FDSN site for transparent remote data access.
Arguments are passed to
:py:class:`~pyrocko.squirrel.client.fdsn.FDSNSource`.
'''
self.add_source(fdsn.FDSNSource(*args, **kwargs))
[docs] def add_catalog(self, *args, **kwargs):
'''
Add online catalog for transparent event data access.
Arguments are passed to
:py:class:`~pyrocko.squirrel.client.catalog.CatalogSource`.
'''
self.add_source(catalog.CatalogSource(*args, **kwargs))
[docs] def add_dataset(self, ds, check=True):
'''
Read dataset description from file and add its contents.
:param ds:
Path to dataset description file, dataset description object
or name of a built-in dataset. See
:py:mod:`~pyrocko.squirrel.dataset`.
:type ds:
:py:class:`str` or :py:class:`~pyrocko.squirrel.dataset.Dataset`
:param check:
If ``True``, all file modification times are checked to see if
cached information has to be updated (slow). If ``False``, only
previously unknown files are indexed and cached information is used
for known files, regardless of file state (fast, corrresponds to
Squirrel's ``--optimistic`` mode). File deletions will go
undetected in the latter case.
:type check:
bool
'''
if isinstance(ds, str):
ds = dataset.read_dataset(ds)
ds.setup(self, check=check)
def _get_selection_args(
self, kind_id,
obj=None, tmin=None, tmax=None, time=None, codes=None):
if codes is not None:
codes = codes_patterns_for_kind(kind_id, codes)
if time is not None:
tmin = time
tmax = time
if obj is not None:
tmin = tmin if tmin is not None else obj.tmin
tmax = tmax if tmax is not None else obj.tmax
codes = codes if codes is not None else codes_patterns_for_kind(
kind_id, obj.codes)
return tmin, tmax, codes
def _get_selection_args_str(self, *args, **kwargs):
tmin, tmax, codes = self._get_selection_args(*args, **kwargs)
return 'tmin: %s, tmax: %s, codes: %s' % (
util.time_to_str(tmin) if tmin is not None else 'none',
util.time_to_str(tmax) if tmax is not None else 'none',
','.join(str(entry) for entry in codes))
def _selection_args_to_kwargs(
self, obj=None, tmin=None, tmax=None, time=None, codes=None):
return dict(obj=obj, tmin=tmin, tmax=tmax, time=time, codes=codes)
def _timerange_sql(self, tmin, tmax, kind, cond, args, naiv):
tmin_seconds, tmin_offset = model.tsplit(tmin)
tmax_seconds, tmax_offset = model.tsplit(tmax)
if naiv:
cond.append('%(db)s.%(nuts)s.tmin_seconds <= ?')
args.append(tmax_seconds)
else:
tscale_edges = model.tscale_edges
tmin_cond = []
for kscale in range(tscale_edges.size + 1):
if kscale != tscale_edges.size:
tscale = int(tscale_edges[kscale])
tmin_cond.append('''
(%(db)s.%(nuts)s.kind_id = ?
AND %(db)s.%(nuts)s.kscale == ?
AND %(db)s.%(nuts)s.tmin_seconds BETWEEN ? AND ?)
''')
args.extend(
(to_kind_id(kind), kscale,
tmin_seconds - tscale - 1, tmax_seconds + 1))
else:
tmin_cond.append('''
(%(db)s.%(nuts)s.kind_id == ?
AND %(db)s.%(nuts)s.kscale == ?
AND %(db)s.%(nuts)s.tmin_seconds <= ?)
''')
args.extend(
(to_kind_id(kind), kscale, tmax_seconds + 1))
if tmin_cond:
cond.append(' ( ' + ' OR '.join(tmin_cond) + ' ) ')
cond.append('%(db)s.%(nuts)s.tmax_seconds >= ?')
args.append(tmin_seconds)
def _codes_match_sql(self, positive, kind_id, codes, cond, args):
pats = codes_patterns_for_kind(kind_id, codes)
if pats is None:
return
pats_exact = []
pats_nonexact = []
for pat in pats:
spat = pat.safe_str
(pats_exact if _is_exact(spat) else pats_nonexact).append(spat)
codes_cond = []
if pats_exact:
codes_cond.append(' ( kind_codes.codes IN ( %s ) ) ' % ', '.join(
'?'*len(pats_exact)))
args.extend(pats_exact)
if pats_nonexact:
codes_cond.append(' ( %s ) ' % ' OR '.join(
('kind_codes.codes GLOB ?',) * len(pats_nonexact)))
args.extend(pats_nonexact)
if codes_cond:
cond.append('%s ( %s )' % (
'NOT' if not positive else '',
' OR '.join(codes_cond)))
[docs] def iter_nuts(
self, kind=None, tmin=None, tmax=None, codes=None,
codes_exclude=None, sample_rate_min=None, sample_rate_max=None,
naiv=False, kind_codes_ids=None, path=None, limit=None):
'''
Iterate over content entities matching given constraints.
:param kind:
Content kind (or kinds) to extract.
:type kind:
:py:class:`str`, :py:class:`list` of :py:class:`str`
:param tmin:
Start time of query interval.
:type tmin:
:py:func:`~pyrocko.util.get_time_float`
:param tmax:
End time of query interval.
:type tmax:
:py:func:`~pyrocko.util.get_time_float`
:param codes:
List of code patterns to query.
:type codes:
:py:class:`list` of :py:class:`~pyrocko.squirrel.model.Codes`
objects appropriate for the queried content type, or anything which
can be converted to such objects.
:param naiv:
Bypass time span lookup through indices (slow, for testing).
:type naiv:
:py:class:`bool`
:param kind_codes_ids:
Kind-codes IDs of contents to be retrieved (internal use).
:type kind_codes_ids:
:py:class:`list` of :py:class:`int`
:yields:
:py:class:`~pyrocko.squirrel.model.Nut` objects representing the
intersecting content.
:complexity:
O(log N) for the time selection part due to heavy use of database
indices.
Query time span is treated as a half-open interval ``[tmin, tmax)``.
However, if ``tmin`` equals ``tmax``, the edge logics are modified to
closed-interval so that content intersecting with the time instant ``t
= tmin = tmax`` is returned (otherwise nothing would be returned as
``[t, t)`` never matches anything).
Time spans of content entities to be matched are also treated as half
open intervals, e.g. content span ``[0, 1)`` is matched by query span
``[0, 1)`` but not by ``[-1, 0)`` or ``[1, 2)``. Also here, logics are
modified to closed-interval when the content time span is an empty
interval, i.e. to indicate a time instant. E.g. time instant 0 is
matched by ``[0, 1)`` but not by ``[-1, 0)`` or ``[1, 2)``.
'''
if not isinstance(kind, str):
if kind is None:
kind = model.g_content_kinds
for kind_ in kind:
for nut in self.iter_nuts(kind_, tmin, tmax, codes):
yield nut
return
kind_id = to_kind_id(kind)
cond = []
args = []
if tmin is not None or tmax is not None:
assert kind is not None
if tmin is None:
tmin = self.get_time_span()[0]
if tmax is None:
tmax = self.get_time_span()[1] + 1.0
self._timerange_sql(tmin, tmax, kind, cond, args, naiv)
cond.append('kind_codes.kind_id == ?')
args.append(kind_id)
if codes is not None:
self._codes_match_sql(True, kind_id, codes, cond, args)
if codes_exclude is not None:
self._codes_match_sql(False, kind_id, codes_exclude, cond, args)
if sample_rate_min is not None:
cond.append('kind_codes.deltat <= ?')
args.append(1.0/sample_rate_min)
if sample_rate_max is not None:
cond.append('? <= kind_codes.deltat')
args.append(1.0/sample_rate_max)
if kind_codes_ids is not None:
cond.append(
' ( kind_codes.kind_codes_id IN ( %s ) ) ' % ', '.join(
'?'*len(kind_codes_ids)))
args.extend(kind_codes_ids)
db = self.get_database()
if path is not None:
cond.append('files.path == ?')
args.append(db.relpath(abspath(path)))
sql = ('''
SELECT
files.path,
files.format,
files.mtime,
files.size,
%(db)s.%(nuts)s.file_segment,
%(db)s.%(nuts)s.file_element,
kind_codes.kind_id,
kind_codes.codes,
%(db)s.%(nuts)s.tmin_seconds,
%(db)s.%(nuts)s.tmin_offset,
%(db)s.%(nuts)s.tmax_seconds,
%(db)s.%(nuts)s.tmax_offset,
kind_codes.deltat
FROM files
INNER JOIN %(db)s.%(nuts)s
ON files.file_id == %(db)s.%(nuts)s.file_id
INNER JOIN kind_codes
ON %(db)s.%(nuts)s.kind_codes_id == kind_codes.kind_codes_id
''')
if cond:
sql += ''' WHERE ''' + ' AND '.join(cond)
if limit is not None:
sql += ''' LIMIT %i''' % limit
sql = self._sql(sql)
if tmin is None and tmax is None:
for row in self._conn.execute(sql, args):
row = (db.abspath(row[0]),) + row[1:]
nut = model.Nut(values_nocheck=row)
yield nut
else:
assert tmin is not None and tmax is not None
if tmin == tmax:
for row in self._conn.execute(sql, args):
row = (db.abspath(row[0]),) + row[1:]
nut = model.Nut(values_nocheck=row)
if (nut.tmin <= tmin < nut.tmax) \
or (nut.tmin == nut.tmax and tmin == nut.tmin):
yield nut
else:
for row in self._conn.execute(sql, args):
row = (db.abspath(row[0]),) + row[1:]
nut = model.Nut(values_nocheck=row)
if (tmin < nut.tmax and nut.tmin < tmax) \
or (nut.tmin == nut.tmax
and tmin <= nut.tmin < tmax):
yield nut
[docs] def get_nuts(self, *args, **kwargs):
'''
Get content entities matching given constraints.
Like :py:meth:`iter_nuts` but returns results as a list.
'''
return list(self.iter_nuts(*args, **kwargs))
def _split_nuts(
self, kind, tmin=None, tmax=None, codes=None, path=None):
kind_id = to_kind_id(kind)
tmin_seconds, tmin_offset = model.tsplit(tmin)
tmax_seconds, tmax_offset = model.tsplit(tmax)
names_main_nuts = dict(self._names)
names_main_nuts.update(db='main', nuts='nuts')
db = self.get_database()
def main_nuts(s):
return s % names_main_nuts
with self.transaction('split nuts') as cursor:
# modify selection and main
for sql_subst in [
self._sql, main_nuts]:
cond = []
args = []
self._timerange_sql(tmin, tmax, kind, cond, args, False)
if codes is not None:
self._codes_match_sql(True, kind_id, codes, cond, args)
if path is not None:
cond.append('files.path == ?')
args.append(db.relpath(abspath(path)))
sql = sql_subst('''
SELECT
%(db)s.%(nuts)s.nut_id,
%(db)s.%(nuts)s.tmin_seconds,
%(db)s.%(nuts)s.tmin_offset,
%(db)s.%(nuts)s.tmax_seconds,
%(db)s.%(nuts)s.tmax_offset,
kind_codes.deltat
FROM files
INNER JOIN %(db)s.%(nuts)s
ON files.file_id == %(db)s.%(nuts)s.file_id
INNER JOIN kind_codes
ON %(db)s.%(nuts)s.kind_codes_id == kind_codes.kind_codes_id
WHERE ''' + ' AND '.join(cond)) # noqa
insert = []
delete = []
for row in cursor.execute(sql, args):
nut_id, nut_tmin_seconds, nut_tmin_offset, \
nut_tmax_seconds, nut_tmax_offset, nut_deltat = row
nut_tmin = model.tjoin(
nut_tmin_seconds, nut_tmin_offset)
nut_tmax = model.tjoin(
nut_tmax_seconds, nut_tmax_offset)
if nut_tmin < tmax and tmin < nut_tmax:
if nut_tmin < tmin:
insert.append((
nut_tmin_seconds, nut_tmin_offset,
tmin_seconds, tmin_offset,
model.tscale_to_kscale(
tmin_seconds - nut_tmin_seconds),
nut_id))
if tmax < nut_tmax:
insert.append((
tmax_seconds, tmax_offset,
nut_tmax_seconds, nut_tmax_offset,
model.tscale_to_kscale(
nut_tmax_seconds - tmax_seconds),
nut_id))
delete.append((nut_id,))
sql_add = '''
INSERT INTO %(db)s.%(nuts)s (
file_id, file_segment, file_element, kind_id,
kind_codes_id, tmin_seconds, tmin_offset,
tmax_seconds, tmax_offset, kscale )
SELECT
file_id, file_segment, file_element,
kind_id, kind_codes_id, ?, ?, ?, ?, ?
FROM %(db)s.%(nuts)s
WHERE nut_id == ?
'''
cursor.executemany(sql_subst(sql_add), insert)
sql_delete = '''
DELETE FROM %(db)s.%(nuts)s WHERE nut_id == ?
'''
cursor.executemany(sql_subst(sql_delete), delete)
[docs] def get_time_span(self, kinds=None, tight=True, dummy_limits=True):
'''
Get time interval over all content in selection.
:param kinds:
If not ``None``, restrict query to given content kinds.
:type kind:
list of str
:complexity:
O(1), independent of the number of nuts.
:returns:
``(tmin, tmax)``, combined time interval of queried content kinds.
'''
sql_min = self._sql('''
SELECT MIN(tmin_seconds), MIN(tmin_offset)
FROM %(db)s.%(nuts)s
WHERE kind_id == ?
AND tmin_seconds == (
SELECT MIN(tmin_seconds)
FROM %(db)s.%(nuts)s
WHERE kind_id == ?)
''')
sql_max = self._sql('''
SELECT MAX(tmax_seconds), MAX(tmax_offset)
FROM %(db)s.%(nuts)s
WHERE kind_id == ?
AND tmax_seconds == (
SELECT MAX(tmax_seconds)
FROM %(db)s.%(nuts)s
WHERE kind_id == ?)
''')
gtmin = None
gtmax = None
if isinstance(kinds, str):
kinds = [kinds]
if kinds is None:
kind_ids = model.g_content_kind_ids
else:
kind_ids = model.to_kind_ids(kinds)
tmins = []
tmaxs = []
for kind_id in kind_ids:
for tmin_seconds, tmin_offset in self._conn.execute(
sql_min, (kind_id, kind_id)):
tmins.append(model.tjoin(tmin_seconds, tmin_offset))
for (tmax_seconds, tmax_offset) in self._conn.execute(
sql_max, (kind_id, kind_id)):
tmaxs.append(model.tjoin(tmax_seconds, tmax_offset))
tmins = [tmin if tmin != model.g_tmin else None for tmin in tmins]
tmaxs = [tmax if tmax != model.g_tmax else None for tmax in tmaxs]
if tight:
gtmin = nonef(min, tmins)
gtmax = nonef(max, tmaxs)
else:
gtmin = None if None in tmins else nonef(min, tmins)
gtmax = None if None in tmaxs else nonef(max, tmaxs)
if dummy_limits:
if gtmin is None:
gtmin = model.g_tmin
if gtmax is None:
gtmax = model.g_tmax
return gtmin, gtmax
[docs] def has(self, kinds):
'''
Check availability of given content kinds.
:param kinds:
Content kinds to query.
:type kind:
list of str
:returns:
``True`` if any of the queried content kinds is available
in the selection.
'''
self_tmin, self_tmax = self.get_time_span(
kinds, dummy_limits=False)
return None not in (self_tmin, self_tmax)
[docs] def get_deltat_span(self, kind):
'''
Get min and max sampling interval of all content of given kind.
:param kind:
Content kind
:type kind:
str
:returns: ``(deltat_min, deltat_max)``
'''
deltats = [
deltat for deltat in self.get_deltats(kind)
if deltat is not None]
if deltats:
return min(deltats), max(deltats)
else:
return None, None
[docs] def iter_kinds(self, codes=None):
'''
Iterate over content types available in selection.
:param codes:
If given, get kinds only for selected codes identifier.
Only a single identifier may be given here and no pattern matching
is done, currently.
:type codes:
:py:class:`~pyrocko.squirrel.model.Codes`
:yields:
Available content kinds as :py:class:`str`.
:complexity:
O(1), independent of number of nuts.
'''
return self._database._iter_kinds(
codes=codes,
kind_codes_count='%(db)s.%(kind_codes_count)s' % self._names)
[docs] def iter_deltats(self, kind=None):
'''
Iterate over sampling intervals available in selection.
:param kind:
If given, get sampling intervals only for a given content type.
:type kind:
str
:yields:
:py:class:`float` values.
:complexity:
O(1), independent of number of nuts.
'''
return self._database._iter_deltats(
kind=kind,
kind_codes_count='%(db)s.%(kind_codes_count)s' % self._names)
[docs] def iter_codes(self, kind=None):
'''
Iterate over content identifier code sequences available in selection.
:param kind:
If given, get codes only for a given content type.
:type kind:
str
:yields:
:py:class:`tuple` of :py:class:`str`
:complexity:
O(1), independent of number of nuts.
'''
return self._database._iter_codes(
kind=kind,
kind_codes_count='%(db)s.%(kind_codes_count)s' % self._names)
def _iter_codes_info(self, kind=None, codes=None):
'''
Iterate over number of occurrences of any (kind, codes) combination.
:param kind:
If given, get counts only for selected content type.
:type kind:
str
:yields:
Tuples of the form ``(kind, codes, deltat, kind_codes_id, count)``.
:complexity:
O(1), independent of number of nuts.
'''
return self._database._iter_codes_info(
kind=kind,
codes=codes,
kind_codes_count='%(db)s.%(kind_codes_count)s' % self._names)
[docs] def get_kinds(self, codes=None):
'''
Get content types available in selection.
:param codes:
If given, get kinds only for selected codes identifier.
Only a single identifier may be given here and no pattern matching
is done, currently.
:type codes:
:py:class:`~pyrocko.squirrel.model.Codes`
:returns:
Sorted list of available content types.
:rtype:
py:class:`list` of :py:class:`str`
:complexity:
O(1), independent of number of nuts.
'''
return sorted(list(self.iter_kinds(codes=codes)))
[docs] def get_deltats(self, kind=None):
'''
Get sampling intervals available in selection.
:param kind:
If given, get sampling intervals only for selected content type.
:type kind:
str
:complexity:
O(1), independent of number of nuts.
:returns: Sorted list of available sampling intervals.
'''
return sorted(list(self.iter_deltats(kind=kind)))
[docs] def get_codes(self, kind=None):
'''
Get identifier code sequences available in selection.
:param kind:
If given, get codes only for selected content type.
:type kind:
str
:complexity:
O(1), independent of number of nuts.
:returns: Sorted list of available codes as tuples of strings.
'''
return sorted(list(self.iter_codes(kind=kind)))
[docs] def get_counts(self, kind=None):
'''
Get number of occurrences of any (kind, codes) combination.
:param kind:
If given, get codes only for selected content type.
:type kind:
str
:complexity:
O(1), independent of number of nuts.
:returns: ``dict`` with ``counts[kind][codes]`` or ``counts[codes]``
if kind is not ``None``
'''
d = {}
for kind_id, codes, _, _, count in self._iter_codes_info(kind=kind):
if kind_id not in d:
v = d[kind_id] = {}
else:
v = d[kind_id]
if codes not in v:
v[codes] = 0
v[codes] += count
if kind is not None:
return d[to_kind_id(kind)]
else:
return dict((to_kind(kind_id), v) for (kind_id, v) in d.items())
[docs] def glob_codes(self, kind, codes):
'''
Find codes matching given patterns.
:param kind:
Content kind to be queried.
:type kind:
str
:param codes:
List of code patterns to query.
:type codes:
:py:class:`list` of :py:class:`~pyrocko.squirrel.model.Codes`
objects appropriate for the queried content type, or anything which
can be converted to such objects.
:returns:
List of matches of the form ``[kind_codes_id, codes, deltat]``.
'''
kind_id = to_kind_id(kind)
args = [kind_id]
pats = codes_patterns_for_kind(kind_id, codes)
if pats:
codes_cond = 'AND ( %s ) ' % ' OR '.join(
('kind_codes.codes GLOB ?',) * len(pats))
args.extend(pat.safe_str for pat in pats)
else:
codes_cond = ''
sql = self._sql('''
SELECT kind_codes_id, codes, deltat FROM kind_codes
WHERE
kind_id == ? ''' + codes_cond)
return list(map(list, self._conn.execute(sql, args)))
[docs] def update(self, constraint=None, **kwargs):
'''
Update or partially update channel and event inventories.
:param constraint:
Selection of times or areas to be brought up to date.
:type constraint:
:py:class:`~pyrocko.squirrel.client.base.Constraint`
:param \\*\\*kwargs:
Shortcut for setting ``constraint=Constraint(**kwargs)``.
This function triggers all attached remote sources, to check for
updates in the meta-data. The sources will only submit queries when
their expiration date has passed, or if the selection spans into
previously unseen times or areas.
'''
if constraint is None:
constraint = client.Constraint(**kwargs)
task = make_task('Updating sources')
for source in task(self._sources):
source.update_channel_inventory(self, constraint)
source.update_event_inventory(self, constraint)
def update_responses(self, constraint=None, **kwargs):
if constraint is None:
constraint = client.Constraint(**kwargs)
for source in self._sources:
source.update_response_inventory(self, constraint)
[docs] def get_nfiles(self):
'''
Get number of files in selection.
'''
sql = self._sql('''SELECT COUNT(*) FROM %(db)s.%(file_states)s''')
for row in self._conn.execute(sql):
return row[0]
[docs] def get_nnuts(self):
'''
Get number of nuts in selection.
'''
sql = self._sql('''SELECT COUNT(*) FROM %(db)s.%(nuts)s''')
for row in self._conn.execute(sql):
return row[0]
[docs] def get_total_size(self):
'''
Get aggregated file size available in selection.
'''
sql = self._sql('''
SELECT SUM(files.size) FROM %(db)s.%(file_states)s
INNER JOIN files
ON %(db)s.%(file_states)s.file_id = files.file_id
''')
for row in self._conn.execute(sql):
return row[0] or 0
[docs] def get_stats(self):
'''
Get statistics on contents available through this selection.
'''
kinds = self.get_kinds()
time_spans = {}
for kind in kinds:
time_spans[kind] = self.get_time_span([kind])
return SquirrelStats(
nfiles=self.get_nfiles(),
nnuts=self.get_nnuts(),
kinds=kinds,
codes=self.get_codes(),
total_size=self.get_total_size(),
counts=self.get_counts(),
time_spans=time_spans,
sources=[s.describe() for s in self._sources],
operators=[op.describe() for op in self._operators])
[docs] @filldocs
def check(
self, obj=None, tmin=None, tmax=None, time=None, codes=None,
ignore=[]):
'''
Check for common data/metadata problems.
%(query_args)s
:param ignore:
Problem types to be ignored.
:type ignore:
:class:`list` of :class:`str`
(:py:class:`~pyrocko.squirrel.check.SquirrelCheckProblemType`)
:returns:
:py:class:`~pyrocko.squirrel.check.SquirrelCheck` object
containing the results of the check.
See :py:func:`~pyrocko.squirrel.check.do_check`.
'''
from .check import do_check
tmin, tmax, codes = self._get_selection_args(
CHANNEL, obj, tmin, tmax, time, codes)
return do_check(self, tmin=tmin, tmax=tmax, codes=codes, ignore=ignore)
[docs] def get_content(
self,
nut,
cache_id='default',
accessor_id='default',
show_progress=False,
model='squirrel'):
'''
Get and possibly load full content for a given index entry from file.
Loads the actual content objects (channel, station, waveform, ...) from
file. For efficiency, sibling content (all stuff in the same file
segment) will also be loaded as a side effect. The loaded contents are
cached in the Squirrel object.
'''
content_cache = self._content_caches[cache_id]
if not content_cache.has(nut):
for nut_loaded in io.iload(
nut.file_path,
segment=nut.file_segment,
format=nut.file_format,
database=self._database,
update_selection=self,
show_progress=show_progress):
content_cache.put(nut_loaded)
try:
return content_cache.get(nut, accessor_id, model)
except KeyError:
raise error.NotAvailable(
'Unable to retrieve content: %s, %s, %s, %s' % nut.key)
[docs] def advance_accessor(self, accessor_id='default', cache_id=None):
'''
Notify memory caches about consumer moving to a new data batch.
:param accessor_id:
Name of accessing consumer to be advanced.
:type accessor_id:
str
:param cache_id:
Name of cache to for which the accessor should be advanced. By
default the named accessor is advanced in all registered caches.
By default, two caches named ``'default'`` and ``'waveform'`` are
available.
:type cache_id:
str
See :py:class:`~pyrocko.squirrel.cache.ContentCache` for details on how
Squirrel's memory caching works and can be tuned. Default behaviour is
to release data when it has not been used in the latest data
window/batch. If the accessor is never advanced, data is cached
indefinitely - which is often desired e.g. for station meta-data.
Methods for consecutive data traversal, like
:py:meth:`chopper_waveforms` automatically advance and clear
their accessor.
'''
for cache_ in (
self._content_caches.keys()
if cache_id is None
else [cache_id]):
self._content_caches[cache_].advance_accessor(accessor_id)
[docs] def clear_accessor(self, accessor_id, cache_id=None):
'''
Notify memory caches about a consumer having finished.
:param accessor_id:
Name of accessor to be cleared.
:type accessor_id:
str
:param cache_id:
Name of cache for which the accessor should be cleared. By default
the named accessor is cleared from all registered caches. By
default, two caches named ``'default'`` and ``'waveform'`` are
available.
:type cache_id:
str
Calling this method clears all references to cache entries held by the
named accessor. Cache entries are then freed if not referenced by any
other accessor.
'''
for cache_ in (
self._content_caches.keys()
if cache_id is None
else [cache_id]):
self._content_caches[cache_].clear_accessor(accessor_id)
def get_cache_stats(self, cache_id):
return self._content_caches[cache_id].get_stats()
[docs] @filldocs
def get_stations(
self, obj=None, tmin=None, tmax=None, time=None, codes=None,
model='squirrel', on_error='raise'):
'''
Get stations matching given constraints.
%(query_args)s
:param model:
Select object model for returned values: ``'squirrel'`` to get
Squirrel station objects or ``'pyrocko'`` to get Pyrocko station
objects with channel information attached.
:type model:
str
:returns:
List of :py:class:`pyrocko.squirrel.Station
<pyrocko.squirrel.model.Station>` objects by default or list of
:py:class:`pyrocko.model.Station <pyrocko.model.station.Station>`
objects if ``model='pyrocko'`` is requested.
See :py:meth:`iter_nuts` for details on time span matching.
'''
if model == 'pyrocko':
return self._get_pyrocko_stations(
obj, tmin, tmax, time, codes, on_error=on_error)
elif model in ('squirrel', 'stationxml', 'stationxml+'):
args = self._get_selection_args(
STATION, obj, tmin, tmax, time, codes)
nuts = sorted(
self.iter_nuts('station', *args), key=lambda nut: nut.dkey)
return [self.get_content(nut, model=model) for nut in nuts]
else:
raise ValueError('Invalid station model: %s' % model)
[docs] @filldocs
def get_channels(
self, obj=None, tmin=None, tmax=None, time=None, codes=None,
model='squirrel'):
'''
Get channels matching given constraints.
%(query_args)s
:returns:
List of :py:class:`~pyrocko.squirrel.model.Channel` objects.
See :py:meth:`iter_nuts` for details on time span matching.
'''
args = self._get_selection_args(
CHANNEL, obj, tmin, tmax, time, codes)
nuts = sorted(
self.iter_nuts('channel', *args), key=lambda nut: nut.dkey)
return [self.get_content(nut, model=model) for nut in nuts]
[docs] @filldocs
def get_sensors(
self, obj=None, tmin=None, tmax=None, time=None, codes=None):
'''
Get sensors matching given constraints.
%(query_args)s
:returns:
List of :py:class:`~pyrocko.squirrel.model.Sensor` objects.
See :py:meth:`iter_nuts` for details on time span matching.
'''
tmin, tmax, codes = self._get_selection_args(
CHANNEL, obj, tmin, tmax, time, codes)
if codes is not None:
codes = codes_patterns_list(
(entry.replace(channel=entry.channel[:-1] + '?')
if entry.channel != '*' else entry)
for entry in codes)
nuts = sorted(
self.iter_nuts(
'channel', tmin, tmax, codes), key=lambda nut: nut.dkey)
return [
sensor for sensor in model.Sensor.from_channels(
self.get_content(nut) for nut in nuts)
if match_time_span(tmin, tmax, sensor)]
[docs] @filldocs
def get_responses(
self, obj=None, tmin=None, tmax=None, time=None, codes=None,
model='squirrel'):
'''
Get instrument responses matching given constraints.
%(query_args)s
:param model:
Select data model for returned objects. Choices: ``'squirrel'``,
``'stationxml'``, ``'stationxml+'``. See return value description.
:type model:
str
:returns:
List of :py:class:`~pyrocko.squirrel.model.Response` if ``model ==
'squirrel'`` or list of
:py:class:`~pyrocko.io.stationxml.FDSNStationXML`
if ``model == 'stationxml'`` or list of
(:py:class:`~pyrocko.squirrel.model.Response`,
:py:class:`~pyrocko.io.stationxml.FDSNStationXML`) if ``model ==
'stationxml+'``.
See :py:meth:`iter_nuts` for details on time span matching.
'''
args = self._get_selection_args(
RESPONSE, obj, tmin, tmax, time, codes)
nuts = sorted(
self.iter_nuts('response', *args), key=lambda nut: nut.dkey)
return [self.get_content(nut, model=model) for nut in nuts]
[docs] @filldocs
def get_response(
self, obj=None, tmin=None, tmax=None, time=None, codes=None,
model='squirrel', on_duplicate='raise'):
'''
Get instrument response matching given constraints.
%(query_args)s
:param model:
Select data model for returned object. Choices: ``'squirrel'``,
``'stationxml'``, ``'stationxml+'``. See return value description.
:type model:
str
:param on_duplicate:
Determines how duplicates/multiple matching responses are handled.
Choices: ``'raise'`` - raise
:py:exc:`~pyrocko.squirrel.error.Duplicate`, ``'warn'`` - emit a
warning and return first match, ``'ignore'`` - silently return
first match.
:type on_duplicate:
str
:returns:
:py:class:`~pyrocko.squirrel.model.Response` if
``model == 'squirrel'`` or
:py:class:`~pyrocko.io.stationxml.FDSNStationXML` if ``model ==
'stationxml'`` or
(:py:class:`~pyrocko.squirrel.model.Response`,
:py:class:`~pyrocko.io.stationxml.FDSNStationXML`) if ``model ==
'stationxml+'``.
Same as :py:meth:`get_responses` but returning exactly one response.
Raises :py:exc:`~pyrocko.squirrel.error.NotAvailable` if none is
available. Duplicates are handled according to the ``on_duplicate``
argument.
See :py:meth:`iter_nuts` for details on time span matching.
'''
if model == 'stationxml':
model_ = 'stationxml+'
else:
model_ = model
responses = self.get_responses(
obj, tmin, tmax, time, codes, model=model_)
if len(responses) == 0:
raise error.NotAvailable(
'No instrument response available (%s).'
% self._get_selection_args_str(
RESPONSE, obj, tmin, tmax, time, codes))
elif len(responses) > 1:
if on_duplicate in ('raise', 'warn'):
if model_ == 'squirrel':
resps_sq = responses
elif model_ == 'stationxml+':
resps_sq = [resp[0] for resp in responses]
else:
raise ValueError('Invalid response model: %s' % model)
rinfo = ':\n' + '\n'.join(
' ' + resp.summary for resp in resps_sq)
message = \
'Multiple instrument responses matching given ' \
'constraints (%s)%s%s' % (
self._get_selection_args_str(
RESPONSE, obj, tmin, tmax, time, codes),
' -> using first' if on_duplicate == 'warn' else '',
rinfo)
if on_duplicate == 'raise':
raise error.Duplicate(message)
elif on_duplicate == 'warn':
logger.warning(message)
elif on_duplicate == 'ignore':
pass
else:
ValueError(
'Invalid argument for on_duplicate: %s' % on_duplicate)
if model == 'stationxml':
return responses[0][1]
else:
return responses[0]
[docs] @filldocs
def get_events(
self, obj=None, tmin=None, tmax=None, time=None, codes=None):
'''
Get events matching given constraints.
%(query_args)s
:returns:
List of :py:class:`~pyrocko.model.event.Event` objects.
See :py:meth:`iter_nuts` for details on time span matching.
'''
args = self._get_selection_args(EVENT, obj, tmin, tmax, time, codes)
nuts = sorted(
self.iter_nuts('event', *args), key=lambda nut: nut.dkey)
return [self.get_content(nut) for nut in nuts]
def _redeem_promises(self, *args, order_only=False):
def split_promise(order, tmax=None):
self._split_nuts(
'waveform_promise',
order.tmin, tmax if tmax is not None else order.tmax,
codes=order.codes,
path=order.source_id)
tmin, tmax = args[:2]
waveforms = list(self.iter_nuts('waveform', *args))
promises = list(self.iter_nuts('waveform_promise', *args))
codes_to_avail = defaultdict(list)
for nut in waveforms:
codes_to_avail[nut.codes].append((nut.tmin, nut.tmax))
def tts(x):
if isinstance(x, tuple):
return tuple(tts(e) for e in x)
elif isinstance(x, list):
return list(tts(e) for e in x)
else:
return util.time_to_str(x)
now = time.time()
orders = []
for promise in promises:
waveforms_avail = codes_to_avail[promise.codes]
for block_tmin, block_tmax in blocks(
max(tmin, promise.tmin),
min(tmax, promise.tmax),
promise.deltat):
if block_tmin > now:
continue
orders.append(
WaveformOrder(
source_id=promise.file_path,
codes=promise.codes,
tmin=block_tmin,
tmax=block_tmax,
deltat=promise.deltat,
gaps=gaps(waveforms_avail, block_tmin, block_tmax),
time_created=now))
orders_noop, orders = lpick(lambda order: order.gaps, orders)
order_keys_noop = set(order_key(order) for order in orders_noop)
if len(order_keys_noop) != 0 or len(orders_noop) != 0:
logger.info(
'Waveform orders already satisified with cached/local data: '
'%i (%i)' % (len(order_keys_noop), len(orders_noop)))
for order in orders_noop:
split_promise(order)
if order_only:
if orders:
self._pending_orders.extend(orders)
logger.info(
'Enqueuing %i waveform order%s.'
% len_plural(orders))
return
else:
if self._pending_orders:
orders.extend(self._pending_orders)
logger.info(
'Adding %i previously enqueued order%s.'
% len_plural(self._pending_orders))
self._pending_orders = []
source_ids = []
sources = {}
for source in self._sources:
if isinstance(source, fdsn.FDSNSource):
source_ids.append(source._source_id)
sources[source._source_id] = source
source_priority = dict(
(source_id, i) for (i, source_id) in enumerate(source_ids))
order_groups = defaultdict(list)
for order in orders:
order_groups[order_key(order)].append(order)
for k, order_group in order_groups.items():
order_group.sort(
key=lambda order: source_priority[order.source_id])
n_order_groups = len(order_groups)
if len(order_groups) != 0 or len(orders) != 0:
logger.info(
'Waveform orders standing for download: %i (%i)'
% (len(order_groups), len(orders)))
task = make_task('Waveform orders processed', n_order_groups)
else:
task = None
def release_order_group(order):
okey = order_key(order)
for followup in order_groups[okey]:
if followup is not order:
split_promise(followup)
del order_groups[okey]
if task:
task.update(n_order_groups - len(order_groups))
def noop(order):
pass
def success(order, trs):
release_order_group(order)
if order.is_near_real_time():
if not trs:
return # keep promise when no data received at real time
else:
tmax = max(tr.tmax+tr.deltat for tr in trs)
tmax = order.tmin \
+ round((tmax - order.tmin) / order.deltat) \
* order.deltat
split_promise(order, tmax)
else:
split_promise(order)
def batch_add(paths):
self.add(paths)
calls = queue.Queue()
def enqueue(f):
def wrapper(*args):
calls.put((f, args))
return wrapper
while order_groups:
orders_now = []
empty = []
for k, order_group in order_groups.items():
try:
orders_now.append(order_group.pop(0))
except IndexError:
empty.append(k)
for k in empty:
del order_groups[k]
by_source_id = defaultdict(list)
for order in orders_now:
by_source_id[order.source_id].append(order)
threads = []
for source_id in by_source_id:
def download():
try:
sources[source_id].download_waveforms(
by_source_id[source_id],
success=enqueue(success),
error_permanent=enqueue(split_promise),
error_temporary=noop,
batch_add=enqueue(batch_add))
finally:
calls.put(None)
if len(by_source_id) > 1:
thread = threading.Thread(target=download)
thread.start()
threads.append(thread)
else:
download()
calls.put(None)
ndone = 0
while ndone < len(by_source_id):
ret = calls.get()
if ret is None:
ndone += 1
else:
ret[0](*ret[1])
for thread in threads:
thread.join()
if task:
task.update(n_order_groups - len(order_groups))
if task:
task.done()
def _get_waveforms_prioritized(
self, tmin=None, tmax=None, codes=None, codes_exclude=None,
channel_priorities=None, **kwargs):
trs_all = []
codes_have = set()
for channel in channel_priorities:
assert len(channel) == 2
if codes is not None:
codes_now = [
codes_.replace(channel=channel+'?') for codes_ in codes]
else:
codes_now = model.CodesNSLCE('*', '*', '*', channel+'?')
codes_exclude_now = list(set(
codes_.replace(channel=channel+codes_.channel[-1])
for codes_ in codes_have))
if codes_exclude:
codes_exclude_now.extend(codes_exclude)
trs = self.get_waveforms(
tmin=tmin,
tmax=tmax,
codes=codes_now,
codes_exclude=codes_exclude_now,
**kwargs)
codes_have.update(set(tr.codes for tr in trs))
trs_all.extend(trs)
return trs_all
def _process_chopped(
self, chopped, degap, maxgap, maxlap, want_incomplete, tmin, tmax):
chopped.sort(key=lambda a: a.full_id)
if degap:
chopped = trace.degapper(chopped, maxgap=maxgap, maxlap=maxlap)
if not want_incomplete:
chopped_weeded = []
for tr in chopped:
emin = tr.tmin - tmin
emax = tr.tmax + tr.deltat - tmax
if (abs(emin) <= 0.5*tr.deltat and abs(emax) <= 0.5*tr.deltat):
chopped_weeded.append(tr)
elif degap:
if (0. < emin <= 5. * tr.deltat
and -5. * tr.deltat <= emax < 0.):
tr.extend(tmin, tmax-tr.deltat, fillmethod='repeat')
chopped_weeded.append(tr)
chopped = chopped_weeded
return chopped
def _get_pyrocko_stations(
self, obj=None, tmin=None, tmax=None, time=None, codes=None,
on_error='raise'):
from pyrocko import model as pmodel
if codes is not None:
codes = codes_patterns_for_kind(STATION, codes)
by_nsl = defaultdict(lambda: (list(), list()))
for station in self.get_stations(obj, tmin, tmax, time, codes):
sargs = station._get_pyrocko_station_args()
by_nsl[station.codes.nsl][0].append(sargs)
if codes is not None:
codes = [model.CodesNSLCE(c) for c in codes]
for channel in self.get_channels(obj, tmin, tmax, time, codes):
sargs = channel._get_pyrocko_station_args()
sargs_list, channels_list = by_nsl[channel.codes.nsl]
sargs_list.append(sargs)
channels_list.append(channel)
pstations = []
nsls = list(by_nsl.keys())
nsls.sort()
for nsl in nsls:
sargs_list, channels_list = by_nsl[nsl]
sargs = util.consistency_merge(
[('',) + x for x in sargs_list],
error=on_error)
by_c = defaultdict(list)
for ch in channels_list:
by_c[ch.codes.channel].append(ch._get_pyrocko_channel_args())
chas = list(by_c.keys())
chas.sort()
pchannels = []
for cha in chas:
list_of_cargs = by_c[cha]
cargs = util.consistency_merge(
[('',) + x for x in list_of_cargs],
error=on_error)
pchannels.append(pmodel.Channel(*cargs))
pstations.append(
pmodel.Station(*sargs, channels=pchannels))
return pstations
@property
def pile(self):
'''
Emulates the older :py:class:`pyrocko.pile.Pile` interface.
This property exposes a :py:class:`pyrocko.squirrel.pile.Pile` object,
which emulates most of the older :py:class:`pyrocko.pile.Pile` methods
but uses the fluffy power of the Squirrel under the hood.
This interface can be used as a drop-in replacement for piles which are
used in existing scripts and programs for efficient waveform data
access. The Squirrel-based pile scales better for large datasets. Newer
scripts should use Squirrel's native methods to avoid the emulation
overhead.
'''
from . import pile
if self._pile is None:
self._pile = pile.Pile(self)
return self._pile
[docs] def snuffle(self, **kwargs):
'''
Look at dataset in Snuffler.
'''
self.pile.snuffle(**kwargs)
def _gather_codes_keys(self, kind, gather, selector):
return set(
gather(codes)
for codes in self.iter_codes(kind)
if selector is None or selector(codes))
def __str__(self):
return str(self.get_stats())
[docs] def get_coverage(
self, kind, tmin=None, tmax=None, codes=None, limit=None):
'''
Get coverage information.
Get information about strips of gapless data coverage.
:param kind:
Content kind to be queried.
:type kind:
str
:param tmin:
Start time of query interval.
:type tmin:
:py:func:`~pyrocko.util.get_time_float`
:param tmax:
End time of query interval.
:type tmax:
:py:func:`~pyrocko.util.get_time_float`
:param codes:
If given, restrict query to given content codes patterns.
:type codes:
:py:class:`list` of :py:class:`~pyrocko.squirrel.model.Codes`
objects appropriate for the queried content type, or anything which
can be converted to such objects.
:param limit:
Limit query to return only up to a given maximum number of entries
per matching time series (without setting this option, very gappy
data could cause the query to execute for a very long time).
:type limit:
int
:returns:
Information about time spans covered by the requested time series
data.
:rtype:
:py:class:`list` of :py:class:`~pyrocko.squirrel.model.Coverage`
'''
tmin_seconds, tmin_offset = model.tsplit(tmin)
tmax_seconds, tmax_offset = model.tsplit(tmax)
kind_id = to_kind_id(kind)
codes_info = list(self._iter_codes_info(kind=kind))
kdata_all = []
if codes is None:
for _, codes_entry, deltat, kind_codes_id, _ in codes_info:
kdata_all.append(
(codes_entry, kind_codes_id, codes_entry, deltat))
else:
for codes_entry in codes:
pattern = to_codes(kind_id, codes_entry)
for _, codes_entry, deltat, kind_codes_id, _ in codes_info:
if model.match_codes(pattern, codes_entry):
kdata_all.append(
(pattern, kind_codes_id, codes_entry, deltat))
kind_codes_ids = [x[1] for x in kdata_all]
counts_at_tmin = {}
if tmin is not None:
for nut in self.iter_nuts(
kind, tmin, tmin, kind_codes_ids=kind_codes_ids):
k = nut.codes, nut.deltat
if k not in counts_at_tmin:
counts_at_tmin[k] = 0
counts_at_tmin[k] += 1
coverages = []
for pattern, kind_codes_id, codes_entry, deltat in kdata_all:
entry = [pattern, codes_entry, deltat, None, None, []]
for i, order in [(0, 'ASC'), (1, 'DESC')]:
sql = self._sql('''
SELECT
time_seconds,
time_offset
FROM %(db)s.%(coverage)s
WHERE
kind_codes_id == ?
ORDER BY
kind_codes_id ''' + order + ''',
time_seconds ''' + order + ''',
time_offset ''' + order + '''
LIMIT 1
''')
for row in self._conn.execute(sql, [kind_codes_id]):
entry[3+i] = model.tjoin(row[0], row[1])
if None in entry[3:5]:
continue
args = [kind_codes_id]
sql_time = ''
if tmin is not None:
# intentionally < because (== tmin) is queried from nuts
sql_time += ' AND ( ? < time_seconds ' \
'OR ( ? == time_seconds AND ? < time_offset ) ) '
args.extend([tmin_seconds, tmin_seconds, tmin_offset])
if tmax is not None:
sql_time += ' AND ( time_seconds < ? ' \
'OR ( ? == time_seconds AND time_offset <= ? ) ) '
args.extend([tmax_seconds, tmax_seconds, tmax_offset])
sql_limit = ''
if limit is not None:
sql_limit = ' LIMIT ?'
args.append(limit)
sql = self._sql('''
SELECT
time_seconds,
time_offset,
step
FROM %(db)s.%(coverage)s
WHERE
kind_codes_id == ?
''' + sql_time + '''
ORDER BY
kind_codes_id,
time_seconds,
time_offset
''' + sql_limit)
rows = list(self._conn.execute(sql, args))
if limit is not None and len(rows) == limit:
entry[-1] = None
else:
counts = counts_at_tmin.get((codes_entry, deltat), 0)
tlast = None
if tmin is not None:
entry[-1].append((tmin, counts))
tlast = tmin
for row in rows:
t = model.tjoin(row[0], row[1])
counts += row[2]
entry[-1].append((t, counts))
tlast = t
if tmax is not None and (tlast is None or tlast != tmax):
entry[-1].append((tmax, counts))
coverages.append(model.Coverage.from_values(entry + [kind_id]))
return coverages
[docs] def get_stationxml(
self, obj=None, tmin=None, tmax=None, time=None, codes=None,
level='response', on_error='raise'):
'''
Get station/channel/response metadata in StationXML representation.
%(query_args)s
:returns:
:py:class:`~pyrocko.io.stationxml.FDSNStationXML` object.
'''
if level not in ('network', 'station', 'channel', 'response'):
raise ValueError('Invalid level: %s' % level)
tmin, tmax, codes = self._get_selection_args(
CHANNEL, obj, tmin, tmax, time, codes)
def tts(t):
if t is None:
return '<none>'
else:
return util.tts(t, format='%Y-%m-%d %H:%M:%S')
if on_error == 'ignore':
def handle_error(exc):
pass
elif on_error == 'warn':
def handle_error(exc):
logger.warning(str(exc))
elif on_error == 'raise':
def handle_error(exc):
raise exc
def use_first(node_type_name, codes, k, group):
if on_error == 'warn':
logger.warning(
'Duplicates for %s %s, %s - %s -> using first' % (
node_type_name,
'.'.join(codes),
tts(k[0]), tts(k[1])))
return group[0]
def deduplicate(node_type_name, codes, nodes):
groups = defaultdict(list)
for node in nodes:
k = (node.start_date, node.end_date)
groups[k].append(node)
return [
use_first(node_type_name, codes, k, group)
for (k, group) in groups.items()]
filtering = CodesPatternFiltering(codes=codes)
nslcs = list(set(
codes.nslc for codes in
filtering.filter(self.get_codes(kind='channel'))))
from pyrocko.io import stationxml as sx
networks = []
for net, stas in prefix_tree(nslcs):
network = sx.Network(code=net)
networks.append(network)
if level not in ('station', 'channel', 'response'):
continue
for sta, locs in stas:
stations = self.get_stations(
tmin=tmin,
tmax=tmax,
codes=(net, sta, '*'),
model='stationxml')
if on_error != 'raise':
stations = deduplicate(
'Station', (net, sta), stations)
errors = sx.check_overlaps(
'Station', (net, sta), stations)
if errors:
handle_error(error.Duplicate(
'Overlapping/duplicate station info:\n %s'
% '\n '.join(errors)))
network.station_list.extend(stations)
if level not in ('channel', 'response'):
continue
for loc, chas in locs:
for cha, _ in chas:
channels = self.get_channels(
tmin=tmin,
tmax=tmax,
codes=(net, sta, loc, cha),
model='stationxml')
if on_error != 'raise':
channels = deduplicate(
'Channel', (net, sta, loc, cha), channels)
errors = sx.check_overlaps(
'Channel', (net, sta, loc, cha), channels)
if errors:
handle_error(error.Duplicate(
'Overlapping/duplicate channel info:\n %s'
% '\n '.join(errors)))
for channel in channels:
station = sx.find_containing(stations, channel)
if station is not None:
station.channel_list.append(channel)
else:
handle_error(error.NotAvailable(
'No station or station epoch found '
'for channel: %s' % '.'.join(
(net, sta, loc, cha))))
continue
if level != 'response':
continue
try:
response_sq, response_sx = self.get_response(
codes=(net, sta, loc, cha),
tmin=channel.start_date,
tmax=channel.end_date,
model='stationxml+',
on_duplicate=on_error)
except error.NotAvailable as e:
handle_error(e)
continue
if not (
sx.eq_open(
channel.start_date, response_sq.tmin)
and sx.eq_open(
channel.end_date, response_sq.tmax)):
handle_error(error.Inconsistencies(
'Response time span does not match '
'channel time span: %s' % '.'.join(
(net, sta, loc, cha))))
channel.response = response_sx
return sx.FDSNStationXML(
source='Generated by Pyrocko Squirrel.',
network_list=networks)
def add_operator(self, op):
self._operators.append(op)
def update_operator_mappings(self):
available = self.get_codes(kind=('channel'))
for operator in self._operators:
operator.update_mappings(available, self._operator_registry)
def iter_operator_mappings(self):
for operator in self._operators:
for in_codes, out_codes in operator.iter_mappings():
yield operator, in_codes, out_codes
def get_operator_mappings(self):
return list(self.iter_operator_mappings())
def get_operator(self, codes):
try:
return self._operator_registry[codes][0]
except KeyError:
return None
def get_operator_group(self, codes):
try:
return self._operator_registry[codes]
except KeyError:
return None, (None, None, None)
def iter_operator_codes(self):
for _, _, out_codes in self.iter_operator_mappings():
for codes in out_codes:
yield codes
def get_operator_codes(self):
return list(self.iter_operator_codes())
[docs] def print_tables(self, table_names=None, stream=None):
'''
Dump raw database tables in textual form (for debugging purposes).
:param table_names:
Names of tables to be dumped or ``None`` to dump all.
:type table_names:
:py:class:`list` of :py:class:`str`
:param stream:
Open file or ``None`` to dump to standard output.
'''
if stream is None:
stream = sys.stdout
if isinstance(table_names, str):
table_names = [table_names]
if table_names is None:
table_names = [
'selection_file_states',
'selection_nuts',
'selection_kind_codes_count',
'files', 'nuts', 'kind_codes', 'kind_codes_count']
m = {
'selection_file_states': '%(db)s.%(file_states)s',
'selection_nuts': '%(db)s.%(nuts)s',
'selection_kind_codes_count': '%(db)s.%(kind_codes_count)s',
'files': 'files',
'nuts': 'nuts',
'kind_codes': 'kind_codes',
'kind_codes_count': 'kind_codes_count'}
for table_name in table_names:
self._database.print_table(
m[table_name] % self._names, stream=stream)
[docs]class SquirrelStats(Object):
'''
Container to hold statistics about contents available from a Squirrel.
See also :py:meth:`Squirrel.get_stats`.
'''
nfiles = Int.T(
help='Number of files in selection.')
nnuts = Int.T(
help='Number of index nuts in selection.')
codes = List.T(
Tuple.T(content_t=String.T()),
help='Available code sequences in selection, e.g. '
'(agency, network, station, location) for stations nuts.')
kinds = List.T(
String.T(),
help='Available content types in selection.')
total_size = Int.T(
help='Aggregated file size of files is selection.')
counts = Dict.T(
String.T(), Dict.T(Tuple.T(content_t=String.T()), Int.T()),
help='Breakdown of how many nuts of any content type and code '
'sequence are available in selection, ``counts[kind][codes]``.')
time_spans = Dict.T(
String.T(), Tuple.T(content_t=Timestamp.T()),
help='Time spans by content type.')
sources = List.T(
String.T(),
help='Descriptions of attached sources.')
operators = List.T(
String.T(),
help='Descriptions of attached operators.')
def __str__(self):
kind_counts = dict(
(kind, sum(self.counts[kind].values())) for kind in self.kinds)
scodes = model.codes_to_str_abbreviated(self.codes)
ssources = '<none>' if not self.sources else '\n' + '\n'.join(
' ' + s for s in self.sources)
soperators = '<none>' if not self.operators else '\n' + '\n'.join(
' ' + s for s in self.operators)
def stime(t):
return util.tts(t) if t is not None and t not in (
model.g_tmin, model.g_tmax) else '<none>'
def stable(rows):
ns = [max(len(w) for w in col) for col in zip(*rows)]
return '\n'.join(
' '.join(w.ljust(n) for n, w in zip(ns, row))
for row in rows)
def indent(s):
return '\n'.join(' '+line for line in s.splitlines())
stspans = '<none>' if not self.kinds else '\n' + indent(stable([(
kind + ':',
str(kind_counts[kind]),
stime(self.time_spans[kind][0]),
'-',
stime(self.time_spans[kind][1])) for kind in sorted(self.kinds)]))
s = '''
Number of files: %i
Total size of known files: %s
Number of index nuts: %i
Available content kinds: %s
Available codes: %s
Sources: %s
Operators: %s''' % (
self.nfiles,
util.human_bytesize(self.total_size),
self.nnuts,
stspans, scodes, ssources, soperators)
return s.lstrip()
__all__ = [
'Squirrel',
'SquirrelStats',
]
