Skip to content

Update NewFilter.rst to include diagnosticFlagBenchmark documentation. #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
samueljmcameron wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Update NewFilter.rst to include diagnosticFlagBenchmark documentation. #49

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/inside/jedi-components/ufo/qcfilters/NewFilter.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,18 @@ All observation filters in UFO are tested with the :code:`ObsFilters` test from
reference:
name: TestReference/northward_wind
absTol: 1e-5

- :code:`diagnosticFlagBenchmark`: A map whose presence instructs the test to count how many instances of a Diagnostic Flag are :code:`true`. Each key is a diagnostic flag along with the relevant variable being tested. Each value is the number of instances that the diagnostic flag is set to :code:`true`. Example:

.. code-block:: yaml

diagnosticFlagBenchmark:
PermanentStationRejection/relativeHumidity: 115
InterpolationCheckRejection/relativeHumidity: 33
FinalQCRejection/relativeHumidity: 264
SignificantWindLevelInAscent/relativeHumidity: 0
TropopauseLevelInAscent/relativeHumidity: 2
PartialLayerUsedInAveraging/airTemperature: 2
MaximumWindLevelInAscent/airTemperature: 0
SignificantWindLevelInAscent/airTemperature: 0
StandardLevelInAscent/airTemperature: 29