Skip to main content

seagliderOG1

PyPI Python versions License: MIT Tests Documentation DOI

seagliderOG1 converts Seaglider basestation files (pSSSDDDD*.nc) into OceanGliders OG1 format. One mission in, one OG1 file out; the platform, contributor and institution metadata come from a mission.yaml you keep with your data, never from defaults inside the package. Based on votoutils' convert_to_og1.

Install

pip install seagliderOG1
# or from source
pip install git+https://github.com/ocean-uhh/seagliderOG1.git

Quick start

seagliderOG1 draft --raw-dir /data/005/20080606             # see the data first: a draft page, no config
seagliderOG1 init sg005.yaml --raw-dir /data/005/20080606   # template from the first file
seagliderOG1 validate sg005.yaml                            # config, raw_dir, dive range
seagliderOG1 process  sg005.yaml                            # -> <output_dir>/<id>.nc
seagliderOG1 report   <output_dir>/<id>.nc                  # the conversion page

For a root of SN/DATE mission directories, point --raw-dir at the root and select with --all or --mission GLOB; -n previews without writing. mission.yaml holds the raw-data directory (raw_dir), output directory, dive range, platform block, and the contributor and institution records; paths in it resolve relative to the file.

Python

from seagliderOG1 import convert, readers, writers

datasets = readers.read_mission(source, first, last)
ds = convert.to_og1(
    datasets,
    contributors=[{"name": "Jane Doe", "role": "PI", "email": "jane@example.org"}],
    institutions=[{"name": "University of Hamburg", "role": "Operator"}],
)
writers.write(ds, out)

contributors and institutions are lists of records, one entry per person (or institution) per role; see the CLI reference in the documentation.

Documentation

Documentation and CLI reference; the notebooks/demo.ipynb notebook is a worked example.

Acknowledgements

seagliderOG1 converts Seaglider basestation files into OceanGliders OG1 format, driven by a mission configuration the user owns. It was started at the University of Hamburg (ocean-uhh) in preparation for the DFG (Deutsche Forschungsgemeinschaft) research infrastructure Swarm of Ocean Gliders (Projektnummer 544335393).

Initial development was supported by Voice of the Ocean (VOTO) under 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, and, at the University of Hamburg, by the DFG through the PycnMix project (Projektnummer 558671572).

seagliderOG1 is an open community project; CONTRIBUTING.md covers licensing, credit and scope. Development was assisted by Claude Code (Anthropic) and GitHub Copilot code review.

License

See LICENSE for details.

Metadata

Release files for seagliderOG1 0.3.0

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

Source distribution (sdist)

Source distribution for seagliderOG1 0.3.0
File Size Uploaded Provenance Actions
seagliderog1-0.3.0.tar.gz 10.3 MB With provenance Details for seagliderog1-0.3.0.tar.gz

Built distribution (wheel)

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

Total release size: 11.9 MB

Release files / seagliderog1-0.3.0.tar.gz

Download URL seagliderog1-0.3.0.tar.gz
Size 10.3 MB
Tags Source
SHA-256 checksum
How to use checksums
fe3e4dd4468fd713045d9a7407779f7f151297d72c2e3235d2c1696126c228d8
BLAKE2b-256 checksum
How to use checksums
bf244279f49c7599a4989ba2ba58c0f089e4b54b7a325e82ced24147f8b2d252
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 6, 2026.

Transparency log

Release files / seagliderog1-0.3.0-py3-none-any.whl

Download URL seagliderog1-0.3.0-py3-none-any.whl
Size 1.6 MB
Tags Python 3
SHA-256 checksum
How to use checksums
5b75c39c775b05e978cf4c1857fa48a11c2006517581c0d22ef98fde93da2fb5
BLAKE2b-256 checksum
How to use checksums
89e89b71214337f5b8dc52310938cce0e29216e0ec60923d17c4c8dd1215149b
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 6, 2026.

Transparency log

Security for seagliderOG1 0.3.0

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 seagliderog1-0.3.0.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 6, 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