diff --git a/documentation/docs/index.md b/documentation/docs/index.md index cba205bc..03e0a90e 100644 --- a/documentation/docs/index.md +++ b/documentation/docs/index.md @@ -83,6 +83,8 @@ Snippets which need to be typed in a on a terminal/console are indicated as: echo 'Hello world' ``` +Container names (running images) are denoted in **bold**. + ## Training location and materials This training is always provided live at [https://training.wis2box.wis.wmo.int](https://training.wis2box.wis.wmo.int). diff --git a/documentation/docs/practical-sessions/configuring-data-mappings.md b/documentation/docs/practical-sessions/configuring-data-mappings.md index 59dd6495..51134de3 100644 --- a/documentation/docs/practical-sessions/configuring-data-mappings.md +++ b/documentation/docs/practical-sessions/configuring-data-mappings.md @@ -20,7 +20,7 @@ Login to your student VM Here's how to add data mapping for wis2box to process CSV data. Inspect the contents of the sample SYNOP CSV data mapping: ```bash -cat ~/wis2box-1.0b4/synop-csv-mappings.yml +cat ~/wis2box-1.0b5/synop-csv-mappings.yml ``` !!! question diff --git a/documentation/docs/practical-sessions/configuring-station-metadata.md b/documentation/docs/practical-sessions/configuring-station-metadata.md index bbd9c6be..8da97141 100644 --- a/documentation/docs/practical-sessions/configuring-station-metadata.md +++ b/documentation/docs/practical-sessions/configuring-station-metadata.md @@ -30,7 +30,7 @@ Then login into the **wis2box-management** container with the following command: python3 wis2box-ctl.py login ``` -Within the wis2box-container your can create an authorization token for a specific endpoint using the command: `wis2box auth add-token --path `. +Within the **wis2box-management** container your can create an authorization token for a specific endpoint using the command: `wis2box auth add-token --path `. For example, to use a random automatically generated token for the `collections/stations` endpoint: @@ -62,7 +62,7 @@ Token successfully created Please create an authorization token for the `collections/stations` endpoint using the instructions above. -## add station metadata using the wis2box-webapp +## add station metadata using the **wis2box-webapp** The **wis2box-webapp** provides a graphical user interface to edit station metadata. @@ -153,6 +153,6 @@ You also have the option to view/update/delete the station in the **wis2box-weba In this practical session, you learned how to: - create an authorization token for the `collections/stations` endpoint - - add station metadata to the wis2box + - add station metadata to wis2box - review stations associated to datasets in the **wis2box-ui** - update/delete station metadata using the **wis2box-webapp** diff --git a/documentation/docs/practical-sessions/configuring-wis2-discovery-metadata.md b/documentation/docs/practical-sessions/configuring-wis2-discovery-metadata.md index 9f1309e5..29c30f40 100644 --- a/documentation/docs/practical-sessions/configuring-wis2-discovery-metadata.md +++ b/documentation/docs/practical-sessions/configuring-wis2-discovery-metadata.md @@ -21,7 +21,7 @@ Login to your student VM using your SSH-client. Copy the test discovery metadata into your own file (you may name the file whatever you wish): ```bash -cd ~/wis2box-1.0b4/ +cd ~/wis2box-1.0b5/ cp examples/config/surface-weather-observations.yml ~/wis2box-data/my-discovery-metadata.yml ``` diff --git a/documentation/docs/practical-sessions/converting-synop-data-to-bufr.md b/documentation/docs/practical-sessions/converting-synop-data-to-bufr.md index 739d36d3..16ad80f5 100644 --- a/documentation/docs/practical-sessions/converting-synop-data-to-bufr.md +++ b/documentation/docs/practical-sessions/converting-synop-data-to-bufr.md @@ -29,12 +29,12 @@ as the relationship between the information contained in the FM-12 SYNOP reports !!! warning "Prerequisites" - Ensure that your WIS2box has been configured and started, including the setting execution tokens for the ``processes/wis2box`` and ``collections/stations``paths. Confirm the status by visiting - the WIS2box API (``http:///oapi``) and verifying that the API is running. - - Ensure that you are able to access the wis2box management container using a file transfer - tool such as WinSCP. + the WIS2box API (``http:///oapi``) and verifying that the API is running + - Ensure that you are able to access the **wis2box-management container using a file transfer + tool such as WinSCP - For practical purposes the exercises in this session use data from Romania, import the station ``0-20000-0-15015`` into your station list and associate it with the topic - for your "Surface weather observations collection". This will be removed at the end of the session. + for your "Surface weather observations collection". This will be removed at the end of the session ## Inspecting SYNOP data and BUFR conversion @@ -190,7 +190,7 @@ AAXX 21121 In this first example the "end of text" symbol (=), or record delimiter, is missing between the first and second weather reports. Consequently, lines 2 and 3 are treated as a single report, leading to errors in the parsing of the message. The final line is also missing the end of - text symbol but the wis2box is able to handle this case. + text symbol but wis2box is able to handle this case. The station 15090 should have been registered as part of the previous exercise. If not you will also receive a warning that the station can not be found. If this is the case, register the diff --git a/documentation/docs/practical-sessions/data-ingest-and-monitoring.md b/documentation/docs/practical-sessions/data-ingest-and-monitoring.md index b1e4d742..55dfef67 100644 --- a/documentation/docs/practical-sessions/data-ingest-and-monitoring.md +++ b/documentation/docs/practical-sessions/data-ingest-and-monitoring.md @@ -15,7 +15,7 @@ Login to you student VM using your SSH client. Make sure wis2box is up and running: ```bash -cd ~/wis2box-1.0b4 +cd ~/wis2box-1.0b5/ python3 wis2box-ctl.py start python3 wis2box-ctl.py status ``` @@ -110,10 +110,10 @@ Upload the file `WIGOS_0-454-2-AWSBILIRA_new.csv` to `wis2box-incoming/mwi/mwi_w To allow your data to be accessible over FTP you can use the **wis2box-ftp** container, which provides a service that forwards data received over FTP to MinIO. -For the purpose of this training you can use your predefined configuration in `~/wis2box-1.0b4/ftp.env` to start your wis2box-ftp as follows: +For the purpose of this training you can use your predefined configuration in `~/wis2box-1.0b5/ftp.env` to start your wis2box-ftp as follows: ```bash -cd ~/wis2box-1.0b4/ +cd ~/wis2box-1.0b5/ docker-compose -f docker-compose.wis2box-ftp.yml --env-file ftp.env up -d ``` @@ -148,7 +148,7 @@ Check your Grafana dashboard and MQTT Explorer to review the result of copying t You can view ftp-configuration in `ftp.env` from the command line: ```bash - cat ~/wis2box-1.0b4/ftp.env + cat ~/wis2box-1.0b5/ftp.env ``` ```console diff --git a/documentation/docs/practical-sessions/downloading-and-finding-data-from-wis2.md b/documentation/docs/practical-sessions/downloading-and-finding-data-from-wis2.md index 33e2653e..ae6c7c31 100644 --- a/documentation/docs/practical-sessions/downloading-and-finding-data-from-wis2.md +++ b/documentation/docs/practical-sessions/downloading-and-finding-data-from-wis2.md @@ -23,6 +23,9 @@ Let's use the [pywis-pubsub](https://github.com/wmo-im/pywis-pubsub) to subscrib pywis-pubsub subscribe --help ``` +!!! note + pywis-pubsub is pre-installed on the local training environment, but can be installed from anywhere with `pip3 pywis-pubsub` + Update the sample configuration (see the sections marked **TBD**) to connect to the Météo-France Global Broker: ```bash @@ -73,6 +76,13 @@ pywis-pubsub subscribe -c ~/exercise-materials/pywis-pubsub-exercises/config.yml Let's use [pywiscat](https://github.com/wmo-im/pywiscat) to query the GDC +```bash +pywiscat wis2 search --help +``` + +!!! note + pywiscat is pre-installed on the local training environment, but can be installed from anywhere with `pip3 pywiscat` + ```bash pywiscat wis2 search ``` diff --git a/documentation/docs/practical-sessions/environment-variables.md b/documentation/docs/practical-sessions/environment-variables.md index 93e5738b..fd7459c6 100644 --- a/documentation/docs/practical-sessions/environment-variables.md +++ b/documentation/docs/practical-sessions/environment-variables.md @@ -17,7 +17,7 @@ Login to your student VM using WinSCP (using SCP-protocol) and PuTTY. Stop your wis2box: ```bash -cd ~/wis2box-1.0b4/ +cd ~/wis2box-1.0b5/ python3 wis2box-ctl.py stop ``` @@ -58,10 +58,10 @@ docker volume ls The wis2box setup reads environment variables from `dev.env`. -Make sure you are in the wis2box-directory and the check the current content of your `dev.env`. +Make sure you are in the wis2box directory and the check the current content of your `dev.env`. ```bash -cd ~/wis2box-1.0b4/ +cd ~/wis2box-1.0b5/ cat dev.env ``` @@ -74,7 +74,7 @@ This setup was using the pre-defined configuration stored in `~/exercise-materia Make sure you keep these values when editing your `dev.env` -In the next few steps we will review how to update some of key environment variables used in wis2box by editing `dev.env` in the directory `wis2box-1.0b4`. +In the next few steps we will review how to update some of key environment variables used in wis2box by editing `dev.env` in the directory `wis2box-1.0b5`. You can use WinSCP to connect to your instance and edit this file or you can edit the file from the command line using PuTTY. @@ -162,7 +162,7 @@ The content of you `dev.env` should now look as follows (except for your own pas ## Restart wis2box -Start the wis2box and check the status: +Start wis2box and check the status: ```bash python3 wis2box-ctl.py start python3 wis2box-ctl.py status diff --git a/documentation/docs/practical-sessions/wis2box-introduction.md b/documentation/docs/practical-sessions/initializing-wis2box.md similarity index 99% rename from documentation/docs/practical-sessions/wis2box-introduction.md rename to documentation/docs/practical-sessions/initializing-wis2box.md index 22bba6db..df5ed372 100644 --- a/documentation/docs/practical-sessions/wis2box-introduction.md +++ b/documentation/docs/practical-sessions/initializing-wis2box.md @@ -254,7 +254,7 @@ Click on the 'ADVANCED' button and add the following topics to subscribe to: The messages published under the `$SYS` topic are system messages published by the mosquitto service itself. - The messages published under topics starting with `origin/a/wis2/#` are the WIS2 data notifications published by the wis2box-broker. + The messages published under topics starting with `origin/a/wis2/#` are the WIS2 data notifications published by the **wis2box-broker**. The messages published under topics starting with `wis2box` are internal messages between the various components of the wis2box software stack. diff --git a/documentation/mkdocs.yml b/documentation/mkdocs.yml index cef87793..fda57897 100644 --- a/documentation/mkdocs.yml +++ b/documentation/mkdocs.yml @@ -14,14 +14,14 @@ nav: - Practical sessions: - Connecting to WIS2 over MQTT: practical-sessions/connecting-to-mqtt.md - Accessing your student VM: practical-sessions/accessing-your-student-vm.md - - Initializing the wis2box: practical-sessions/wis2box-introduction.md + - Initializing wis2box: practical-sessions/initializing-wis2box.md - Creating WIS2 discovery metadata: practical-sessions/configuring-wis2-discovery-metadata.md - Creating wis2box station metadata: practical-sessions/configuring-station-metadata.md - Converting SYNOP data to BUFR: practical-sessions/converting-synop-data-to-bufr.md - Converting CSV data to BUFR: practical-sessions/converting-csv-data-to-bufr.md - Automating data ingestion: practical-sessions/data-ingest-and-monitoring.md - Downloading and finding data from WIS2: practical-sessions/downloading-and-finding-data-from-wis2.md - - Querying data using the WIS2Box-api: practical-sessions/data-api-usage-and-queries.md + - Querying data using the wis2box API: practical-sessions/data-api-usage-and-queries.md - Cheatsheets: - Linux: cheatsheets/linux.md - Docker: cheatsheets/docker.md