Documentation version#
This site is built from the development branch. Its API reference describes the package version shown above each page, which may include unreleased changes. Latest release: 0.2.3. The introductory downloadable examples are also checked against 0.2.3.
Check the package in the environment where you run your analysis:
import gwexpy
print(gwexpy.__version__)
The commit link identifies the source used to build these pages. A local preview with uncommitted edits is labelled “local changes”. Build information in JSON format provides the package version, source revision, and introductory example target.
Use the changelog to identify changes after your installed release, and Known limitations for supported boundaries. API reference generation does not establish compatibility with every installed version.
Reproducing a result#
Keep the script or notebook, package versions, input data, channel names, time interval, sample rate, units, and spectral settings with the exported figure. The Commissioner tutorial saves these conditions alongside its plots. A saved image alone does not record the analysis settings.