Data

Tools

Indexes

Applications

Experiments

Open Source Science

glidertest

Diagnostic test of glider data quality and required processing

https://github.com/oceangliderscommunity/glidertest

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (13.5%) to scientific vocabulary

Keywords

oceanography underwater-glider
Last synced: 6 months ago · JSON representation ·

Repository

Diagnostic test of glider data quality and required processing

Basic Info
Statistics
  • Stars: 1
  • Watchers: 3
  • Forks: 9
  • Open Issues: 23
  • Releases: 8
Topics
oceanography underwater-glider
Created over 1 year ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License Citation

README.md

glidertest

Glidertest is a python package for diagnosing potential issues in Ocean Gliders format glider data. Glidertest does not modify, fix or grid glider data. Functionality currently includes:

  • Checking time and depth spacing
  • Making histograms and TS diagrams
  • Checking for suspect time duration of profiles
  • Quantifying the bias between dives and climbs (profiles when the glider is going down/up)
  • Checking for sensor drift
  • Detecting quenching in chlorophyll data
  • Plotting vertical velocities

This is a work in progress, all contributions welcome!

Install

Install from conda with sh conda install --channel conda-forge glidertest

Install from PyPI with

sh python -m pip install glidertest

Documentation

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

Check out the demo notebook notebooks/demo.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.

As input, glidertest takes OceanGliders format files

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:

sh git clone https://github.com/OceanGlidersCommunity/glidertest.git cd glidertest pip install -r requirements-dev.txt pip install -e . 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:

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

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

Owner

  • Name: OceanGlidersCommunity
  • Login: OceanGlidersCommunity
  • Kind: organization

Here the https://www.oceangliders.org community shares and discusses best practices.

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: Rollo
  given-names: Callum
  orcid: https://orcid.org/0000-0002-5134-7886
  affiliation: Voice of the Ocean Foundation. Skeppet Ärans väg 19, 426 71 Västra Frölunda, Sweden
- family-names: Frajka-Williams
  given-names: Eleanor
  orcid: https://orcid.org/0000-0001-8773-7838
  affiliation: Institute of Oceanography, University of Hamburg, Bundesstraße 53, 20146 Hamburg, Germany
- family-names: Monforte
  given-names: Chiara
  orcid: https://orcid.org/0009-0003-5019-3410
  affiliation: Institute of Oceanography, University of Hamburg, Bundesstraße 53, 20146 Hamburg, Germany
- family-names: Clement
  given-names: Louis
  orcid: https://orcid.org/0000-0002-6935-9455
  affiliation: National Oceanography Centre, Southampton, UK
- family-names: Moritz
  given-names: Till
  orcid: https://orcid.org/0000-0002-7056-355X
  affiliation: Institute of Oceanography, University of Hamburg, Bundesstraße 53, 20146 Hamburg, Germany
title: glidertest
version: 0.0.1
date-released: 2024-10-28
url: https://github.com/OceanGlidersCommunity/glidertest

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 48
  • Total pull requests: 76
  • Average time to close issues: 2 months
  • Average time to close pull requests: 1 day
  • Total issue authors: 4
  • Total pull request authors: 4
  • Average comments per issue: 1.23
  • Average comments per pull request: 1.41
  • Merged pull requests: 49
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 48
  • Pull requests: 76
  • Average time to close issues: 2 months
  • Average time to close pull requests: 1 day
  • Issue authors: 4
  • Pull request authors: 4
  • Average comments per issue: 1.23
  • Average comments per pull request: 1.41
  • Merged pull requests: 49
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • MOchiara (43)
  • callumrollo (7)
  • eleanorfrajka (3)
  • tillmrtz (2)
Pull Request Authors
  • callumrollo (37)
  • MOchiara (33)
  • tillmrtz (10)
  • eleanorfrajka (4)
Top Labels
Issue Labels
documentation (4) enhancement (3) refactor (1) good first issue (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 30 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 7
  • Total maintainers: 1
pypi.org: glidertest

Diagnostic tests of glider quality

  • Documentation: https://glidertest.readthedocs.io/
  • License: MIT License Copyright (c) 2024 Callum Rollo Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  • Latest release: 0.0.2
    published about 1 year ago
  • Versions: 7
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 30 Last month
Rankings
Dependent packages count: 10.1%
Average: 33.6%
Dependent repos count: 57.1%
Maintainers (1)
callumrollo
Last synced: 6 months ago

Dependencies

pyproject.toml pypi
requirements-dev.txt pypi
  • jupyterlab * development
  • matplotlib * development
  • netcdf4 * development
  • pooch * development
  • xarray * development
requirements.txt pypi
  • netcdf4 *
  • pooch *
  • xarray *
.github/workflows/tests.yml actions
  • actions/checkout v4 composite
  • mamba-org/setup-micromamba v1 composite