From 35c4654fa73e2e35da3ce013016ab2924b026518 Mon Sep 17 00:00:00 2001 From: Maaike Date: Thu, 7 Dec 2023 16:11:32 +0100 Subject: [PATCH] add some docs --- docs/source/community/troubleshooting.rst | 22 ++++++++++++++++++++++ docs/source/user/setup.rst | 17 +++++++++++++++++ 2 files changed, 39 insertions(+) diff --git a/docs/source/community/troubleshooting.rst b/docs/source/community/troubleshooting.rst index 7c20ed00..79554990 100644 --- a/docs/source/community/troubleshooting.rst +++ b/docs/source/community/troubleshooting.rst @@ -5,7 +5,28 @@ Troubleshooting This page lists several commonly seen issues and how to address them. +no station on map in wis2box-UI +------------------------------- + +The stations displayed in the wis2box-ui per dataset are defined by the topic associated with the station. + +To associate a station with a topic, you can edit the station metadata using the station-editor in wis2box-webapp or you can use the command 'wis2box metadata station add-topic' to add a topic to a station. + +For example, to add the topic 'origin/a/wis2/my-centre-id/data/core/weather/surface-based-observations/synop' to the station with wigos-station-id=0-20000-0-12345, run the following command: + +.. code-block:: bash + + python3 wis2box-ctl.py login + wis2box metadata station add-topic --wsi 0-20000-0-12345 origin/a/wis2/my-centre-id/data/core/weather/surface-based-observations/synop +To associated all stations defined in your station metadata with the same topic, you can use the command 'wis2box metadata station add-topic' without specifying a station id: + +.. code-block:: bash + + python3 wis2box-ctl.py login + wis2box metadata station add-topic origin/a/wis2/my-centre-id/data/core/weather/surface-based-observations/synop + + OSError: Missing data mappings ------------------------------ @@ -93,6 +114,7 @@ To add missing stations, use the station-editor in wis2box-webapp (from wis2box- python3 wis2box-ctl.py login wis2box metadata station publish-collection + Error: no such container: wis2box-management -------------------------------------------- diff --git a/docs/source/user/setup.rst b/docs/source/user/setup.rst index b53bb52c..955e0d45 100644 --- a/docs/source/user/setup.rst +++ b/docs/source/user/setup.rst @@ -232,6 +232,23 @@ You can also bulk insert a set of stations from a CSV file, by defining the stat After doing a bulk insert please review the stations in wis2box-webapp and associate each station to the correct topics. +Adding topics to stations from the command line +----------------------------------------------- + +If you want to associate all stations in your station metadata to one topic, you can use the following command: + +.. code-block:: bash + + python3 wis2box-ctl.py login + wis2box metadata station add-topic + +If you want to add a topic to a single station, you can use the following command: + +.. code-block:: bash + + python3 wis2box-ctl.py login + wis2box metadata station add-topic --wsi + The next is the :ref:`data-ingest`. .. _`wis2box Releases`: https://github.com/wmo-im/wis2box/releases