What is WIS2 in a box?¶
WIS2 in a box (wis2box) is a Reference Implementation of a WIS2 Node, designed to help accelerate international data and metadata exchange on WIS 2.0.
wis2box was designed to be to be cost-effective and low barrier to operate, to enable any WMO Member to publish and receive internationally exchanged weather data.
wis2box is Free and Open Source and released under the Apache License.
wis2box consists of multiple software packages that provide all services required to run a WIS2 Node, namely:
github.com/wmo-im/wis2box Core services to publish WIS2 Discovery Metadata and Notification Messages
github.com/wmo-im/wis2box-api Application Programming Interface that provides an OGC API to discover, access, and visualize notifications, data -collections and configuration (datasets, stations) and which provides support for data handling of WMO encodings and formats
github.com/wmo-im/wis2box-ui User interface to display datasets and provide visualizations for ingested data
github.com/wmo-im/wis2box-webapp Web -application to interactively configure wis2box and monitor published data
github.com/wmo-im/wis2box-auth Access control functionality to datasets exposed via wis2box and to apply authentication API services used by wis2box-webapp
github.com/wmo-im/wis2downloader Subscription and download capability for access to data published by other WIS2 Nodes
WIS2 in a box is released using a Deployment Bundle that simplifies the setup of a WIS2 Node by providing all required services as Docker containers.
The release archive consists of a set of Docker Compose files and Python scripts, referencing pre-built Docker images stored in the wis2box software repositories on GitHub.
In addition to the wis2box software packages mentioned above, wis2box leverages the following Free and Open Source Software (FOSS):
storage using MinIO
MQTT broker using mosquitto
Web proxy using nginx
API backend using Elasticsearch
Monitoring dashboards using Grafana
Metrics collection using Prometheus
Log storage using Loki
WMO format encoding/decoding using ecCodes
Requirements to run a WIS2 Node using the wis2box deployment bundle:
Host instance that is routed to the public Internet, hosted in the cloud or in a high-performance on-premise data-centre
Host OS using Ubuntu with Python, Docker and Docker Compose pre-installed
Please follow Getting started for more information on the host-requirements and to start running a WIS2 Node using the wis2box deployment bundle.
User guide¶
The user guide provides step-by-step instructions to start running a WIS2 Node using the wis2box deployment bundle.
Reference guide¶
The reference documentation is more complete and programmatic in nature. It contains a comprehensive set of information on wis2box for easy reference.
Community¶
The community documentation provides information on where to find support and how to contribute to wis2box.
Community