Skip to content

Commit

Permalink
Listing traditional tests (#1)
Browse files Browse the repository at this point in the history
* Adding formulae for spike and gradient

* Adding @catsch to contributors

The contributors session need some thinking on how to organize it, but
adding @catsch now anyways so we don't forget it later.

* Moving tests session into src

All source code for the document should be organized inside src.

* Fixing identation with spaces

* Adding digit rollover

* A reminder for global range

* Argo's spike for nitrate

Adding a note here so we don't miss the comments from @catsch.

* Moving tests to AsciiDoc

While we don't decide which one to use, let's stay consistent.

* Including tests section into main document

* Initiating section procedures

* Fix: Spike - median

Thanks to @callumrollo

* Adding DOI for BGC nitrate QC

Thanks to @callumrollo

* Improving bibtex record
  • Loading branch information
castelao authored May 14, 2023
1 parent 2c6d7e8 commit 7203f58
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 1 deletion.
23 changes: 22 additions & 1 deletion src/RealtimeQC.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Realtime Quality Control for Underwater Gliders
:stem: latexmath

== Credits

Expand Down Expand Up @@ -31,6 +32,18 @@ The methods described here augment the original data to guide the user on the de
Real-time QC is commonly associated with automatic checks, which indeed better suit the fast response requirements for a real-time data stream, but it should not be limited to automatic procedures. One of the distinct characteristics of underwater gliders is the close monitoring from pilots and scientists as frequently as hourly to at most every couple of days.
Complex cases, otherwise missed by the automatic procedures, but identified by the operators should be flagged and updated in the data stream. With the assumption of a low rate of mistakes by the automatic procedure, it is best to do not hold the automatic procedure for manual confirmation, but employ a fast automatic assessment and stream a posterior correction when necessary.

include::tests.adoc[leveloffset=+1]

== Procedures

==== Argo BGC

9. Spike test (median)

Red Sea and Mediterranean Sea, flag 4 if test value > 1 micromole/kg

Other places, flag 4 if test value > 5 micromole/kg

== History

Virtual synchronous meeting on XXX.
Expand Down Expand Up @@ -73,6 +86,14 @@ Participants:
* Claire Gourcuff, claire.gourcuff@euro-argo.eu


== Contributors

List of all contributors an their contributions.

* Schmechtig (@catsch), CNRS
PR-1: Details on Argo's Nitrate test

[bibliography]
== References

(just a starting point. Move it to bibtex)
* [[BGC_nitrate]] Johnson Kenneth, Maurer Tanya, Plant Joshua, Bittig Henry, Schallenberg Christina, Schmechtig Catherine (2021). BGC-Argo quality control manual for nitrate concentration. https://doi.org/10.13155/84370
8 changes: 8 additions & 0 deletions src/realtime_qc.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@

@manual{johnson2021bgc,
title={BGC-Argo quality control manual for nitrate concentration},
author={Johnson, Kenneth and Maurer, Tanya and Plant, Joshua and Bittig, Henry and Schallenberg, Christina and Schmechtig, Catherine},
year={2021},
edition={Version 1.0},
doi={10.13155/84370}
}
33 changes: 33 additions & 0 deletions src/tests.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
= Tests

== Global Range

== Gradient

[stem]
++++
X_i = \left| V_i - \frac{V_{i+1} + V_{i-1}}{2} \right|
++++

== Spike

[stem]
++++
X_i = \left| V_i - \frac{V_{i+1} + V_{i-1}}{2} \right| - \left| \frac{V_{i+1} - V_{i-1}}{2} \right|
++++

== Digit Rollover

[stem]
++++
X_i = V_i - V_{i-1}
++++

== Spike - Median

Proposed at <<BGC_nitrate>>

[stem]
++++
X_i = \left| V_i - median(V_{i-2}, V_{i-1}, V_i, V_{i+1}, V_{i+2}) \right|
++++

0 comments on commit 7203f58

Please sign in to comment.