Development documentation · 0.2.3 30c2f8ba · Intro examples tested with 0.2.3 · Version details · Known limitations

Read and write data#

Use a reader that matches the file’s schema and the class of data it contains. The I/O capability catalogue lists supported classes, formats, optional dependencies, time interpretation, and metadata retention.

Read an ndscope file#

from gwexpy.timeseries import TimeSeriesDict

data = TimeSeriesDict.read("measurement.h5", format="hdf.ndscope")

Follow the Commissioner tutorial for a downloadable sample, interval selection, ASD/coherence, and saved analysis conditions.

Read DiagGUI time-series products#

data = TimeSeriesDict.read("measurement.xml", format="xml.diaggui", products="TS")

Specify products explicitly. This example requires saved time-series data; a saved spectral or transfer-function result is a different product. See the DTT workflow for response data.

Preserve data and metadata#

data.write("analysis.h5", format="hdf5", overwrite=True)
restored = TimeSeriesDict.read("analysis.h5", format="hdf5")

Choose HDF5 provenance when you need an example of recording origin and processing history. Check the capabilities of the specific writer before choosing an exchange format.

Detailed capabilities#

The former catalogue sections remain available through these links.

Catalogue sections