Skip to content

Commit

Permalink
doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
tomkralidis committed Apr 28, 2024
1 parent 4d1d151 commit 890cd2a
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
10 changes: 5 additions & 5 deletions docs/source/reference/running/station-metadata.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Station metadata

`OSCAR/Surface`_ is the key resource for station metadata and contains a global compilation of the metadata for stations
that exchange data internationally.
Prior to exchanging data on the WIS2, stations must be registered in OSCAR/Surface and assigned a WIGOS-station-identifier (WSI).
Prior to exchanging data on WIS2, stations must be registered in OSCAR/Surface and assigned a WIGOS station identifier (WSI).

The wis2box API can be used to retrieve station metadata from OSCAR/Surface and cache a subset of the station metadata in the wis2box backend.

Expand All @@ -14,11 +14,11 @@ The station metadata can be cached in two ways:
* from the command-line in the wis2box-management container, after populating the station list CSV file
* from the station editor in the wis2box-webapp, available at ``$WIS2BOX_URL/wis2box-webapp/station``

The plugins for converting data to bufr will use the cached station metadata in the following ways:
The plugins for converting data to BUFR will use the cached station metadata as follows:

* synop2bufr: The station metadata is used to derives the WSI by matching with the traditional station identifierin the FM-12 input data. The station metadata is also used to encode the location and barometer height above sea-level into the BUFR message.
* csv2bufr: The station metadata list is used to whitelist records to publish. If no match is found in the station list for an input record based on the WSI, the record is not published.
* bufr2bufr: If the WSI is missing in the input BUFR data, the WSI is looked up in the station metadata list using the traditional station identifier (block and station number, ship callsign etc.) and inserted into the BUFR message. Similarly, if the location or station elevation are missing in the input BUFR data, these are looked up in the station metadata list and inserted into the BUFR message as required before further processing.
* synop2bufr: The station metadata is used to derives the WSI by matching with the traditional station identifier in the FM-12 input data. The station metadata is also used to encode the location and barometer height above sea-level into the BUFR message
* csv2bufr: The station metadata list is used to whitelist records to publish. If no match is found in the station list for an input record based on the WSI, the record is not published
* bufr2bufr: If the WSI is missing in the input BUFR data, the WSI is looked up in the station metadata list using the traditional station identifier (block and station number, ship callsign etc.) and inserted into the BUFR message. Similarly, if the location or station elevation are missing in the input BUFR data, these are looked up in the station metadata list and inserted into the BUFR message as required before further processing

Using the station editor in the wis2box-webapp
----------------------------------------------
Expand Down
8 changes: 4 additions & 4 deletions docs/source/user/data-ingest.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ The AWS template in csv2bufr plugin

When using the csv2bufr plugin, the columns are mapped to BUFR encoded values using a template as defined in the repository `csv2bufr-templates`_.

An example of a CSV file that can be ingested using the 'AWS' mappings template can be downloaded here :download:`AWS-example <../_static/aws-example.csv>`
An example of a CSV file that can be ingested using the 'AWS' mappings template can be downloaded here :download:`AWS-example <../_static/aws-minimal.csv>`

The CSV-columns description of the AWS-template can be downloaded here :download:`AWS-reference <../_static/aws-minimal.csv>`
The CSV columns description of the AWS template can be downloaded here :download:`AWS-reference <../_static/aws-minimal.csv>`


MinIO user interface
Expand Down Expand Up @@ -155,7 +155,7 @@ See below a Python example to upload data using the MinIO package:

.. note::

You need to install the MinIO package for python otherwise you get the error ``ModuleNotFoundError: No module named 'minio'``.
The MinIO package is required for running the script above.

To install the MinIO package, run the following command:

Expand Down Expand Up @@ -243,4 +243,4 @@ Next: :ref:`public-services-setup`
.. _`wis2box-ftp`: https://github.com/wmo-im/wis2box-ftp
.. _`wis2box-data-subscriber`: https://github.com/wmo-im/wis2box-data-subscriber
.. _`WIS2 topic hierarchy`: https://github.com/wmo-im/wis2-topic-hierarchy
.. _`csv2bufr-templates`: https://github.com/wmo-im/csv2bufr-templates
.. _`csv2bufr-templates`: https://github.com/wmo-im/csv2bufr-templates

0 comments on commit 890cd2a

Please sign in to comment.