Skip to main content

glidertest

glidertest reads an OceanGliders (OG1) mission file, runs a set of diagnostics on it, and shows you what is in the file. It never modifies, fixes or grids the data: the output is figures and an HTML report, the input file is left untouched. It works one mission at a time; a fleet page links the reports of many missions on one map.

There are two ways to use it: call the diagnostic functions from a notebook (glidertest.plots, glidertest.tools), or run glidertest report on a file and read the HTML.

Diagnostics include:

  • Time and depth spacing
  • Histograms and T–S diagrams
  • Suspect profile durations
  • Dive–climb bias (the difference between down and up profiles)
  • Sensor drift
  • Non-photochemical quenching in chlorophyll
  • Vertical velocities from the flight model
  • Inventory of the file: variables, sensors, attributes, and QC flags as delivered
  • Fleet page: one map and table linking many mission reports

Install

Install from PyPI with pip:

python -m pip install glidertest

or with uv:

uv pip install glidertest

HTML report

glidertest turns an OG1 mission file into a self-contained HTML report — a landing page, one page per sensor, a flight page for gliders that report one, and an inventory of the file. From Python, with a dataset open:

from glidertest import reports

reports.report(ds, "reports/")

or from the command line:

glidertest report mission.nc --report-dir reports/
glidertest navigator reports/      # rebuilds the fleet page from the reports already in reports/

See the report guide and the live demo.

Documentation

Documentation is available at https://oceangliderscommunity.github.io/glidertest/

Check out the demo notebook notebooks/demo.ipynb and notebooks/interactive.ipynb for example functionality.

The demo notebook notebooks/demo_data_issues.ipynb uses example datasets to check how glidertest can help identify and visualize problems with data.

glidertest reads OceanGliders (OG1) format files, one file per mission. Seaglider basestation files can be converted to OG1 with the seagliderOG1 package; the sample data (fetchers.load_sample_dataset()) is already OG1.

Contributing

All contributions are welcome! See contributing for more details

To install a local, development version of glidertest, clone the repo, open a terminal in the root directory (next to this readme file) and run these commands:

git clone https://github.com/OceanGlidersCommunity/glidertest.git
cd glidertest
pip install -e ".[dev]"

This installs glidertest locally. -e ensures that any edits you make in the files will be picked up by scripts that import functions from glidertest.

You can run the example jupyter notebook by launching jupyterlab with jupyter-lab and navigating to the notebooks directory.

All new functions should include tests, you can run the tests locally and generate a coverage report with:

pytest --cov=glidertest --cov-report term-missing  tests/

Try to ensure that all the lines of your contribution are covered in the tests.

Acknowledgements

glidertest began in 2024 as an OceanGliders community effort, with early development at Voice of the Ocean (VOTO) and the University of Hamburg. Its development has since been supported by VOTO through the SEA-CODE project (SeaExplorer–Seaglider Cross-platform Open Diagnostics & Evaluation), which builds platform-independent, open-source diagnostics for glider data, with glidertest and seagliderOG1 as its core packages, and supports exchanges between the University of Hamburg and VOTO. VOTO also provides the sample data.

Development at the University of Hamburg was also supported by the Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) through the PycnMix project (Projektnummer 558671572), and in preparation for the DFG research infrastructure Swarm of Ocean Gliders (Projektnummer 544335393).

glidertest is an OceanGliders community package and welcomes contributions from the community. Development was assisted by Claude Code (Anthropic) and GitHub Copilot code review.

Metadata

Release files for glidertest 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for glidertest 1.0.1
File Size Uploaded Provenance Actions
glidertest-1.0.1.tar.gz 1.0 MB With provenance Details for glidertest-1.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for glidertest 1.0.1
File Interpreter ABI Platform Actions
glidertest-1.0.1-py3-none-any.whl Python 3 none any Details for glidertest-1.0.1-py3-none-any.whl

Total release size: 1.3 MB

Release files / glidertest-1.0.1.tar.gz

Download URL glidertest-1.0.1.tar.gz
Size 1.0 MB
Tags Source
SHA-256 checksum
How to use checksums
a91e2d60f5f36caa3434783674e9e356204d0cc2cfc2ad3947904a0f5543a222
BLAKE2b-256 checksum
How to use checksums
62751c48d80aa0be892bafa143429b994735e0e4ac6f7eaae7c1404992538949
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 12, 2026.

Transparency log

Release files / glidertest-1.0.1-py3-none-any.whl

Download URL glidertest-1.0.1-py3-none-any.whl
Size 277.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
bf0f592a0417ee0f5a384e1975a2d31f5ed6dc4e8c18c3003a50ed75f88eec5c
BLAKE2b-256 checksum
How to use checksums
d234364d38cc7ece8406117fd21a558b07cc69214c74e3094bf3ee1918bec555
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 12, 2026.

Transparency log

Security for glidertest 1.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for glidertest-1.0.1.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 12, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page