Skip to content

adding-wis2downloader-exercises#173

Merged
alhelguera merged 36 commits into
mainfrom
adding-wis2downloader-exercises
Jun 5, 2026
Merged

adding-wis2downloader-exercises#173
alhelguera merged 36 commits into
mainfrom
adding-wis2downloader-exercises

Conversation

@alhelguera
Copy link
Copy Markdown
Collaborator

Adding the WIS2 Downloader related exercises for the practical sessions in support of the Port of Spain training

@alhelguera alhelguera requested a review from maaikelimper June 4, 2026 09:42
@maaikelimper
Copy link
Copy Markdown
Collaborator

Regarding the text on tunnel at the beginning:

Remove this image, it is showing your localconfigured sessions which looks weird on a public webpage:
http://localhost:8000/assets/img/putty-tunnel-settings.png

You can keep the second image of putty.

Please add one line with the example of setting up tunnel when using SSH in from Linux or Macbook terminal, not everyone is using PuTTy

@maaikelimper
Copy link
Copy Markdown
Collaborator

Use the following download path `/home/{USER}/wis2-downloads` and press Enter to use the defaults for both the user and groups
maybe instead say:
Use the following download path `/home/<username>/wis2-downloads`, replacing <username> with your username. Next press Enter to use the defaults for both the user and groups.

@alhelguera alhelguera requested a review from david-i-berry June 4, 2026 18:56
@maaikelimper
Copy link
Copy Markdown
Collaborator

Replace /home/{USER}/wis2-downloads with ~/wis2-downloads for the "ls -r" and "rm -fr" commands

```bash
pip3 install minio
pip3 install pywiscat==0.4.0
pip3 install pywiscat
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No longer pinning to a version?

```bash
docker run -d --name demo-decode-eccodes-jupyter \
-v ~/wis2box-data/downloads:/root/downloads \
-v ~/wis2-downloads:/root/downloads \
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/root?

!!! note

The current training materials are based on wis2box-release 1.2.0.
The current training materials are based on wis2box-release 1.3.0.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've seen updating the release number in a few places. Do we want to parameterise?


!!! note "About WIS2 Downloader"

The WIS2 Downloader is available as a standalone Docker Compose project and is recommended to be ran on a separate server from the wis2box, so as to not have the downloads interfering with the publication of messages.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Separate server or separate VM? Some concerns were raised previously about the need for another server.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both sound kind of wrong to me. Maybe call it a "separate environment"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

environment is wrong. I would just use "on a separate server or virtual machine".


The WIS2 Downloader is available as a standalone Docker Compose project and is recommended to be ran on a separate server from the wis2box, so as to not have the downloads interfering with the publication of messages.

If you would like to develop your own service for subscribing to WIS2 notifications and downloading data, you can use the [WIS2 Downloader source code](https://github.com/World-Meteorological-Organization/wis2downloader) as a reference.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd recommend the simpler pywis-pubsub


## Preparation and requirements

!!! note "If not during the training"
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does "If not during the training" mean?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That if you are not following the exercise during the training then you don't need to set up any tunnels probably as your setup would be very different

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not true. For example, we make the assumption or direct people to install on an internal network. There may still be the case that someone needs to tunnel from outside to modify subscriptions., for example someone teleworking.

Also, as written it implies that people only need to do the tunneling outside of the training.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change it to "If on a restricted network"?


!!! note "If not during the training"

The following steps are only to be applied if the mentioned ports are unavailable by default on the server. In any configuration, these are the only ports needed to be accessed in order to use the full capabilities of the WIS2 Downloader stack.
Copy link
Copy Markdown
Member

@david-i-berry david-i-berry Jun 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"The following steps only need to be applied if the downloader is run on a different network and the mentioned ports are inaccessible".


## Reviewing the WIS2 Downloader configuration

The WIS2 Downloader instance can be configured using the environment variables defined in your `.env` file.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/can be/is/


You can keep the default configuration for the next exercises.

## WIS2 Downloader API
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How much do we / you want to go into this? The whole point of the UI is to avoid needing to do this.

I would only cover this topic if you have lots of spare time.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if I'll actually use all of the exercises as such. I only want to have it in the page in case someones comes in later and wants to check by themselves in many of them even.

@alhelguera alhelguera requested a review from david-i-berry June 5, 2026 12:53
Copy link
Copy Markdown
Collaborator

@maaikelimper maaikelimper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please check,
rm -fr ~/wis2-downloads/synop-data

vs

rm -fr /home//wis2-downloads/surface-obs

apart from that, approved

@alhelguera alhelguera merged commit 2c6418c into main Jun 5, 2026
@alhelguera alhelguera deleted the adding-wis2downloader-exercises branch June 5, 2026 15:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants