Skip to main content

Quality Control of Temperature and Salinity profiles

Project description

https://zenodo.org/badge/10284681.svg Documentation Status https://img.shields.io/travis/castelao/CoTeDe.svg https://codecov.io/gh/castelao/CoTeDe/branch/master/graph/badge.svg https://img.shields.io/pypi/v/cotede.svg https://mybinder.org/badge_logo.svg

CoTeDe is an Open Source Python package to quality control (QC) oceanographic data such as temperature and salinity. It was designed to attend individual scientists as well as real-time operations on large data centers. To achieve that, CoTeDe is highly customizable, giving the user full control to compose the desired set of tests including the specific parameters of each test, or choose from a list of preset QC procedures.

I believe that we can do better than we have been doing with more flexible classification techniques, which includes machine learning. My goal is to minimize the burden on manual expert QC improving the consistency, performance, and reliability of the QC procedure for oceanographic data, especially for real-time operations.

CoTeDe is the result from several generations of quality control systems that started in 2006 with real-time QC of TSGs and were later expanded for other platforms including CTDs, XBTs, gliders, and others.

Why use CoTeDe

CoTeDe contains several QC procedures that can be easily combined in different ways:

  • Pre-set standard tests according to the recommendations by GTSPP, EGOOS, XBT, Argo or QARTOD;

  • Custom set of tests, including user defined thresholds;

  • Two different fuzzy logic approaches: as proposed by Timms et. al 2011 & Morello et. al. 2014, and using usual defuzification by the bisector;

  • A novel approach based on Anomaly Detection, described by Castelao 2015.

Each measuring platform is a different realm with its own procedures, metadata, and meaningful visualization. So CoTeDe focuses on providing a robust framework with the procedures and lets each application, and the user, to decide how to drive the QC. For instance, the pySeabird package is another package that understands CTD and uses CoTeDe as a plugin to QC.

Documentation

A detailed documentation is available at http://cotede.readthedocs.org, while a collection of notebooks with examples is available at http://nbviewer.ipython.org/github/castelao/CoTeDe/tree/master/docs/notebooks/

Citation

If you use CoTeDe, or replicated part of it, in your work/package, please consider including the reference:

Castelao, G. P., (2020). A Framework to Quality Control Oceanographic Data. Journal of Open Source Software, 5(48), 2063, https://doi.org/10.21105/joss.02063

@article{Castelao2020,
  doi = {10.21105/joss.02063},
  url = {https://doi.org/10.21105/joss.02063},
  year = {2020},
  publisher = {The Open Journal},
  volume = {5},
  number = {48},
  pages = {2063},
  author = {Guilherme Castelao},
  title = {A Framework to Quality Control Oceanographic Data},
  journal = {Journal of Open Source Software}
}

History

0.20 - Jul, 2018

  • Removing dependency on pySeabird and pyArgo. Inversion of roles to generalize CoTeDe for other uses. Before CoTeDe would depend on pySeabird, but now CoTeDe is an optional requirement for pySeabird to QC CTD and TSG.

0.19

  • CARS features and flags

0.17 - Mar, 2016

  • Implementing fuzzy procedures inside CoTeDe, thus removing dependency on scikit-fuzzy. scikit-fuzzy is broken, hence compromising tests and development of CoTeDe.

0.16 - Mar, 2016

  • Using external package OceansDB to handle climatologies and bathymetry.

0.15 - Dec, 2015

  • Moved procedures to handle climatology to external standalone packages.

0.14 - Aug, 2015

  • Interface for human calibration of anomaly detection

  • Implemented fuzzy logic criteria

0.13 - July, 2015

  • Major improvements in the anomaly detection submodule

  • Partial support to thermosalinographs (TSG)

  • Working on WOA test to generalize for profiles and tracks

  • Adding .json to default QC configuration filenames

  • Moved load_cfg from qc to utils

0.12

Since 0.9 some of the most important changes.

  • Following OceanSites vocabulary for variable names (PRES, TEMP, PSAL…)

  • Partial support to Argo profiles

  • Added density invertion test

  • Included haversine to avoid dependency on MAUD.

  • tox and travis support.

0.9 - Dec, 2013

  • A few people already had access but at this point it went open publicly.

0.7.3

  • Creating fProfileQC()

0.5.4 - Nov, 2013

  • Including Tukey53H test

0.5.0

  • Implemented ProfileQCCollection (later moved to PySeabird).

0.4 - Sep, 2013

  • Gradient and spike tests with depth conditional thresholds.

  • CruiseQC (later replaced by ProfileQCCollection).

  • Use default threshold values for the QC tests.

0.1 - May 24, 2013

  • Renamed to CoTeDe. Another major refactoring.

QC_ML - 2011

  • Renamed to QC_ML, a machine learning approach to quality control hydrographic data, the initial prototype of Anomaly Detection approach. I refactored the system I developed to quality control TSG, to evaluate the PIRATA’s CTD stations for INPE. At that point I migrated from my personal Subversion server to Bitbucket, and I lost the detailed history and logs before that.

2008

  • Modified to parse Seabird CTDs so that the .cnv files could be directly QCed.

2006

  • A system to automaticaly quality control TSG data on realtime for AOML-NOAA. The data was handled in a PostgreSQL database, and only the traditional tests were applied, i.e. a sequence of binary tests (spike, gradient, valid position …).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cotede-0.23.0.tar.gz (47.0 kB view details)

Uploaded Source

Built Distribution

cotede-0.23.0-py2.py3-none-any.whl (63.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file cotede-0.23.0.tar.gz.

File metadata

  • Download URL: cotede-0.23.0.tar.gz
  • Upload date:
  • Size: 47.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/0.0.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0.post20200814 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.5

File hashes

Hashes for cotede-0.23.0.tar.gz
Algorithm Hash digest
SHA256 ad504b9f131e6ef463a1ee3ec7723264686faef1f51f4f24155c37e23c789080
MD5 bb6e182316f759b7ec1a520ba9fc3704
BLAKE2b-256 cc253b7422b9603e06a1bf5b11c7ed89e037a27fcadb1a97fde3828de6b091cb

See more details on using hashes here.

File details

Details for the file cotede-0.23.0-py2.py3-none-any.whl.

File metadata

  • Download URL: cotede-0.23.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 63.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/0.0.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0.post20200814 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.5

File hashes

Hashes for cotede-0.23.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3fa88a165923e89308dde4728ead3fa00fbcc4603d629f019c0a5829ebf6b50f
MD5 b14b928eb10a48123ec2ddaf31f8d734
BLAKE2b-256 842aa19f94b2fa496a666bfc15f32f05a192491be76f874de75aef112efed87b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page