Merge pull request #404 from GFDRR/267-climate-data

Add climate data

Author: duncandewhurst

docs/about/changelog.md

@@ -22,6 +22,11 @@ This page lists changes to the Risk Data Library Standard.
 - [#396](https://github.com/GFDRR/rdl-standard/pull/396)
   - `Entity`: Require any of `.email`, `.url`.
   - `Event.ocurrence`: Require any of `.probabilistic`, `.empirical`, `.deterministic`.
+- [#404](https://github.com/GFDRR/rdl-standard/pull/404)
+  - Add `Climate` object to `$defs` with fields for `model`, `scenario` and `percentile`
+  - Add `climate` to `Resource`
+  - Add `baseline_period` to `Resource`
+  - Add `central_year` to `Period`
 - [#398](https://github.com/GFDRR/rdl-standard/pull/398) - Add `spatial_aggregation` to `Resource`.
 - [#400](https://github.com/GFDRR/rdl-standard/pull/400):
   - Move `.sources` to `.lineage.sources`
@@ -63,6 +68,7 @@ This page lists changes to the Risk Data Library Standard.
 - [#384](https://github.com/GFDRR/rdl-standard/pull/384) - Rename non-unique 'loss_ratio' codes in `impact_metric.csv`.
 - [#370](https://github.com/GFDRR/rdl-standard/pull/370) - 'IMT.csv' Expanded list and updated structure.
 - [#373](https://github.com/GFDRR/rdl-standard/pull/373) - 'license.csv' Expanded list and updated structure.
+- [#404](https://github.com/GFDRR/rdl-standard/pull/404) - Add `climate_scenario.csv` as closed codelist.
 - [#397](https://github.com/GFDRR/rdl-standard/pull/397) - Add 'urban' to `spatial_scale.csv`.
 
 ### Normative documentation

docs/reference/codelists.md

@@ -498,6 +498,22 @@ open:
 ```
 ````
 
+### climate_scenario
+
+This codelist is referenced by the following properties:
+
+- [`Climate/scenario`](rdls_schema.json,/$defs/Climate,scenario)
+
+This codelist has the following codes:
+
+````{dropdown} Codes
+```{csv-table-no-translate}
+:header-rows: 1
+:widths: auto
+:file: ../../schema/codelists/closed/climate_scenario.csv
+```
+````
+
 ### country
 
 This codelist is referenced by the following properties:

docs/reference/schema.md

@@ -885,6 +885,7 @@ This sub-schema is referenced by the following properties:
 
 - [`temporal`](rdls_schema.json,,temporal)
 - [`Resource/temporal`](rdls_schema.json,/$defs/Resource,temporal)
+- [`Resource/baseline_period`](rdls_schema.json,/$defs/Resource,baseline_period)
 - [`Event/occurrence/empirical/temporal`](rdls_schema.json,/$defs/Event,occurrence/empirical/temporal)
 
 Each `Period` has the following fields:
@@ -897,6 +898,30 @@ addtargets:
 ---
 ```
 
+### Climate
+
+`Climate` is defined as:
+
+```{jsoninclude-quote} ../../docs/_readthedocs/html/rdls_schema.json
+---
+jsonpointer: /$defs/Climate/description
+---
+```
+
+This sub-schema is referenced by the following properties:
+
+- [`Resource/climate`](rdls_schema.json,/$defs/Resource,climate)
+
+Each `Climate` has the following fields:
+
+```{jsonschema} ../../docs/_readthedocs/html/rdls_schema.json
+---
+pointer: /$defs/Climate
+collapse:
+addtargets:
+---
+```
+
 ### Location
 
 `Location` is defined as:

schema/codelists/closed/climate_scenario.csv

@@ -0,0 +1,13 @@
+code,title,description,ipcc_report,url
+SSP1-1.9,Very Low Emissions (1.9 W/m2),Limits warming to 1.5 degrees C. Requires net zero CO2 around 2050 followed by net negative emissions.,IPCC AR6,https://www.ipcc.ch/report/ar6/wg1/
+SSP1-2.6,Low Emissions (2.6 W/m2),Limits warming to well below 2 degrees C. Strong mitigation with CO2 emissions reaching net zero after 2050.,IPCC AR6,https://www.ipcc.ch/report/ar6/wg1/
+SSP2-4.5,Intermediate Emissions (4.5 W/m2),Intermediate emissions following broadly historical social and economic trends with moderate mitigation.,IPCC AR6,https://www.ipcc.ch/report/ar6/wg1/
+SSP3-7.0,High Emissions (7.0 W/m2),High emissions assuming regional rivalry and no additional climate policies.,IPCC AR6,https://www.ipcc.ch/report/ar6/wg1/
+SSP4-3.4,Low to Intermediate Emissions (3.4 W/m2),Low to intermediate emissions assuming high inequality between and within countries with moderate mitigation efforts.,IPCC AR6,https://www.ipcc.ch/report/ar6/wg1/
+SSP4-6.0,High Emissions (6.0 W/m2),High emissions assuming high inequality between and within countries and limited mitigation.,IPCC AR6,https://www.ipcc.ch/report/ar6/wg1/
+SSP5-3.4,Low to Intermediate Emissions - Overshoot (3.4 W/m2),Overshoot pathway following high emissions before rapid decline to 3.4 W/m2 by 2100. Paired with SSP4-3.4 but assumes fossil-fuel intensive development with late-century mitigation.,IPCC AR6,https://www.ipcc.ch/report/ar6/wg1/
+SSP5-8.5,Very High Emissions (8.5 W/m2),Very high emissions assuming fossil-fuel intensive development and no mitigation. Upper bound of the scenario range.,IPCC AR6,https://www.ipcc.ch/report/ar6/wg1/
+RCP2.6,Very Low Emissions (RCP2.6),Very stringent mitigation pathway requiring net negative greenhouse gas emissions after 2070.,IPCC AR5,https://www.ipcc.ch/report/ar5/wg1/
+RCP4.5,Intermediate Emissions (RCP4.5),Intermediate stabilisation pathway with moderate mitigation efforts.,IPCC AR5,https://www.ipcc.ch/report/ar5/wg1/
+RCP6.0,High Emissions (RCP6.0),Stabilisation pathway in which emissions peak around 2080 then decline.,IPCC AR5,https://www.ipcc.ch/report/ar5/wg1/
+RCP8.5,Very High Emissions (RCP8.5),High-end baseline with continuously rising emissions throughout the 21st century.,IPCC AR5,https://www.ipcc.ch/report/ar5/wg1/

schema/rdls_schema.json

@@ -481,13 +481,13 @@
         },
         "temporal": {
           "title": "Temporal coverage",
-          "description": "The period of time covered by this resource. For more information, refer to [spatial and temporal properties](https://docs.riskdatalibrary.org/en/{{version}}/reference/schema/#spatial-and-temporal-properties).",
+          "description": "The period of time covered by this resource.",
           "$ref": "#/$defs/Period"
         },
         "temporal_resolution": {
           "title": "Temporal resolution",
           "type": "string",
-          "description": "The minimum period of time resolvable in this resources, in ISO8601 duration format. For more information, refer to [spatial and temporal properties](https://docs.riskdatalibrary.org/en/{{version}}/reference/schema/#spatial-and-temporal-properties).",
+          "description": "The minimum period of time resolvable in this resource, in ISO8601 duration format.",
           "format": "duration"
         },
         "access_url": {
@@ -501,6 +501,16 @@
           "type": "string",
           "description": "The web address this resource can be downloaded from in the given `.format`.",
           "minLength": 1
+        },
+        "baseline_period": {
+          "title": "Baseline period",
+          "description": "The baseline or reference period on which a forecast or projection is based.",
+          "$ref": "#/$defs/Period"
+        },
+        "climate": {
+          "title": "Climate",
+          "description": "Information about climate scenarios and models used to create the dataset.",
+          "$ref": "#/$defs/Climate"
         }
       },
       "minProperties": 1
@@ -750,6 +760,55 @@
           "type": "string",
           "description": "The duration of the period in ISO 8601 duration format, e.g. 'P50Y' for 50 years",
           "format": "duration"
+        },
+        "central_year": {
+          "title": "Central year",
+          "type": "integer",
+          "description": "The central or representative year as a single point in time rather than a period (e.g., '2050' representing the period 2040-2060). Use this instead of start/end when data represents conditions centered on a specific year.",
+          "minimum": 1000,
+          "maximum": 9999
+        }
+      },
+      "minProperties": 1
+    },
+    "Climate": {
+      "title": "Climate",
+      "type": "object",
+      "description": "Information about climate scenarios and models used to create the resource.",
+      "properties": {
+        "model": {
+          "title": "Climate model",
+          "type": "string",
+          "description": "The name or identifier of the climate model used to produce this resource",
+          "minLength": 1
+        },
+        "scenario": {
+          "title": "Climate scenario",
+          "type": "string",
+          "description": "The climate scenario under which the data was produced, from the closed [climate_scenario codelist](https://docs.riskdatalibrary.org/en/{{version}}/reference/codelists/#climate_scenario).",
+          "codelist": "climate_scenario.csv",
+          "openCodelist": false,
+          "enum": [
+            "SSP1-1.9",
+            "SSP1-2.6",
+            "SSP2-4.5",
+            "SSP3-7.0",
+            "SSP4-3.4",
+            "SSP4-6.0",
+            "SSP5-3.4",
+            "SSP5-8.5",
+            "RCP2.6",
+            "RCP4.5",
+            "RCP6.0",
+            "RCP8.5"
+          ]
+        },
+        "percentile": {
+          "title": "Percentile",
+          "type": "number",
+          "description": "The percentile of the climate model or model ensemble output represented in this resource, expressed as a number between 0 and 100. For example, 50 indicates the median (50th percentile) of the ensemble.",
+          "minimum": 0,
+          "maximum": 100
         }
       },
       "minProperties": 1