GFDRR · duncandewhurst · Jul 11, 2023 · Jul 4, 2023 · Jul 4, 2023 · Jul 4, 2023
diff --git a/codelists/closed/frequency_distribution.csv b/codelists/closed/frequency_distribution.csv
@@ -0,0 +1,4 @@
+Code,Title,Description
+poisson,Poisson,Data modelled using a poisson distribution.
+negativeBinomial,Negative Binomial,Data modelled using a negative binomial distribution.
+userDefined,User defined,Data modelled using a user defined distribution.
diff --git a/codelists/closed/seasonality.csv b/codelists/closed/seasonality.csv
@@ -0,0 +1,3 @@
+Code,Title
+uniform,Uniform
+userDefined,User defined
diff --git a/docs/about/changelog.md b/docs/about/changelog.md
@@ -23,6 +23,22 @@ This page lists changes to the Risk Data Library Standard.
   - Add validation keywords to `Location`, `Gazetteer_entry` and `Geometry` definitions.
 - [#116](https://github.com/GFDRR/rdl-standard/pull/116) - Replace `biblio_title` and `biblio_url` with `Related_resource` definition.
 - [#115](https://github.com/GFDRR/rdl-standard/pull/115) - Add `Entity` and `Attribution` objects, update entity related field names and descriptions.
+- [#121](https://github.com/GFDRR/rdl-standard/pull/121):
+  - Nest footprints within events and events within event sets.
+  - Update `calculation_method`.
+  - Add fields:
+    - `event_set.id`
+    - `event.id`
+    - `footprint_set.id`
+    - `event_set.disaster_identifier`
+    - `event_set.frequency_distribution`
+    - `event_set.seasonality`
+    - `event_set.calculation_method`
+    - `event_set.number_events`
+    - `event_set.temporal`
+  - Add codelists for `event_set.hazard_type` and `event_set.analysis_type`.
+  - Move `process_type` from `footprint_set` to `event` and `event_set`.
+  - Create `Occurrence` object.
 - [#124](https://github.com/GFDRR/rdl-standard/pull/124):
   - Replace `vulnerability` object with `Vulnerability` definition.
   - Replace `function_type`, `calculation_method`, `approach`, `f_math` and `f_relationship` with `functions` object and `Vulnerability_function`, `Fragility_function`, `Damage_to_loss_function` and `Engineering_demand_function` definitions.
@@ -36,6 +52,7 @@ This page lists changes to the Risk Data Library Standard.
 - [#114](https://github.com/GFDRR/rdl-standard/pull/114) - 'IMT.csv' add descriptions and change pattern of codes to metric:unit.
 - [#117](https://github.com/GFDRR/rdl-standard/pull/117) - Create 'license.csv' codelist and replace `license_code` field with `license`.
 - [#105](https://github.com/GFDRR/rdl-standard/pull/105) - Create 'country.csv', 'location_gazetteers.csv' and 'geometry_type.csv'.
+- [#121](https://github.com/GFDRR/rdl-standard/pull/121) - Create 'frequency_distribution.csv' and 'seasonality.csv'
 - [#130](https://github.com/GFDRR/rdl-standard/pull/130) - 'hazard_type.csv' add descriptions and hazard category which aligns with UNDRR Hazard taxonomy, and update codes from abbreviations to human-readable words.
 - [#134](https://github.com/GFDRR/rdl-standard/pull/134) - 'risk_data_type.csv', replace codes with lower-case versions.
 

diff --git a/docs/reference/codelists.md b/docs/reference/codelists.md
@@ -271,6 +271,18 @@ file: ../../codelists/closed/exposure_category.csv
 ---
 ```
 
+### frequency_distribution
+
+This codelist has the following codes:
+
+```{csv-table-no-translate}
+---
+header-rows: 1
+widths: auto
+file: ../../codelists/closed/frequency_distribution.csv
+---
+```
+
 ### function_approach
 
 This codelist is referenced by the following properties:
@@ -379,6 +391,18 @@ file: ../../codelists/closed/risk_data_type.csv
 ---
 ```
 
+### seasonality
+
+This codelist has the following codes:
+
+```{csv-table-no-translate}
+---
+header-rows: 1
+widths: auto
+file: ../../codelists/closed/seasonality.csv
+---
+```
+
 ### source_type
 
 This codelist is referenced by the following properties:

diff --git a/docs/reference/schema.md b/docs/reference/schema.md
@@ -68,7 +68,7 @@ In addition to schema-specific attributes, each dataset is identified by a list
 
 ```{jsonschema} ../../docs/_readthedocs/html/rdl_schema_0.1.json
 ---
-collapse: spatial,resources
+collapse: spatial,resources,referenced_by,contact_point,creator,attributions
 addtargets:
 ---
 ```
@@ -150,7 +150,7 @@ The hazard dataset could include one or more footprints for the same event, wher
 ```{jsonschema} ../../docs/_readthedocs/html/rdl_schema_0.1.json
 ---
 pointer: /anyOf/0/properties/hazard
-collapse:
+collapse: event_sets
 addtargets:
 ---
 ```
@@ -243,7 +243,7 @@ Additional **tags** attributes can be associated with an asset to link any infor
 ```{jsonschema} ../../docs/_readthedocs/html/rdl_schema_0.1.json
 ---
 pointer: /anyOf/1/properties/exposure
-collapse:
+collapse: cost
 addtargets:
 ---
 ```
@@ -458,26 +458,6 @@ Insert example of recorded empirical losses.
 
 ## Sub-schemas
 
-### Exposure
-
-`Exposure` is defined as:
-
-```{jsoninclude-quote} ../../docs/_readthedocs/html/rdl_schema_0.1.json
----
-jsonpointer: /$defs/Exposure/description
----
-```
-
-Each `Exposure` has the following fields:
-
-```{jsonschema} ../../docs/_readthedocs/html/rdl_schema_0.1.json
----
-pointer: /$defs/Exposure
-collapse: category,taxonomy,cost
-addtargets:
----
-```
-
 ### Cost
 
 `Cost` is defined as:
@@ -638,6 +618,40 @@ addtargets:
 ---
 ```
 
+### Event_set
+
+`Event_set` is defined as:
+
+```{jsoninclude-quote} ../../docs/_readthedocs/html/rdl_schema_0.1.json
+---
+jsonpointer: /$defs/Event_set/description
+---
+```
+
+Each `Event_set` has the following fields:
+
+```{jsonschema} ../../docs/_readthedocs/html/rdl_schema_0.1.json
+---
+pointer: /$defs/Event_set
+collapse: 
+  id,hazards,analysis_type,frequency_distribution,seasonality,calculation_method,event_count,occurrence_range,spatial,temporal,events
+addtargets:
+---
+```
+
+### Event
+
+Each `Event` has the following fields:
+
+```{jsonschema} ../../docs/_readthedocs/html/rdl_schema_0.1.json
+---
+pointer: /$defs/Event
+collapse: 
+  id,disaster_identifier,calculation_method,hazard,occurrence,description,footprints
+addtargets:
+---
+```
+
 ### Vulnerability
 
 `Vulnerability` is defined as:
@@ -699,6 +713,26 @@ addtargets:
 ---
 ```
 
+### Occurrence
+
+`Occurrence` is defined as:
+
+```{jsoninclude-quote} ../../docs/_readthedocs/html/rdl_schema_0.1.json
+---
+jsonpointer: /$defs/Occurrence/description
+---
+```
+
+Each `Occurrence` has the following fields:
+
+```{jsonschema} ../../docs/_readthedocs/html/rdl_schema_0.1.json
+---
+pointer: /$defs/Occurrence
+collapse: probabilistic,empirical,deterministic
+addtargets:
+---
+```
+
 ### Damage_to_loss_function
 
 `Damage_to_loss_function` is defined as:
@@ -719,6 +753,26 @@ addtargets:
 ---
 ```
 
+### Probabilistic
+
+`Probabilistic` is defined as:
+
+```{jsoninclude-quote} ../../docs/_readthedocs/html/rdl_schema_0.1.json
+---
+jsonpointer: /$defs/Probabilistic/description
+---
+```
+
+Each `Probabilistic` has the following fields:
+
+```{jsonschema} ../../docs/_readthedocs/html/rdl_schema_0.1.json
+---
+pointer: /$defs/Probabilistic
+collapse: return_period,event_rate,probability
+addtargets:
+---
+```
+
 ### Engineering_demand_function
 
 `Engineering_demand_function` is defined as:
@@ -739,6 +793,26 @@ addtargets:
 ---
 ```
 
+### Probability
+
+`Probability` is defined as:
+
+```{jsoninclude-quote} ../../docs/_readthedocs/html/rdl_schema_0.1.json
+---
+jsonpointer: /$defs/Probability/description
+---
+```
+
+Each `Probability` has the following fields:
+
+```{jsonschema} ../../docs/_readthedocs/html/rdl_schema_0.1.json
+---
+pointer: /$defs/Probability
+collapse: value,span
+addtargets:
+---
+```
+
 ### Impact
 
 `Impact` is defined as:
@@ -779,6 +853,26 @@ addtargets:
 ---
 ```
 
+### Footprint
+
+`Footprint` is defined as:
+
+```{jsoninclude-quote} ../../docs/_readthedocs/html/rdl_schema_0.1.json
+---
+jsonpointer: /$defs/Footprint/description
+---
+```
+
+Each `Footprint` has the following fields:
+
+```{jsonschema} ../../docs/_readthedocs/html/rdl_schema_0.1.json
+---
+pointer: /$defs/Footprint
+collapse: id,intensity_measure,data_uncertainty
+addtargets:
+---
+```
+
 ### Source
 
 `Source` is defined as:
@@ -798,3 +892,83 @@ collapse: id,name,url,type,component
 addtargets:
 ---
 ```
+
+### Hazard
+
+`Hazard` is defined as:
+
+```{jsoninclude-quote} ../../docs/_readthedocs/html/rdl_schema_0.1.json
+---
+jsonpointer: /$defs/Hazard/description
+---
+```
+
+Each `Hazard` has the following fields:
+
+```{jsonschema} ../../docs/_readthedocs/html/rdl_schema_0.1.json
+---
+pointer: /$defs/Hazard
+collapse: id,type,processes,intensity_measure,trigger
+addtargets:
+---
+```
+
+### Trigger
+
+`Trigger` is defined as:
+
+```{jsoninclude-quote} ../../docs/_readthedocs/html/rdl_schema_0.1.json
+---
+jsonpointer: /$defs/Trigger/description
+---
+```
+
+Each `Trigger` has the following fields:
+
+```{jsonschema} ../../docs/_readthedocs/html/rdl_schema_0.1.json
+---
+pointer: /$defs/Trigger
+collapse: type,processes
+addtargets:
+---
+```
+
+### Empirical
+
+`Empirical` is defined as:
+
+```{jsoninclude-quote} ../../docs/_readthedocs/html/rdl_schema_0.1.json
+---
+jsonpointer: /$defs/Empirical/description
+---
+```
+
+Each `Empirical` has the following fields:
+
+```{jsonschema} ../../docs/_readthedocs/html/rdl_schema_0.1.json
+---
+pointer: /$defs/Empirical
+collapse: temporal,return_period
+addtargets:
+---
+```
+
+### Deterministic
+
+`Deterministic` is defined as:
+
+```{jsoninclude-quote} ../../docs/_readthedocs/html/rdl_schema_0.1.json
+---
+jsonpointer: /$defs/Deterministic/description
+---
+```
+
+Each `Deterministic` has the following fields:
+
+```{jsonschema} ../../docs/_readthedocs/html/rdl_schema_0.1.json
+---
+pointer: /$defs/Deterministic
+collapse: index_criteria,thresholds
+addtargets:
+---
+```
diff --git a/manage.py b/manage.py
@@ -308,8 +308,8 @@ def update_schema_docs(schema):
   for defn, definition in schema["$defs"].items():
       definition["content"] = definition.get("content", [])
 
-      # Omit Resource definition and string definitions, which will be moved to CSV codelists
-      if defn != 'Resource' and definition.get('type') == 'object':
+      # Omit Resource and Exposure definitions and string definitions, which will be moved to CSV codelists
+      if defn not in ['Resource', 'Hazard_metadata', 'Exposure'] and definition.get('type') == 'object':
 
         # Add heading
         definition["content"].insert(0, f"### {defn}\n")

diff --git a/pull_request_template.md b/pull_request_template.md
@@ -16,3 +16,7 @@
 If you added or removed a field:
 
 - [ ] Update the `collapse` option of the jsonschema directives for dataset, resource, hazard, exposure, vulnerability and loss on `reference/schema.md`
+
+**Having trouble?**
+
+See [how to resolve check failures](https://github.com/GFDRR/rdl-standard/blob/dev/developer_docs.md#resolve-check-failures).