Skip to content

Commit 228db8a

Browse files
Update documentation and examples for Monty STAC Extension; refine hazard information profiles and add examples index
1 parent 2aeee12 commit 228db8a

File tree

5 files changed

+117
-5
lines changed

5 files changed

+117
-5
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
node_modules/
2-
.venv/
2+
.venv/
3+
site/

docs/model/correlation_identifier.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Where:
5757

5858
- `{datetime}`: The date and time of the event in the format `YYYYMMDDThhmmssZ` ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)).
5959
- `{country_code}`: The country code of the related event in the [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) format.
60-
- `{hazard_cluster_code}`: A code that represents the cluster of the main hazards of the event. This code represents the cluster in the [UNDRR-ISC 2020 Hazard Information Profiles](./taxonomy.md#undrr-isc-2020-hazard-information-profiles). The cluster is slected based on the order of the hazards codes provided.
60+
- `{hazard_cluster_code}`: A code that represents the cluster of the main hazards of the event. This code represents the cluster in the [UNDRR-ISC Hazard Information Profiles](./taxonomy.md#undrr-isc-hazard-information-profiles). The cluster is slected based on the order of the hazards codes provided.
6161
- `{episode_number}`: A number that represents the episode of the event. This number is used to differentiate between events that have the same date, country, and hazard cluster. The episode number starts at 1 and is incremented by 1 for each new event with the same date, country, and hazard cluster.
6262

6363
A reference implementation is provided with the pystac.monty module. *TBD*

docs/model/taxonomy.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ Note: In September 2023, the EM-DAT Classification Tree was updated and simplifi
118118
| tec-tra-roa-roa | Technological | Transport | Road | Road |
119119
| tec-tra-wat-wat | Technological | Transport | Water | Water |
120120

121-
### UNDRR-ISC Hazard Information Profiles
121+
### UNDRR-ISC Hazard Information Profiles {#undrr-isc-hazard-information-profiles}
122122

123123
#### [2025 Update](https://www.undrr.org/media/107380/download?startDownload=20250613)
124124

@@ -209,7 +209,7 @@ The new 2-digit cluster code (positions 3-4) allows grouping related hazards:
209209

210210
This open system allows future hazards to be added within appropriate clusters (e.g., MH0611 for a new flood type).
211211

212-
**Complete 2025 Hazard List:**
212+
#### Complete 2025 Hazard List {#complete-2025-hazard-list}
213213

214214
| Hazard Code | Hazard Label | Cluster ID | Cluster Label | Family Label |
215215
| ----------- | ------------ | ---------- | ------------- | ------------ |
@@ -496,6 +496,7 @@ This open system allows future hazards to be added within appropriate clusters (
496496
| SO0401 | Financial Shock | SOC-ECO | Economic | Societal |
497497

498498
#### [2020 Hazard Information Profiles](https://www.preventionweb.net/drr-glossary/hips) (Historical Reference)
499+
{#undrr-isc-2020-hazard-information-profiles}
499500

500501
| Hazard Code | Hazard Label | Cluster ID | Cluster Label | Family Label |
501502
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------- | ----------------------------------------------------------------- | ---------------------------- |

examples/index.md

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
# Monty STAC Extension Examples
2+
3+
This directory contains example STAC collections and items that demonstrate the implementation of the Monty STAC extension. These examples serve as reference implementations for various disaster data sources and showcase the proper structure and usage of the extension.
4+
5+
## Directory Structure
6+
7+
The examples are organized by data source and collection type:
8+
9+
### Event Collections
10+
11+
Collections that define disaster events from various sources:
12+
13+
- **[desinventar-events/](desinventar-events/)** - DesInventar disaster events
14+
- **[emdat-events/](emdat-events/)** - EM-DAT disaster events
15+
- **[gdacs-events/](gdacs-events/)** - GDACS disaster events
16+
- **[gfd-events/](gfd-events/)** - Global Flood Database events
17+
- **[glide-events/](glide-events/)** - GLIDE disaster events
18+
- **[ibtracs-events/](ibtracs-events/)** - IBTrACS tropical cyclone events
19+
- **[idmc-gidd-events/](idmc-gidd-events/)** - IDMC GIDD displacement events
20+
- **[idmc-idu-events/](idmc-idu-events/)** - IDMC IDU displacement events
21+
- **[ifrcevent-events/](ifrcevent-events/)** - IFRC event data
22+
- **[pdc-events/](pdc-events/)** - Pacific Disaster Center events
23+
- **[reference-events/](reference-events/)** - Reference canonical events
24+
- **[usgs-events/](usgs-events/)** - USGS earthquake events
25+
26+
### Hazard Collections
27+
28+
Collections that contain hazard-specific data and characteristics:
29+
30+
- **[emdat-hazards/](emdat-hazards/)** - EM-DAT hazard data
31+
- **[gdacs-hazards/](gdacs-hazards/)** - GDACS hazard information
32+
- **[gfd-hazards/](gfd-hazards/)** - Global Flood Database hazard data
33+
- **[glide-hazards/](glide-hazards/)** - GLIDE hazard classifications
34+
- **[ibtracs-hazards/](ibtracs-hazards/)** - IBTrACS tropical cyclone hazard data
35+
- **[ifrcevent-hazards/](ifrcevent-hazards/)** - IFRC hazard data
36+
- **[pdc-hazards/](pdc-hazards/)** - Pacific Disaster Center hazard data
37+
- **[usgs-hazards/](usgs-hazards/)** - USGS earthquake hazard data
38+
39+
### Impact Collections
40+
41+
Collections that document the effects and impacts of disasters:
42+
43+
- **[desinventar-impacts/](desinventar-impacts/)** - DesInventar impact data
44+
- **[emdat-impacts/](emdat-impacts/)** - EM-DAT impact statistics
45+
- **[gdacs-impacts/](gdacs-impacts/)** - GDACS impact assessments
46+
- **[gfd-impacts/](gfd-impacts/)** - Global Flood Database impact data
47+
- **[idmc-gidd-impacts/](idmc-gidd-impacts/)** - IDMC GIDD displacement impacts
48+
- **[idmc-idu-impacts/](idmc-idu-impacts/)** - IDMC IDU displacement impacts
49+
- **[ifrcevent-impacts/](ifrcevent-impacts/)** - IFRC impact data
50+
- **[pdc-impacts/](pdc-impacts/)** - Pacific Disaster Center impact data
51+
- **[usgs-impacts/](usgs-impacts/)** - USGS earthquake impact data
52+
53+
## Usage
54+
55+
These examples demonstrate:
56+
57+
1. **Proper STAC Collection Structure** - How to structure collections according to the STAC specification
58+
2. **Monty Extension Implementation** - Correct usage of Monty extension fields and properties
59+
3. **Data Source Integration** - How different disaster data sources can be represented in STAC
60+
4. **Relationship Modeling** - How events, hazards, and impacts relate to each other
61+
5. **Taxonomy Usage** - Implementation of standardized disaster taxonomies
62+
63+
## Collection Types
64+
65+
### Events
66+
67+
Event collections represent discrete disaster occurrences with temporal and spatial bounds. They typically include:
68+
69+
- Event identification and classification
70+
- Temporal information (start/end dates)
71+
- Spatial information (affected areas)
72+
- Links to related hazards and impacts
73+
74+
### Hazards
75+
76+
Hazard collections contain data about the physical phenomena that can cause disasters:
77+
78+
- Hazard type and classification
79+
- Intensity and severity measures
80+
- Temporal evolution
81+
- Spatial extent and characteristics
82+
83+
### Impacts
84+
85+
Impact collections document the consequences of disasters:
86+
87+
- Human impacts (casualties, displacement)
88+
- Economic impacts (damages, losses)
89+
- Social and environmental impacts
90+
- Recovery and response metrics
91+
92+
## Validation
93+
94+
All examples in this directory are validated against:
95+
96+
- [STAC Specification](https://stacspec.org/)
97+
- [Monty STAC Extension Schema](../json-schema/schema.json)
98+
- Taxonomy requirements defined in the [model documentation](../docs/model/)
99+
100+
## Contributing
101+
102+
When adding new examples:
103+
104+
1. Follow the existing directory structure
105+
2. Ensure compliance with the Monty extension schema
106+
3. Include both collection and item examples where applicable
107+
4. Update this index file to reference new examples
108+
5. Validate examples using the provided schema
109+
110+
For more information about the Monty extension and its usage, see the [documentation](../docs/).

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ nav:
6565
- Taxonomy: model/taxonomy.md
6666
- Event Correlation: model/correlation_identifier.md
6767
- Questions: model/questions.md
68-
- Examples: examples/README.md
68+
- Examples: examples/index.md
6969
- STAC API:
7070
- Overview: model/stac-api/README.md
7171
- Correlation Algorithms: model/stac-api/correlation_algorithms.md

0 commit comments

Comments
 (0)