Coverage for /usr/local/lib/python3.11/dist-packages/pyrocko/squirrel/__init__.py: 100%

1# http://pyrocko.org - GPLv3 

2# 

3# The Pyrocko Developers, 21st Century 

4# ---|P------/S----------~Lg---------- 

5 

6''' 

7Prompt seismological data access with a fluffy tail. 

8 

9.. image:: /static/squirrel.svg 

10 :align: left 

11 

12.. raw:: html 

13 

14 <div style="clear:both"></div> 

15 

16This is the reference manual for the Squirrel framework. It describes the API 

17of the :py:mod:`pyrocko.squirrel` subpackage. For a conceptual overview see 

18:doc:`/topics/squirrel`. A tutorial describing the API usage is provided at 

19:doc:`Examples: Squirrel powered data access 

20</library/examples/squirrel/index>`. 

21 

22.. rubric:: Usage 

23 

24Public symbols implemented in the various submodules are aggregated into the 

25:py:mod:`pyrocko.squirrel` namespace for use in user programs:: 

26 

27 from pyrocko.squirrel import Squirrel 

28 

29 sq = Squirrel() 

30 

31.. rubric:: Implementation overview 

32 

33The central class and interface of the framework is 

34:py:class:`~pyrocko.squirrel.base.Squirrel`, part of it is implemented in its 

35base class :py:class:`~pyrocko.squirrel.selection.Selection`. Core 

36functionality directly talking to the database is implemented in 

37:py:mod:`~pyrocko.squirrel.base`, :py:mod:`~pyrocko.squirrel.selection` and 

38:py:mod:`~pyrocko.squirrel.database`. The data model of the framework is 

39implemented in :py:mod:`~pyrocko.squirrel.model`. User project environment 

40detection is implemented in :py:mod:`~pyrocko.squirrel.environment`. Portable 

41dataset description in :py:mod:`~pyrocko.squirrel.dataset`. A unified IO 

42interface bridging to various Pyrocko modules outside of the Squirrel framework 

43is available in :py:mod:`~pyrocko.squirrel.io`. Memory cache management is 

44implemented in :py:mod:`~pyrocko.squirrel.cache`. Compatibility with Pyrocko's 

45older waveform archive access module is implemented in 

46:py:mod:`~pyrocko.squirrel.pile`. 

47 

48''' 

49 

50 

51from . import base, selection, database, model, io, client, tool, error, \ 

52 environment, dataset, operators, check 

53 

54from .base import * # noqa 

55from .selection import * # noqa 

56from .database import * # noqa 

57from .model import * # noqa 

58from .io import * # noqa 

59from .client import * # noqa 

60from .tool import * # noqa 

61from .error import * # noqa 

62from .environment import * # noqa 

63from .dataset import * # noqa 

64from .operators import * # noqa 

65from .check import * # noqa 

66 

67__all__ = base.__all__ + selection.__all__ + database.__all__ \ 

68 + model.__all__ + io.__all__ + client.__all__ + tool.__all__ \ 

69 + error.__all__ + environment.__all__ + dataset.__all__ \ 

70 + operators.__all__ + check.__all__