|
1 | | -======= |
2 | | -Welcome |
3 | | -======= |
| 1 | +====================== |
| 2 | +What is WIS2 in a box? |
| 3 | +====================== |
4 | 4 |
|
5 | | -WIS2 in a box (wis2box) is a Free and Open Source (FOSS) Reference Implementation of a WMO WIS2 Node. The project provides a plug and play toolset to ingest, process, and publish weather/climate/water data using standards-based approaches in alignment with the WIS2 principles. wis2box also provides access to all data in the `WIS2 network <https://community.wmo.int/activity-areas/wis>`_. wis2box is designed to have a low barrier to entry for data providers, providing enabling infrastructure and services for data discovery, access, and visualization. |
| 5 | +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. |
6 | 6 |
|
7 | | -wis2box enables World Meteorological Organization (WMO) members to publish and download data through the WIS2 network. The main features are: |
| 7 | +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. |
8 | 8 |
|
9 | | -* WIS2 compliant: easily register your wis2box to WIS2 infrastructure, conformant to WMO data and metadata standards |
10 | | -* WIS2 compliance: enables sharing of data to WIS2 using standards in compliance with WIS2 technical regulations |
11 | | -* event driven or interactive data ingest/process/publishing pipelines |
12 | | -* visualization of stations/data on interactive maps |
13 | | -* discovery metadata management and publishing |
14 | | -* download/access of data from WIS 2 network to your local environment |
15 | | -* standards-based data services and access mechanisms: |
16 | | -* robust and extensible plugin framework. Write your own data processing engines and integrate seamlessly into wis2box! |
17 | | -* Free and Open Source (FOSS) |
18 | | -* containerized: use of Docker, enabling easy deployment to cloud or on-premises infrastructure |
| 9 | +wis2box is Free and Open Source and released under the `Apache License <https://docs.wis2box.wis.wmo.int/en/latest/community/license.html>`_. |
19 | 10 |
|
20 | | -wis2box deployments currently sharing data on the WIS2 network can be found at https://demo.wis2box.wis.wmo.int. |
| 11 | +wis2box consists of multiple software packages that provide all services required to run a WIS2 Node, namely: |
| 12 | + |
| 13 | +- `github.com/wmo-im/wis2box <https://github.com/wmo-im/wis2box>`_ Core services to publish WIS2 Discovery Metadata and Notification Messages |
| 14 | +- `github.com/wmo-im/wis2box-api <https://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 |
| 15 | +- `github.com/wmo-im/wis2box-ui <https://github.com/wmo-im/wis2box-ui>`_ User interface to display datasets and provide visualizations for ingested data |
| 16 | +- `github.com/wmo-im/wis2box-webapp <https://github.com/wmo-im/wis2box-webappp>`_ Web -application to interactively configure wis2box and monitor published data |
| 17 | +- `github.com/wmo-im/wis2box-auth <https://github.com/wmo-im/wis2box-auth>`_ Access control functionality to datasets exposed via wis2box and to apply authentication API services used by wis2box-webapp |
| 18 | +- `github.com/wmo-im/wis2downloader <https://github.com/wmo-im/wis2downloader>`_ Subscription and download capability for access to data published by other WIS2 Nodes |
| 19 | + |
| 20 | +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. |
| 21 | + |
| 22 | +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. |
| 23 | + |
| 24 | +In addition to the wis2box software packages mentioned above, wis2box leverages the following Free and Open Source Software (FOSS): |
| 25 | + |
| 26 | +- storage using `MinIO <https://min.io/docs/minio/container/index.html>`_ |
| 27 | +- MQTT broker using `mosquitto <https://mosquitto.org/>`_ |
| 28 | +- Web proxy using `nginx <https://nginx.org/en/>`_ |
| 29 | +- `OGC API <https://ogcapi.ogc.org/>`_ capability using `pygeoapi <https://pygeoapi.io/>`_ |
| 30 | +- API backend using `Elasticsearch <https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html>`_ |
| 31 | +- Monitoring dashboards using `Grafana <https://grafana.com/docs/grafana/latest/setup-grafana/configure-docker/>`_ |
| 32 | +- Metrics collection using `Prometheus <https://prometheus.io/>`_ |
| 33 | +- Log storage using `Loki <https://grafana.com/docs/loki/latest/setup/install/docker/>`_ |
| 34 | +- WMO format encoding/decoding using `ecCodes <https://confluence.ecmwf.int/display/ECC>`_ |
| 35 | + |
| 36 | +Requirements to run a WIS2 Node using the wis2box deployment bundle: |
| 37 | + |
| 38 | +1. **Host instance that is routed to the public Internet**, hosted in the cloud or in a high-performance on-premise data-centre |
| 39 | +2. **Host OS using Ubuntu with Python, Docker and Docker Compose pre-installed** |
| 40 | + |
| 41 | +Please follow :ref:`getting-started` for more information on the host-requirements and to start running a WIS2 Node using the wis2box deployment bundle. |
21 | 42 |
|
22 | 43 | User guide |
23 | 44 | ========== |
24 | 45 |
|
25 | | -The user guide helps you setup your own wis2box instance. |
| 46 | +The user guide provides step-by-step instructions to start running a WIS2 Node using the wis2box deployment bundle. |
26 | 47 |
|
27 | 48 | .. toctree:: |
28 | 49 | :maxdepth: 1 |
29 | 50 | :caption: User guide |
30 | 51 | :name: toc-user |
31 | 52 |
|
32 | | - user/introduction |
33 | 53 | user/getting-started |
34 | 54 | user/setup |
35 | 55 | user/data-ingest |
|
0 commit comments