marine-qc 0.3.1

Marine Quality Control package.

Versions
Documentation and Support
Open Source
Coding Standards
Development Status
Funding

Introduction

This Python package provides a set of tools for quality control (QC) of marine meteorological reports. Marine meteorological reports typically comprise latitude, longitude, time, and date as well as one or more marine meteorological variables often including, but not limited to sea-surface temperature, air temperature, dew point temperature, sea level pressure, wind speed and wind direction. Quality control is the process of identifying and flagging reports and variables within reports that are likely to be in gross error. It is important to note that QC checks do not (and cannot) identify all incorrect reports and they can also identify good reports as being erroneous.

Installation

Installation using pip

You can install the package directly from pip:

pip install marine_qc

If you want to contribute, we recommend cloning the repository and installing the package in development mode, e.g.

git clone https://github.com/glamod/marine_qc
cd marine_qc
pip install -e .

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

Installation using uv

You can install the package using uv package manager, this will add the library to your active environment:

uv add marine_qc

To develop the package using uv, the following will create a virtual environment, uv defaults to .venv:

git clone https://github.com/glamod/marine_qc
cd marine_qc
uv venv --python 3.12      # Create an environment with the recommended python version
source .venv/bin/activate  # Load the virtual environment (for bash or zsh)
uv sync

Contributing to marine_qc

If you’re interested in participating in the development of marine_qc 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 marine_qc in a research publication, we kindly ask that you refer to Zenodo: https://doi.org/10.5281/zenodo.17404319.

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

marine_qc development is funded through Copernicus Climate Change Service (C3S).

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