Skip to content

Commit 4c3ffd5

Browse files
ranjan-stharanjan-stha
committed
Chore: add alerthub documentation
1 parent c1479b0 commit 4c3ffd5

1 file changed

Lines changed: 80 additions & 0 deletions

File tree

‎docs/model/sources/AlertHub/README.md‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# AlertHub
2+
3+
The aim of IFRC Alert Hub is to provide timely and effective emergency alerts to communities worldwide, empowering them to protect their lives and livelihoods.
4+
5+
## Collection: `alerthub-events`
6+
7+
A STAC collection hold all the AlertHub events. An example of the AlertHub collection is [here](https://github.com/IFRCGo/monty-stac-extension/blob/main/examples/alerthub-events/alerthub-events.json)
8+
9+
- Name: AlertHub
10+
- Code: `AlertHub`
11+
- Source organisation: IFRC
12+
- Source code: alerthub
13+
- Source type: IFRC
14+
- Source organization email: im@ifrc.org
15+
- Source URL: <alerthub.ifrc.org>
16+
- Source Data license: MIT License
17+
- Source for: event, hazard
18+
19+
### Data
20+
21+
The data from Alerthub can be accessed using the GraphQL queries. The data is currently fetched using the query `Alerts` from the following [data source](https://alerthub-api.ifrc.org/graphql/).
22+
23+
### Event Item
24+
25+
An AlertHub event and episode will **ALWAYS** produce and [event STAC item](https://github.com/IFRCGo/monty-stac-extension#event). Here is a table with the fields that are mapped from the AlertHub event to the STAC event.
26+
27+
| STAC field | AlertHub | Field Description |
28+
|------------|----------|--------------------|
29+
| [id](https://github.com/radiantearth/stac-spec/blob/master/item-spec/item-spec.md#id) | alert.id | Unique identifier for the event |
30+
| [geometry](https://github.com/radiantearth/stac-spec/blob/master/item-spec/item-spec.md#geometry) | alert.info.areas | Geometry of the event |
31+
| [bbox](https://github.com/radiantearth/stac-spec/blob/master/item-spec/item-spec.md#bbox) | From geometry | Bbox is constructed using geometry data using bounds |
32+
| [collection](https://github.com/radiantearth/stac-spec/blob/master/item-spec/item-spec.md#collection) | `alerthub-events` | The collection for AlertHub events |
33+
| [title](https://github.com/radiantearth/stac-spec/blob/master/commons/common-metadata.md#basics) | alert.headline | Short description of the event |
34+
| [description](https://github.com/radiantearth/stac-spec/blob/master/commons/common-metadata.md#basics) | alert.description | Description of the event |
35+
| [datetime](https://github.com/radiantearth/stac-spec/blob/master/commons/common-metadata.md#date-and-time) | alert.effective | Date and time of the event converted in UTC ISO 8601 format |
36+
| [start_datetime](https://github.com/radiantearth/stac-spec/blob/master/commons/common-metadata.md#date-and-time-range) | alert.effective | Date and time of the event converted in UTC ISO 8601 format |
37+
| [end_datetime](https://github.com/radiantearth/stac-spec/blob/master/commons/common-metadata.md#date-and-time-range) | alert.expires | End date of the event converted in UTC ISO 8601 format |
38+
| [monty:episode_number](https://ifrcgo.org/monty-stac-extension/v1.0.0/schema.json#monty:episode_number) | 1 | Set to 1 as there is no proper episodes handling mechanism |
39+
| [monty:country_codes](https://github.com/IFRCGo/monty-stac-extension#montycountry_codes)\[0] | alert.country.iso3 | ISO3 of the country |
40+
| [monty:hazard_codes](https://github.com/IFRCGo/monty-stac-extension#montyhazard_codes) | alert.category, alert.event | List of hazard codes |
41+
| [`via` link](https://github.com/radiantearth/stac-spec/blob/master/commons/assets.md) in \[links] | alert.url | Link to the GDACS event details page |
42+
| [monty:corr_id](https://ifrcgo.org/monty-stac-extension/v1.1.1/schema.json#monty:corr_id) | Generated | Generated following the [event correlation](../../correlation_identifier.md) convention |
43+
| [monty:guid](https://ifrcgo.org/monty-stac-extension/v1.1.1/schema.json#monty:guid) | Generated | Generated following the [guid string](../../global_identififer.md) convention |
44+
45+
46+
### Hazard Item
47+
48+
An AlertHub will **ALWAYS** produce one [**hazard STAC item**] (https://github.com/IFRCGo/monty-stac-extension#hazard).
49+
50+
Here is a table with the STAC fields that are mapped from the AlertHub event to STAC hazard.
51+
52+
| STAC field | AlertHub | Field Description |
53+
|------------|----------|--------------------|
54+
| [id](https://github.com/radiantearth/stac-spec/blob/master/item-spec/item-spec.md#id) | alert.id | Unique identifier for the event |
55+
| [geometry](https://github.com/radiantearth/stac-spec/blob/master/item-spec/item-spec.md#geometry) | alert.info.areas | Geometry of the event |
56+
| [bbox](https://github.com/radiantearth/stac-spec/blob/master/item-spec/item-spec.md#bbox) | From geometry | Bbox is constructed using geometry data using bounds |
57+
| [collection](https://github.com/radiantearth/stac-spec/blob/master/item-spec/item-spec.md#collection) | `alerthub-hazards` | The collection for AlertHub events |
58+
| [title](https://github.com/radiantearth/stac-spec/blob/master/commons/common-metadata.md#basics) | alert.headline | Short description of the event |
59+
| [description](https://github.com/radiantearth/stac-spec/blob/master/commons/common-metadata.md#basics) | alert.description | Description of the event |
60+
| [datetime](https://github.com/radiantearth/stac-spec/blob/master/commons/common-metadata.md#date-and-time) | alert.effective | Date and time of the event converted in UTC ISO 8601 format |
61+
| [start_datetime](https://github.com/radiantearth/stac-spec/blob/master/commons/common-metadata.md#date-and-time-range) | alert.effective | Date and time of the event converted in UTC ISO 8601 format |
62+
| [end_datetime](https://github.com/radiantearth/stac-spec/blob/master/commons/common-metadata.md#date-and-time-range) | alert.expires | End date of the event converted in UTC ISO 8601 format |
63+
| [monty:episode_number](https://ifrcgo.org/monty-stac-extension/v1.0.0/schema.json#monty:episode_number) | 1 | Set to 1 as there is no proper episodes handling mechanism |
64+
| [monty:country_codes](https://github.com/IFRCGo/monty-stac-extension#montycountry_codes)\[0] | alert.country.iso3 | ISO3 of the country |
65+
| [monty:hazard_codes](https://github.com/IFRCGo/monty-stac-extension#montyhazard_codes) | alert.category, alert.event | List of hazard codes |
66+
| [`via` link](https://github.com/radiantearth/stac-spec/blob/master/commons/assets.md) in \[links] | alert.url | Link to the GDACS event details page |
67+
| [monty:corr_id](https://ifrcgo.org/monty-stac-extension/v1.1.1/schema.json#monty:corr_id) | Generated | Generated following the [event correlation](../../correlation_identifier.md) convention |
68+
| [monty:guid](https://ifrcgo.org/monty-stac-extension/v1.1.1/schema.json#monty:guid) | Generated | Generated following the [guid string](../../global_identififer.md) convention |
69+
| [monty:hazard_detail](https://github.com/IFRCGo/monty-stac-extension#montyhazard_detail) | alert.info.severity | Severity Info |
70+
71+
72+
#### Hazard Detail
73+
74+
The [hazard_detail](https://github.com/IFRCGo/monty-stac-extension#montyhazard_detail) field is a JSON object that contains the detailed information about the hazard. The object is a mapping of the hazard codes to the detailed information. The detailed information is a JSON object with the following fields:
75+
76+
| STAC field | AlertHub field | Description |
77+
| -------------- | ---------------------------- | --------------------------------------------------------- |
78+
| severity_value | Uses a severity mappings | Five enums are mapped to a numeric value |
79+
| severity_unit | `alerthub` | AlertHub alert level |
80+
| estimate_type | MontyEstimateType.PRIMARY | Use a fixed value |

0 commit comments

Comments
 (0)