Reference#
Technical, information-oriented description of the GWexpy API. These pages are
generated directly from the package docstrings by autosummary and autodoc,
and describe the package used for this documentation build. Check the build information
against gwexpy.__version__ in your own environment.
Note
API reference bodies are generated from the source docstrings, which are written in English. This holds on the Japanese build of this site as well (only the surrounding navigation and page chrome are translated); translating the docstrings themselves is out of scope for now.
Public API and support#
Use documented public entry points. A generated member listing alone does not establish a supported contract. Experimental and implementation-only paths keep the status stated in their guide; pre-1.0 APIs are not universally stable. See Known limitations, I/O capabilities, and Conversion capabilities for supported classes, dependencies, and metadata boundaries.
API by domain#
TimeSeries, FrequencySeries, Spectrogram, their matrix and dictionary
forms, fields, tables, and histograms.
Spectral estimation, filtering, coupling/statistics, fitting, noise models, preprocessing, and segments.
to_*() / from_*() bridges to external scientific libraries and data models.
Multi-format readers and writers across the GW data ecosystem.
Plotting helpers, time/GPS utilities, and compatibility shims.
What GWexpy adds on top of, or changes relative to, GWpy.