Skip to content

Commit

Permalink
Updated docs with NCAS-Radar info
Browse files Browse the repository at this point in the history
  • Loading branch information
joshua-hampton committed Apr 24, 2024
1 parent 1949449 commit 62999e5
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = 'checksit'
copyright = '2023, Ag Stephens, Hugo Ricketts, Joshua Hampton'
copyright = '2024, Ag Stephens, Hugo Ricketts, Joshua Hampton'
author = 'Ag Stephens, Hugo Ricketts, Joshua Hampton'
release = '0.1'

Expand Down
9 changes: 8 additions & 1 deletion docs/source/dev/ncas_standard_specifics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,13 @@ function within ``checksit/make_specs.py``. However, if ``checksit`` cannot find
version, or does not have permission to write into the ``specs/groups`` folder, then an error is
raised.

NCAS-Radar
----------

Similarly to the NCAS-GENERAL standard above, if ``NCAS-Radar`` is in the ``Conventions`` global attribute
of a netCDF file, then ``checksit`` will use specs defined for the identifed version of the ``NCAS-Radar``
data standard.

NCAS-IMAGE
----------

Expand All @@ -36,4 +43,4 @@ one of ``png``, ``jpg`` or ``jpeg`` (or uppercase versions), and the file has th
``checksit`` will find specs related to NCAS-IMAGE. The version of the standard is identified using
the ``Instructions`` tag, and specs relating to either the ``photo`` or ``plot`` data product are
selected depending on the file name. The data product spec is combined with a global tags spec file
that covers tags required by the standard regardless of which data product is used.
that covers tags required by the standard regardless of which data product is used.
2 changes: 2 additions & 0 deletions docs/source/dev/where_does_checksit_do_it.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,8 @@ checks, managed by the ``Rules`` class in ``checksit/rules/rules.py``. There are
- ``r"v\d\.\d"``
* - "datetime"
- ``r"\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?"``
* - "datetimeZ"
- ``r"\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?Z"``
* - "datetime-or-na"
- ``r"(\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(.\d+)?)" + _NOT_APPLICABLE_RULES``
* - "number"
Expand Down
22 changes: 22 additions & 0 deletions docs/source/specifics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,25 @@ is the same as
.. code-block::
checksit check -t off -s ncas-image-1.0.0/amof-image-global-attrs,ncas-image-1.0.0/amof-photo ncas-cam-9_cao_20231117_photo_v1.0.nc
NCAS-Radar
----------

The NCAS-Radar standard is also recognised by ``checksit``\ , with the correct specs identified and
used if no template or spec options are specified. Unlike the NCAS-GENERAL and NCAS-IMAGE standards,
NCAS-Radar does not have specific data product specs, instead there are a number of different spec
files covering different areas of the standard. These spec files are:

.. code-block::
coordinate-variables
dimensions
global-attrs
global-variables
instrument-parameters
location-variables
moment-variables
radar-calibration
radar-parameters
sensor-pointing-variables
sweep-variables

0 comments on commit 62999e5

Please sign in to comment.