What's in the Box?

The pysmo package helps seismologists write new code to processes data. It does not include any ready-made applications, but instead provides meaningful data structures that make writing code easier and more concise. Pysmo adds a layer between how data are stored and how they are processed. This makes it easy to switch between data sources, use multiple different ones simultaneously, as well as integrate with existing workflows. The pysmo package consists of:

• Pysmo types: these are protocol classes, which define the types used in pysmo. They are intentionally kept as simple as possible, and are derived from the types of data seismologists work with, rather than mirroring how data are stored in files.
• Compatible classes: while pysmo doesn't have a particular native (file)format, it does rely on the classes holding seismological data to be compatible with the types defined by pysmo. Pysmo includes a minimal implementation of such a class for each type. They include additional methods or read-only attributes for the pysmo types. These minimal classes can be used as base classes when adopting existing classes to work with pysmo types, so that they may provide the same methods.
• Functions: pysmo includes functions that perform common operations on these data types. They are meant to be building blocks that can be used to construct more complex processing algorithms.
• Tools: we place functions here that are too complex to be considered basic operations, make extensive use of other functions, or can be grouped together under a particular topic.