Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tomkralidis committed Sep 5, 2023
1 parent 475d148 commit cdbae03
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 1 deletion.
22 changes: 22 additions & 0 deletions docs/source/reference/running/station-metadata.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,30 @@ processing.

.. seealso:: :ref:`api-publishing`

OSCAR/Surface
-------------

wis2box can derive station information from `OSCAR/Surface`_. To verify station metadata from OSCAR/Surface:

.. code-block:: bash
wis2box metadata station WSI
where ``WSI`` is the WIGOS Station Identifier. This command will return the information required in the
station list for wis2box data processing and publication. To add the station information to the station list,
copy and paste the output of the above command, or rerun the above command, writing to the station list
automatically:


.. code-block:: bash
wis2box metadata station WSI >> ~/wis2box-data/metadata/station/station_list.csv
Summary
-------

At this point, you have cached the required station metadata for your given dataset(s).

.. _`OSCAR/Surface`: https://oscar.wmo.int/surface
14 changes: 13 additions & 1 deletion docs/source/user/setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ wis2box requires information about the stations for which you will be sharing da

An example of the configuration file for the stations is provided in ``station_list.csv``.

You can copy this file to ``metadata/station/station_list.csv`` in your $WIS2BOX_HOST_DATADIR :
You can copy this file to ``metadata/station/station_list.csv`` in your $WIS2BOX_HOST_DATADIR:

.. code-block:: bash
Expand All @@ -176,6 +176,18 @@ And edit ``~/wis2box-data/metadata/station/station_list.csv`` to include the dat
The ``station_list.csv`` requires column names ``station_name`` and the ``wigos_station_identifier`` (WSI) with which the station is registered in `OSCAR`_. Optionally, you can provide a ``traditional_station_identifier (TSI)`` column.
The TSI can be left empty if your data contains a WSI. If your data contains a TSI but no WSI, the ``station_list.csv`` will be used to derive the corresponding WSI for that station.

To verify station metadata from OSCAR/Surface, run the following command:

.. code-block:: bash
wis2box metadata station get <WSI>
Then to add to the station list:

.. code-block:: bash
wis2box metadata station get <WSI> >> ~/wis2box-data/metadata/station/station_list.csv
Discovery metadata
------------------

Expand Down

0 comments on commit cdbae03

Please sign in to comment.