GLAMOD marine processing: glamod-marine-processing toolbox

Versions
Documentation and Support
Open Source
Coding Standards
Development Status
Funding

glamod-marine-processing is a python tool for creating SLURM scripts for several GLAMOD marine processing workflows. Once installed you can use it as an command-line interface. For more information, please call the help functions:

qc_suite --help        # Quality control workflow help page
obs_suite --help       # Observations workflow help page

Installation

Before you install glamod-marine-processing please clone the GitHub repository.

git clone https://github.com/glamod/glamod-marine-processing
cd glamod-marine-processing

Now you can install several dependency versions:

pip install -e .           # Install minimum dependency version
pip install -e .[qc]       # Install optional dependencies for the quality control workflow
pip install -e .[obs]      # Install optional dependencies for the observations workflow
pip install -e .[complete]  # Install all the above for complete dependency version

This will install the package but you can still edit it and you don't need the package in your PYTHONPATH.

Documentation

The official documentation is at https://glamod-marine-processing.readthedocs.io/

Contributing to glamod-marine-processing

If you're interested in participating in the development of glamod-marine-processing by suggesting new features, new indices or report bugs, please leave us a message on the issue tracker.

If you would like to contribute code or documentation (which is greatly appreciated!), check out the Contributing Guidelines before you begin!

How to cite this library

If you wish to cite glamod-marine-processing in a research publication, we kindly ask that you refer to Zenodo: https://doi.org/10.5281/zenodo.14215566.

License

This is free software: you can redistribute it and/or modify it under the terms of the Apache License 2.0. A copy of this license is provided in the code repository (LICENSE).

Credits

glamod-marine-processing development is funded through Copernicus Climate Change Service (C3S).

Furthermore, acknowledgments go to National Oceanography Centre (NOC).

We want to thank GNU parallel for optionally using the glamod-marine-processing suite cases in parallel.

This package was created with Cookiecutter and the audreyfeldroy/cookiecutter-pypackage project template.