glidertest

This is a repo to diagnose issues in glider data such as CTD thermal lag.

This is a work in progress, all contributions welcome!

Install

Install from conda with

conda install --channel conda-forge glidertest

Install from PyPI with

python -m pip install glidertest

Documentation

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

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

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:

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.

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.