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

CoTeDe is an Open Source Python package to quality control (QC) hydrographic data such as temperature and salinity. It was designed to attend individual scientists as well as operational systems with large databases, reading the inputs from different formats and types of sensors, and processing those in parallel for high performance. To achieve that, CoTeDe is highly customizable, allowing the user to compose the desired set of tests, as well as the specific parameters of each test. Otherwise there are preset QC procedures conforming with GTSPP, EuroGOOS and Argo recommendations. It is also implemented innovating approaches to QC like the Fuzzy Logic (Timms 2011, Morello 2014) and Anomaly Detection (Castelão 2015).

At this point it is operational for profiles (CTD, XBT and Argo) and tracks (TSG). For CTD profiles and TSG time series it uses PySeabird package to interpret directly the SeaBird’s .cnv output file, and for argo it uses PyArgo package to interpret the netCDF files.

This is the result from several generations of quality control systems, which started in 2006, when I developed from scratch an automatic quality control system for realtime evaluation of thermosalinographs at AOML-NOAA, USA. Later I was advising the quality control of the brazilian hydrography of PIRATA.

My vision is that we can do better than we do today with more flexible classification techniques, which includes machine learning, to minimize the burden on manual expert QC improving the consistency, performance and reliability of the QC procedure for oceanographic data, especially for realtime operations.

Why use CoTeDe

CoTeDe can apply different quality control procedures:
  • The default GTSPP, EGOOS or Argo procedures;

  • A custom set of tests, including user defined thresholds;

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

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

Process multiple files in parallel, ideal for large datasets.

Export output, original data plus flags, into netCDF files following OCEANSites data structure.

Quick howto

To evaluate the records of a profile:

import cotede.qc

pqc = cotede.qc.fProfileQC(‘example.cnv’)

To see the temperature records of the primary sensor:

pqc[‘temperature’]

To see the flags of all tests applied on the secondary sensor of salinity:

pqc.flags[‘salinity2’]

To evaluate a full set of profiles at once, like all profiles from a cruise, use the class ProfileQCCollection, like:

dataset = ProfileQCCollection(‘/path/to/data/’, inputpattern=”.*.cnv”)

dataset.flags[‘temperature’].keys()

Check the notebooks gallery for more examples and functionalities: http://nbviewer.ipython.org/github/castelao/CoTeDe/tree/master/docs/notebooks/

Documentation

http://cotede.readthedocs.org

History

0.20 - Jul, 2018

  • Removing dependency on pyArgo and pySeabird. Generalizing CoTeDe for other uses, thus now on PyArgo, PySeabird, and other packages to come public soon that use CoTeDe.

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 CF vocabulary for variables 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

  • Going public

0.7.3

  • Creating fProfileQC()

0.5.4 - Nov, 2013

  • Including Tukey53H test

0.5.0

  • Implemented ProfileQCCollection

0.4 - Sep, 2013

  • gradient and spike tests with depth conditional thresholds

  • CruiseQC

  • Use default threshold values for the QC tests.

0.1 - May 24, 2013

  • Initial release.

QC_ML - 2011

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

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.20.3.tar.gz (39.6 kB view details)

Uploaded Source

Built Distribution

cotede-0.20.3-py2.py3-none-any.whl (55.7 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: cotede-0.20.3.tar.gz
  • Upload date:
  • Size: 39.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3

File hashes

Hashes for cotede-0.20.3.tar.gz
Algorithm Hash digest
SHA256 7851109ea8bf359bd2d69613b5b810d48b80fd9e52455a3a4d0cd98ec58c7316
MD5 95f23434adb5098e022250f3e8096c25
BLAKE2b-256 d084c30e5b9e943378d21e8b784a0d51d9762714a257177e81dfa31e6cc54993

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cotede-0.20.3-py2.py3-none-any.whl
  • Upload date:
  • Size: 55.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3

File hashes

Hashes for cotede-0.20.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 abb4a9c9f26818809896396ebc1c9c265e0e0273f5af18dd48216a97f562cec3
MD5 4f9cdc7ed0c056624bd49fb8652cf8d8
BLAKE2b-256 a8e813695f821989c22e82f33d36138f57e1bb66917259973ff06fdc62bad93e

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