Quickstart

Download wis2box and start using Malawi test data:

git clone https://github.com/wmo-im/wis2box.git
cd wis2box

For the purposes of a quickstart, this deployment expects the test environment, which includes data and metadata, and runs on localhost. This is done by using the test environment file:

cp tests/test.env dev.env
vi dev.env

Note

For more information on deployment, see Administration and Configuration

Start wis2box with Docker Compose and login to the wis2box container:

python3 wis2box-ctl.py start
python3 wis2box-ctl.py status --all # The --all flag shows all containers, even ones that are down.
python3 wis2box-ctl.py login

Once logged in, create the enviroment and verify it is correct:

wis2box environment create
wis2box environment show

Setup observation data processing and API publication:

wis2box data setup --topic-hierarchy data.core.observations-surface-land.mw.FWCL.landFixed
wis2box api add-collection --topic-hierarchy data.core.observations-surface-land.mw.FWCL.landFixed $WIS2BOX_DATADIR/metadata/discovery/surface-weather-observations.yml

Publish station collection and discovery metadata to the API:

wis2box metadata discovery publish $WIS2BOX_DATADIR/metadata/discovery/surface-weather-observations.yml
wis2box metadata station cache $WIS2BOX_DATADIR/metadata/station/station_list.csv
wis2box metadata station publish-collection

Ingest and publish data via command-line interface (CLI) or an MQTT event driven workflow:

# CLI
wis2box data ingest --topic-hierarchy data.core.observations-surface-land.mw.FWCL.landFixed --path $WIS2BOX_DATADIR/observations
# OR
# Event driven
cp $WIS2BOX_DATADIR/observations/* $WIS2BOX_DATADIR/data/incoming/data/core/observations-surface-land/mw/FWCL/landFixed

Re-publish the stations collection to additionally include link relations to collections with observations published from that station:

wis2box metadata station publish-collection

Logout of wis2box container:

exit

From here, you can run python3 wis2box-ctl.py status to confirm that containers are running.

To explore your wis2box installation and services, visit http://localhost:8999 in your web browser.