diff --git a/.gitmodules b/.gitmodules index 91a432db..373d5356 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +1,6 @@ [submodule "docs/_static/docson"] path = docs/_static/docson url = https://github.com/OpenDataServices/docson +[submodule "flatten-tool"] + path = flatten-tool + url = https://github.com/OpenDataServices/flatten-tool/ diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 3dfe2980..c4b37e8a 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,6 +8,9 @@ version: 2 # Set the version of Python and other tools you might need build: os: ubuntu-22.04 + apt_packages: + - default-jdk + - graphviz tools: python: "3.9" # You can also specify other tool versions: diff --git a/developer_docs.md b/developer_docs.md index 0da48a5c..035b05e9 100644 --- a/developer_docs.md +++ b/developer_docs.md @@ -17,6 +17,7 @@ This section contains the following how-to guides: * [Deploy changes](#deploy-changes) * [Release a new version](#release-a-new-version) * [Update requirements](#update-requirements) +* [Add an RDLS metadata example](#add-an-rdls-metadata-example) ### Propose changes @@ -47,7 +48,7 @@ cd rdl-standard Subsequent instructions assume that your current working directory is `rdl-standard`, unless otherwise stated. -#### Install submodules +#### Update submodules ```bash git submodule init @@ -106,6 +107,12 @@ pip install --upgrade pip setuptools pip install -r requirements.txt ``` +Install Flatten Tool: + +```bash +pip install ./flatten-tool +``` + ### Resolve check failures #### mdformat @@ -202,8 +209,39 @@ To deploy the `dev` branch to the live documentation site, [create a pull reques ``` 1. Commit your changes. + +## Add an RDLS metadata example + +1. Author your example RDLS metadata in JSON format. You can use either a text editor or the [RDLS spreadsheet template](https://github.com/GFDRR/rdls-spreadsheet-template/) and [Flatten Tool](https://flatten-tool.readthedocs.io/en/latest/). Your example RDLS metadata must be wrapped in an outer `datasets` array, e.g. + +```json +{ + "datasets": [ + { + "id": "1", + "title": "My example RDLS metadata" + } + ] +} +``` +1. Save your example JSON file to `examples/{component}/{title}/example.json` where `{component}` is the risk data component the example relates to (hazard, exposure, loss or vulnerability) and `{title}` is the title of the example. +1. Run `./manage.py pre-commit` to create a CSV version of the example. +1. Add Sphinx directives to the Markdown files in `docs` to render your example in the built documentation. + ## Style guides +### Schema style guide + +#### Field descriptions + +##### Codelists + +Use the following template, noting that any `_` characters in the codelist title need to be replaced with the `-` character in the codelist URL: + +``` +The , from the [ codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#codelist-title). +``` + ### Changelog style guide - Use the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format. @@ -258,7 +296,8 @@ Feature branches branch off the `dev` branch, with work merged into the `dev` br - `.tx/`: Transifex configuration (not yet implemented) - `img/`: Images used in the documentation - `locale/`: Translations of the English documentation (not yet implemented) -- `schema/`: schema-related files +- `examples`: Example JSON files, CSV files and figures +- `schema/`: schema- and codelist-related files - `specs/`: TBD - `SteeringCommittee/`: Minutes of steering committee meetings diff --git a/docs/_static/extra.css b/docs/_static/extra.css index 31856b06..58c03ec1 100644 --- a/docs/_static/extra.css +++ b/docs/_static/extra.css @@ -60,7 +60,9 @@ margin-bottom: 20px; margin-bottom: 20px; margin-right: 20px; } - +.wy-nav-content { + max-width: 1000px !important; +} .wy-side-nav-search { background-color: #0b3860; } @@ -71,4 +73,10 @@ margin-right: 20px; svg[id^="mermaid-"] { width: 100%; max-width: 80em; -} \ No newline at end of file +} +.wy-table-responsive table th { + white-space: pre; +} +.wy-table-responsive table td { + white-space: normal !important; +} diff --git a/docs/_static/json-example-format.js b/docs/_static/json-example-format.js new file mode 100644 index 00000000..25fe3a52 --- /dev/null +++ b/docs/_static/json-example-format.js @@ -0,0 +1,36 @@ + $( document ).ready(function() { + $(".expandjson").each(function(){ + classList = $(this).attr("class").split(/\s+/); + expand = [] + $.each(classList, function(index, item) { + if (item.indexOf('expand') === 0) { + expand.push(item.replace('expand-','')) + } + if (item.indexOf('file') === 0) { + filename = item + } + }); + jsontext = $(this).text().trim() + json = JSON.parse(jsontext) + if(json.length) { + json = json[0] + } + $(this).html(renderjson.set_show_to_level(1).set_max_string_length(100).set_default_open(expand)(json)) + if($(this).siblings(".selection-container").length === 0) { // NEED TO FIX THE CODE HERE. MOVE THINGS INTO THE PARENT CLASS CORRECTLY! + id = Math.floor(5 * (Math.random() % 1)); + $(this).wrap("
") + $(this).parent().prepend( + $("") + .change(function(){ + $(this).siblings(".expandjson").hide(); + $(this).siblings("."+ $(this).val()).show(); + })) + $(this).siblings("select").append($("").attr("value",filename).text(filename.replace("file-",""))) + } else { + container = $(this).siblings(".selection-container") + $(this).detach().appendTo(container) + $(this).siblings("select").append($("").attr("value",filename).text(filename.replace("file-",""))) + $(this).hide() + } + }); + }); diff --git a/docs/_static/renderjson.css b/docs/_static/renderjson.css new file mode 100644 index 00000000..0f7b1b61 --- /dev/null +++ b/docs/_static/renderjson.css @@ -0,0 +1,11 @@ +pre.renderjson { overflow: scroll; font-size:smaller; border: 1px solid #e1e4e5; padding: 12px; background-color: #eeffcc;} +.renderjson a { text-decoration: none; } +.renderjson .disclosure { color: grey; font-size: 150%; } +.renderjson .syntax { color: grey; } +.renderjson .string { color: #4070a0; } +.renderjson .number { color: darkcyan; } +.renderjson .boolean { color: blueviolet; } +.renderjson .key { color: #062873; font-weight: bold;} +.renderjson .keyword { color: blue; } +.renderjson .object.syntax { color: grey; } +.renderjson .array.syntax { color: grey; } diff --git a/docs/_static/renderjson.js b/docs/_static/renderjson.js new file mode 100644 index 00000000..03970242 --- /dev/null +++ b/docs/_static/renderjson.js @@ -0,0 +1,194 @@ +// Copyright © 2013-2014 David Caldwell +// +// Permission to use, copy, modify, and/or distribute this software for any +// purpose with or without fee is hereby granted, provided that the above +// copyright notice and this permission notice appear in all copies. +// +// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY +// SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION +// OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN +// CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + +// Usage +// ----- +// The module exports one entry point, the `renderjson()` function. It takes in +// the JSON you want to render as a single argument and returns an HTML +// element. +// +// Options +// ------- +// renderjson.set_icons("+", "-") +// This Allows you to override the disclosure icons. +// +// renderjson.set_show_to_level(level) +// Pass the number of levels to expand when rendering. The default is 0, which +// starts with everything collapsed. As a special case, if level is the string +// "all" then it will start with everything expanded. +// +// renderjson.set_max_string_length(length) +// Strings will be truncated and made expandable if they are longer than +// `length`. As a special case, if `length` is the string "none" then +// there will be no truncation. The default is "none". +// +// renderjson.set_sort_objects(sort_bool) +// Sort objects by key (default: false) +// +// Theming +// ------- +// The HTML output uses a number of classes so that you can theme it the way +// you'd like: +// .disclosure ("⊕", "⊖") +// .syntax (",", ":", "{", "}", "[", "]") +// .string (includes quotes) +// .number +// .boolean +// .key (object key) +// .keyword ("null", "undefined") +// .object.syntax ("{", "}") +// .array.syntax ("[", "]") + +var module; +(module||{}).exports = renderjson = (function() { + var themetext = function(/* [class, text]+ */) { + var spans = []; + while (arguments.length) + spans.push(append(span(Array.prototype.shift.call(arguments)), + text(Array.prototype.shift.call(arguments)))); + return spans; + }; + var append = function(/* el, ... */) { + var el = Array.prototype.shift.call(arguments); + for (var a=0; a 0) + show(); + return el; + + }; + + if (json === null) return themetext(null, my_indent, "keyword", "null"); + if (json === void 0) return themetext(null, my_indent, "keyword", "undefined"); + + if (typeof(json) == "string" && json.length > max_string) + return disclosure('"', json.substr(0,max_string)+" ...", '"', "string", function () { + return append(span("string"), themetext(null, my_indent, "string", JSON.stringify(json))); + }); + + if (typeof(json) != "object") // Strings, numbers and bools + return themetext(null, my_indent, typeof(json), JSON.stringify(json)); + + if (json.constructor == Array) { + if (json.length == 0) return themetext(null, my_indent, "array syntax", "[]"); + + return disclosure("[", " ... ", "]", "array", function () { + var as = append(span("array"), themetext("array syntax", "[", null, "\n")); + for (var i=0; i -1) ? show_level + 1 : show_level - 1 ), max_string, sort_objects), + k != last ? themetext("syntax", ",") : [], + text("\n")); + } + append(os, themetext(null, indent, "object syntax", "}")); + return os; + }); + } + + var renderjson = function renderjson(json) + { + var pre = append(document.createElement("pre"), _renderjson(json, "", false, renderjson.show_to_level, renderjson.max_string_length, renderjson.sort_objects)); + pre.className = "renderjson"; + return pre; + } + renderjson.set_icons = function(show, hide) { renderjson.show = show; + renderjson.hide = hide; + return renderjson; }; + renderjson.set_show_to_level = function(level) { renderjson.show_to_level = typeof level == "string" && + level.toLowerCase() === "all" ? Number.MAX_VALUE + : level; + return renderjson; }; + renderjson.set_max_string_length = function(length) { renderjson.max_string_length = typeof length == "string" && + length.toLowerCase() === "none" ? Number.MAX_VALUE + : length; + return renderjson; }; + renderjson.set_sort_objects = function(sort_bool) { renderjson.sort_objects = sort_bool; + return renderjson; }; + // Backwards compatiblity. Use set_show_to_level() for new code. + renderjson.set_show_by_default = function(show) { renderjson.show_to_level = show ? Number.MAX_VALUE : 0; + return renderjson; }; + + //Added by timgdavies + renderjson.set_default_open = function(node_list) { renderjson.default_open = node_list ? node_list : [] ; return renderjson; }; + + renderjson.set_icons('⊕', '⊖'); + renderjson.set_show_by_default(false); + renderjson.set_sort_objects(false); + renderjson.set_max_string_length("none"); + renderjson.set_default_open([]); + return renderjson; +})(); \ No newline at end of file diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html index 6fceec14..4f0d56e8 100644 --- a/docs/_templates/layout.html +++ b/docs/_templates/layout.html @@ -1,4 +1,4 @@ {% extends "!layout.html" %} -{% set css_files = css_files + ["_static/basic.css"] %} - +{% set css_files = css_files + ["_static/renderjson.css", "_static/jsonschema.css"] %} +{% set script_files = script_files + ["_static/renderjson.js", "_static/json-example-format.js"] %} diff --git a/docs/about/changelog.md b/docs/about/changelog.md index 07a62d8d..e2ce68e7 100644 --- a/docs/about/changelog.md +++ b/docs/about/changelog.md @@ -61,12 +61,32 @@ This page lists changes to the Risk Data Library Standard. - Required fields in `Event_set`, `Hazard` and `Footprint` - Markdown syntax in `Attribution.role` description - [#190](https://github.com/GFDRR/rdl-standard/pull/190) - Deletes type key from properties with `$ref` components. -- [#203](https://github.com/GFDRR/rdl-standard/pull/203) - Add package schema. - [#206](https://github.com/GFDRR/rdl-standard/pull/206) - Add link to assigning dataset identifier guidance to `id` description. +- [#212](https://github.com/GFDRR/rdl-standard/pull/212) - Update top-level `description`. +- [#203](https://github.com/GFDRR/rdl-standard/pull/203), [#228](https://github.com/GFDRR/rdl-standard/pull/228) - Add package schema. +- [#204](https://github.com/GFDRR/rdl-standard/pull/204), [#229](https://github.com/GFDRR/rdl-standard/pull/229): + - Add field `metrics`. + - rename cost_type.csv to metric_dimension.csv and update code descriptions. + - Add quantity_kind.csv. +- [#207](https://github.com/GFDRR/rdl-standard/pull/207): + - update description of `spatial` to recommend use of `bbox` when coordinates based location is needed. + - update descriptions of `spatial`, `bbox`, `centroid` and `coordinates` to specify use of WGS84 and decimal degrees. + - update `coordinates` to allow only numbers within arrays. +- [#208](https://github.com/GFDRR/rdl-standard/pull/208) - Add regex pattern to `coordinate_system` and update description to mandate ESRI or EPSG codes. +- [#205](https://github.com/GFDRR/rdl-standard/pull/205) - Convert `risk_data_type` to array. +- [#215](https://github.com/GFDRR/rdl-standard/pull/219) - Remove `.hazard_id`, `exposure_id` and `vulnerability_id` from `loss` required array. +- [#210](https://github.com/GFDRR/rdl-standard/pull/210) - Replace `resource.`url with `.access_url` and `download_url` +- [#218](https://github.com/GFDRR/rdl-standard/pull/218) - `Vulnerability·taxonomy` removed from required array. +- [#220](https://github.com/GFDRR/rdl-standard/pull/220) - Reorder top-level fields. +- [#233](https://github.com/GFDRR/rdl-standard/pull/233), [#235](https://github.com/GFDRR/rdl-standard/pull/235) - Rename authorNames to `author_names`, datePublished to `date_published` and gazetteerEntries to `gazetteer_entries`. +- [#232](https://github.com/GFDRR/rdl-standard/pull/232) + - Convert `disaster_identifiers` to array of `Classification` objects. + - Add new codes to classification_scheme.csv. +- [#236](https://github.com/GFDRR/rdl-standard/pull/236) - Fix broken codelist reference URLs. ### Codelists -- [#101](https://github.com/GFDRR/rdl-standard/pull/101) - update and rename cost_type.csv, create exposure_category.csv +- [#101](https://github.com/GFDRR/rdl-standard/pull/101) - Update and rename `cost_type.csv` and create `exposure_category.csv`. - [#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'. @@ -76,6 +96,8 @@ This page lists changes to the Risk Data Library Standard. - [#143](https://github.com/GFDRR/rdl-standard/pull/143) - Update 'license.csv' to include Open Definition conformant licences and those listed as options on WB Data Catalog. - [#164](https://github.com/GFDRR/rdl-standard/pull/164) - replace camelCase codes with snake_case codes in 'frequency_distribution.csv' and 'seasonality.csv' - [#189](https://github.com/GFDRR/rdl-standard/pull/189) - add 'ISO 3166-1 alpha-3' to 'location_gazetteers.csv and 'generalized_extreme_value' to 'frequency_distribution.csv' +- [#136](https://github.com/GFDRR/rdl-standard/issues/136)- add description for secondary_rupture. +- [#214](https://github.com/GFDRR/rdl-standard/pull/214) - use consistent separators in `classification_scheme.csv` codes. ### Normative documentation @@ -87,12 +109,18 @@ This page lists changes to the Risk Data Library Standard. - [#169](https://github.com/GFDRR/rdl-standard/pull/169) - Uncollapse `event_sets` in `hazard` reference table. - [#146](https://github.com/GFDRR/rdl-standard/pull/146) - Update introduction to the RDLS reference section. - [#193](https://github.com/GFDRR/rdl-standard/pull/193) - Fix lists of referencing fields for subschemas and codelists. +- [#212](https://github.com/GFDRR/rdl-standard/pull/212) - Update diagrams, add descriptions for dataset, resource and risk components. +- [#225](https://github.com/GFDRR/rdl-standard/pull/225) - Update high level descriptions of the 4 risk data components. +- [#196](https://github.com/GFDRR/rdl-standard/pull/196) - Add examples to schema reference documentation. +- [#214](https://github.com/GFDRR/rdl-standard/pull/214) - Improve display of codelist reference. ### Non-normative documentation - [#111](https://github.com/GFDRR/rdl-standard/pull/111) - Add Global Library for Schools Infrastructure (GLOSI) to taxonomies. +- [#171](https://github.com/GFDRR/rdl-standard/pull/171) - Updating glossary to add loss components, adjust other entries and remove images from glossary. - [#174](https://github.com/GFDRR/rdl-standard/pull/174) - Add local tests guidance to developer_docs.md - [#172](https://github.com/GFDRR/rdl-standard/pull/172) - Re-write use cases as user stories, for data publisher and data user roles. - [#175](https://github.com/GFDRR/rdl-standard/pull/175) - Restructure documentation, rewrite landing page, add new introductory content. +- [#224](https://github.com/GFDRR/rdl-standard/pull/224) - Update contact email addresses. ### Other diff --git a/docs/about/contacts.md b/docs/about/contacts.md index e8824121..14545988 100644 --- a/docs/about/contacts.md +++ b/docs/about/contacts.md @@ -1,17 +1,5 @@ # Contacts -## Risk Data Library team +To contact us with any questions about using or contributing to the Risk Data Library Standard, please send an email to [contact@riskdatalibrary.org](mailto:contact@riskdatalibrary.org) -- Mattia Amadio (Consultant): [mamadio@worldbank.org](mailto:mamadio@worldbank.org) -- Stuart Fraser (Consultant): [sfraser@worldbank.org](mailto:sfraser@worldbank.org) -- Pierre Chrzanowski (RDL lead): [pchrzanowski@worldbank.org](mailto:pchrzanowski@worldbank.org) - -## World Bank Data Catalog team - -This team is responsible for review and publication of submitted datasets, and to assign datasets to the World Bank Data Catalog [Risk Data Library collection](https://datacatalog.worldbank.org/search/collections/rdl). - -- Kamwoo Lee: [klee16@worldbank.org](mailto:klee16@worldbank.org) -- Gaurav Bhardwaj: [gbhardwaj1@worldbank.org](mailto:gbhardwaj1@worldbank.org) -- Rochelle O’Hagan (DDH lead): [rohagan@worldbank.org](mailto:rohagan@worldbank.org) - -
+To contribute directly or provide feedback about an issue with the RDLS, please log an issue on the [RDLS GitHub page](https://github.com/GFDRR/rdl-standard/issues/). diff --git a/docs/about/governance.md b/docs/about/governance.md index 854292bc..2baf00dc 100644 --- a/docs/about/governance.md +++ b/docs/about/governance.md @@ -75,7 +75,7 @@ ______________________________________________________________________ ## Proposing and managing changes -Anyone can propose changes to the specifications. The process for doing this is by [submitting an issue](https://github.com/GFDRR/rdl-standard/issues) using the appropriate template. The user must provide sufficient context to the proposed changes so that it can be discussed and reviewed by the [RDL team](contacts.md#risk-data-library-team) and other users. +Anyone can propose changes to the specifications. The process for doing this is by [submitting an issue](https://github.com/GFDRR/rdl-standard/issues) using the appropriate template. The user must provide sufficient context to the proposed changes so that it can be discussed and reviewed by the RDL team and other users. We encourage disussion and feedback, by requesting people leave comments on the issue. After leaving appropriate time for further comment, once we feel that a broad consensus has been achieved around the proposed changes, we will update the schema by releasing a new version of the specification. diff --git a/docs/conf.py b/docs/conf.py index c2074941..a3afc9c4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -40,12 +40,17 @@ 'sphinx_design', 'sphinxcontrib.mermaid', 'sphinxcontrib.opendataservices', + 'sphinxcontrib.plantuml', 'sphinxcontrib.jsonschema', 'sphinx_rtd_theme', 'sphinx.ext.todo', 'sphinx.ext.autodoc', 'sphinx_togglebutton',] +# PlantUML path +local_plantuml_path = os.path.join(os.path.dirname(__file__), "utils", "plantuml-1.2023.10.jar") +plantuml = f"java -Djava.awt.headless=true -jar {local_plantuml_path}" + # MyST heading anchors myst_heading_anchors = 5 diff --git a/docs/glossary.md b/docs/glossary.md index 094f7e8b..d74632be 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -2,25 +2,23 @@ # Glossary -In this section, you will find definition of key concepts behind the RDLS including what is a disaster, how to reduce disaster risk through disaster disaster risk management and disaster risk assessment and what are the different types of risk data needed. +In this section, you will find definitions of key concepts behind the Risk Data Library Standard (RDLS). ## Disaster risk -Disaster risk is the potential loss of life, injury, or destroyed or damaged assets which could occur to a system, society or a community in a specific period of time, determined probabilistically as a function of hazard, exposure, vulnerability and coping capacity. +Disaster risk is the potential loss of life, injury, or destroyed or damaged assets which could occur to a system, society or community in a specific period of time, determined probabilistically as a function of hazard, exposure, vulnerability and coping capacity. Disaster risk comprises different types of potential impacts and losses (direct and indirect, tangible and intangible) which are sometimes difficult to quantify. Nevertheless, with knowledge of the prevailing hazards, the patterns of population and socio-economic development and their tendency to suffer impacts, disaster risks can be assessed and mapped, at least in broad terms. Source: [UNDRR Terminology (Disaster Risk)](https://www.undrr.org/terminology/disaster-risk) -## Disaster risk assessment +## Climate and disaster risk assessment -A qualitative or quantitative approach to determine the nature and extent of disaster risk by analysing potential hazards and evaluating existing conditions of exposure and vulnerability that together could harm people, property, services, livelihoods and the environment on which they depend. +A qualitative or quantitative approach to determine the nature and extent of climate and [disaster risk](#disaster-risk) by analysing potential [hazards](#hazard) and evaluating existing conditions of [exposure](#exposure) and [vulnerability](#vulnerability) that together could harm people, property, services, livelihoods and the environment on which they depend. -Source: [UNDRR Terminology (Disaster Risk Assessment)](https://www.undrr.org/terminology/disaster-risk-assessment) +An impact or risk model (also damage model; loss model) is used to combine hazard, exposure and vulnerability components to calculate the [impact](#disaster-impact) or single or multiple events. -```{card} Risk assessment framework, adapted from [Understanding risk in an evolving world, World Bank, 2014](https://openknowledge.worldbank.org/handle/10986/20682) -![Risk assessment framework, adapted from Understanding risk in an evolving world, World Bank, 2014](img/risk_assessment.png) -``` +Source: Adapted from [UNDRR Terminology (Disaster Risk Assessment)](https://www.undrr.org/terminology/disaster-risk-assessment) ## Disaster risk information (risk data) @@ -34,44 +32,43 @@ Disaster risk management is the application of disaster risk reduction policies Source: [UNDRR Terminology (Disaster Risk Management)](https://www.undrr.org/terminology/disaster-risk-management) +## Hazard + +A hazard is a process or phenomenon that may cause loss of life, injury or other health impacts, property damage, social and economic disruption or environmental degradation. Hazards may be single, sequential or combined in their origin and effects. Each hazard is characterized by its location, intensity or magnitude, frequency and probability. A hazardous event is the manifestation of a hazard in a particular place during a particular period of time. + +Hazards can have a natural or anthropogenic origin. Natural hazards are associated with natural processes and phenomena (e.g., geological, geophysical, hydrometeorological). + +Source: [UNDRR Terminology (Hazard)](https://www.undrr.org/terminology/hazard) + ## Exposure The situation of people, infrastructure, housing, production capacities and other tangible human assets located in hazard-prone areas. Measures of exposure can include the number of people or types of assets in an area. These can be combined with the specific vulnerability and capacity of the exposed elements to any particular hazard to estimate the quantitative risks associated with that hazard in the area of interest Source: [UNDRR Terminology (Exposure)](https://www.undrr.org/terminology/exposure) -```{card} Exposure: buildings footprints and population -![Exposure: buildings footprints and population](img/sample_exp.jpg) -``` - -## Hazard +## Vulnerability -A hazard is a process or phenomenon that may cause loss of life, injury or other health impacts, property damage, social and economic disruption or environmental degradation. Hazards may be single, sequential or combined in their origin and effects. Each hazard is characterized by its location, intensity or magnitude, frequency and probability. An hazardous event is the manifestation of a hazard in a particular place during a particular period of time. +Vulnerability is the conditions determined by physical, social, economic and environmental factors or processes which increase the susceptibility of an individual, a community, assets or systems to the impacts of hazards. The inverse of vulnerability is defined as coping capacity, which is the combination of all the strengths, attributes and resources available within an organization, community or society to manage and reduce disaster risks and strengthen resilience. -Hazards can have natural or anthropogenic origin. Natural hazards are associated with natural processes and phenomena (geological, geophysical and hydrometeorological). +Source: [UNDRR Terminology (Vulnerability)](https://www.undrr.org/terminology/vulnerability) -Source: [UNDRR Terminology (Hazard)](https://www.undrr.org/terminology/hazard) +## Disaster Impact -```{card} Hazard: map of flood water depth -![Hazard](img/sample_hzd.jpg) -``` +The effect of a disaster on people, buildings and society is generally referred to as the impact. The impact of disasters can generate [losses](#loss), but also gains for some people and economies; for instance, the demand for construction materials and expertise following a disaster. It is, therefore, necessary to think of impact in terms of both gains and losses. -## Impact model +Source: Adapted from ([UNDRR](https://www.undrr.org/terminology/disaster)) -An impact model (also damage model; loss model) is used to combine Hazard, Exposure and Vulnerability components to calculate the amount of value that is expected to be impacted (damaged or lost). +## Loss -Source: [GFDRR, Solving the Puzzle, 2016](https://www.gfdrr.org/sites/default/files/solving-the-puzzle-report.pdf) +Losses are a measure of this impact in the form of damage or destruction caused by a disaster (observed or modelled). This measure may be expressed as monetary (e.g., cost of reconstruction) or non-monetary (e.g., hectares of crop loss, loss of life). Losses can be direct or indirect. -```{card} Impacts and losses: USD costs of replacement -![Loss](img/sample_lss.jpg) -``` +The total economic impact consists of a monetary estimate of both direct disaster loss and indirect disaster loss. _Direct disaster losses_ refer to directly quantifiable losses such as the number of people killed and the damage to buildings, infrastructure and natural resources. _Indirect disaster losses_ refer to wider and longer-term impacts arising from the direct disruptions to the flow of goods and services as a result of a disaster. This includes declines in output or revenue, increases in food prices, and other longer-term social and economic effects on education, health, productivity, the well-being of people or the macroeconomy. -## Vulnerability +Source: Adapted from ([UNDRR](https://www.preventionweb.net/understanding-disaster-risk/key-concepts/direct-indirect-losses)) +and [UNDRR Terminology (Economic Loss)](https://www.undrr.org/terminology/economic-loss) -Vulnerability are the conditions determined by physical, social, economic and environmental factors or processes which increase the susceptibility of an individual, a community, assets or systems to the impacts of hazards. The inverse of vulnerability is defined coping capacity, which is the combination of all the strengths, attributes and resources available within an organization, community or society to manage and reduce disaster risks and strengthen resilience. +## People affected -Source: [UNDRR Terminology (Vulnerability)](https://www.undrr.org/terminology/vulnerability) +People who have been exposed and impacted, either directly or indirectly, by a hazardous event. Directly affected are those who have suffered injury, illness or other health effects; who were evacuated, displaced, relocated or have suffered direct damage to their livelihoods, economic, physical, social, cultural and environmental assets. Indirectly affected are people who have suffered consequences, other than or in addition to direct effects, over time, due to disruption or changes in the economy, critical infrastructure, basic services, commerce or work, or social, health and psychological consequences. -```{card} Vulnerability: depth-damage function -![Vulnerability](img/sample_vln.jpg) -``` +Source: [UNDRR Terminology (Affected)](https://www.undrr.org/terminology/affected) diff --git a/docs/img/array.png b/docs/img/array.png new file mode 100644 index 00000000..722b576e Binary files /dev/null and b/docs/img/array.png differ diff --git a/docs/rdl/how.md b/docs/rdl/how.md index f536ffee..29ae61e7 100644 --- a/docs/rdl/how.md +++ b/docs/rdl/how.md @@ -11,4 +11,4 @@ For step-by-step instructions on how to publish RDLS metadata, see the guidance In addition to the metadata standard, the RDLS provides [guidance on packaging and formatting risk datasets](../guides/datasets/index.md), although it does not seek to standardise the contents of risk datasets. -If you have questions about the RDLS or need help implementing it, you can contact a member of the [Risk Data Library team](../about/contacts.md#risk-data-library-team). +If you have questions about the RDLS or need help implementing it, you can contact a member of the [Risk Data Library team](../about/contacts.md#contacts). diff --git a/docs/rdl/other-standards.md b/docs/rdl/other-standards.md index 517bfadf..4a12fda3 100644 --- a/docs/rdl/other-standards.md +++ b/docs/rdl/other-standards.md @@ -14,11 +14,6 @@ In 2018 an international consortium led by the British Geological Survey develop In this standard, we developed a list of hazard type codes and process type codes which are used as a reference in the hazard, vulnerability and loss components of the standard, and facilitate matching of appropriate vulnerability functions to hazard data, for example. Details about the development are reported [here](https://riskdatalibrary.org/resources). -**GLIDE disaster event identifier**: -Since the beginning of 2004, GLobal IDEntifier numbers (GLIDE) are produced at (GLIDEnumber.net) for all new disaster events reported by partner institutions and those discovered by ADRC. -A GLIDE number comprises two letters to identify the disaster type (e.g. EQ - earthquake); the year of the disaster; a six-digit, sequential disaster number; and the three-letter ISO code for country of occurrence. E.g., the GLIDE number for West-India Earthquake in India is: EQ-2001-000033-IND. This number is posted by the above organizations and in many other websites, on their documents relating to that particular disaster and gradually other partners will include it in whatever information they generate. As information suppliers join in this initiative, documents and data pertaining to specific events may be easily retrieved from various sources, or linked together using the unique GLIDE numbers. List of services using GLIDE: https://glidenumber.net/glide/public/links.jsp -The RDL Standard uses a GLIDE number in the `hazard.event` object, to denote the historical event to which hazard event data relates, e.g., the simulated hazard intensity footprint of that event. - ### Hazard taxonomies The RDL project performed a review of the most relevant hazard taxonomies and derived a classification focusing on those hazards and processes that are more often required in disaster risk assessments, while mapping and matching alternative definitions into one consistent framework. There are several existing taxonomies that could have been adopted to describe hazard data: diff --git a/docs/reference/codelists.md b/docs/reference/codelists.md index 6e1a1362..d4a47e53 100644 --- a/docs/reference/codelists.md +++ b/docs/reference/codelists.md @@ -29,13 +29,13 @@ This codelist is referenced by the following properties: This codelist has the following codes: +````{dropdown} Codes ```{csv-table-no-translate} ---- -header-rows: 1 -widths: auto -file: ../../schema/codelists/open/IMT.csv ---- +:header-rows: 1 +:widths: auto +:file: ../../schema/codelists/open/IMT.csv ``` +```` ### classification_scheme @@ -45,13 +45,16 @@ This codelist is referenced by the following properties: This codelist has the following codes: -```{csv-table-no-translate} +````{dropdown} Codes --- -header-rows: 1 -widths: auto -file: ../../schema/codelists/open/classification_scheme.csv +open: --- +```{csv-table-no-translate} +:header-rows: 1 +:widths: auto +:file: ../../schema/codelists/open/classification_scheme.csv ``` +```` ### damage_scale_name @@ -62,13 +65,13 @@ This codelist is referenced by the following properties: This codelist has the following codes: +````{dropdown} Codes ```{csv-table-no-translate} ---- -header-rows: 1 -widths: auto -file: ../../schema/codelists/open/damage_scale_name.csv ---- +:header-rows: 1 +:widths: auto +:file: ../../schema/codelists/open/damage_scale_name.csv ``` +```` ### data_formats @@ -78,13 +81,13 @@ This codelist is referenced by the following properties: This codelist has the following codes: +````{dropdown} Codes ```{csv-table-no-translate} ---- -header-rows: 1 -widths: auto -file: ../../schema/codelists/open/data_formats.csv ---- +:header-rows: 1 +:widths: auto +:file: ../../schema/codelists/open/data_formats.csv ``` +```` ### engineering_demand_parameter @@ -94,13 +97,16 @@ This codelist is referenced by the following properties: This codelist has the following codes: -```{csv-table-no-translate} +````{dropdown} Codes --- -header-rows: 1 -widths: auto -file: ../../schema/codelists/open/engineering_demand_parameter.csv +open: --- +```{csv-table-no-translate} +:header-rows: 1 +:widths: auto +:file: ../../schema/codelists/open/engineering_demand_parameter.csv ``` +```` ### impact_metric @@ -110,13 +116,13 @@ This codelist is referenced by the following properties: This codelist has the following codes: +````{dropdown} Codes ```{csv-table-no-translate} ---- -header-rows: 1 -widths: auto -file: ../../schema/codelists/open/impact_metric.csv ---- +:header-rows: 1 +:widths: auto +:file: ../../schema/codelists/open/impact_metric.csv ``` +```` ### impact_unit @@ -126,13 +132,13 @@ This codelist is referenced by the following properties: This codelist has the following codes: +````{dropdown} Codes ```{csv-table-no-translate} ---- -header-rows: 1 -widths: auto -file: ../../schema/codelists/open/impact_unit.csv ---- +:header-rows: 1 +:widths: auto +:file: ../../schema/codelists/open/impact_unit.csv ``` +```` ### license @@ -142,13 +148,13 @@ This codelist is referenced by the following properties: This codelist has the following codes: +````{dropdown} Codes ```{csv-table-no-translate} ---- -header-rows: 1 -widths: auto -file: ../../schema/codelists/open/license.csv ---- +:header-rows: 1 +:widths: auto +:file: ../../schema/codelists/open/license.csv ``` +```` ### location_gazetteers @@ -158,13 +164,16 @@ This codelist is referenced by the following properties: This codelist has the following codes: -```{csv-table-no-translate} +````{dropdown} Codes --- -header-rows: 1 -widths: auto -file: ../../schema/codelists/open/location_gazetteers.csv +open: --- +```{csv-table-no-translate} +:header-rows: 1 +:widths: auto +:file: ../../schema/codelists/open/location_gazetteers.csv ``` +```` ### media_type @@ -174,13 +183,34 @@ This codelist is referenced by the following properties: This codelist has the following codes: +````{dropdown} Codes ```{csv-table-no-translate} +:header-rows: 1 +:widths: auto +:file: ../../schema/codelists/open/media_type.csv +``` +```` + +### quantity_kind + +The quantity kind codelist is a subset of the codes in the [QUDT Quantity Kind Vocabulary](https://www.qudt.org/doc/DOC_VOCAB-QUANTITY-KINDS.html). It includes a code for the [currency quantity kind](https://qudt.org/vocab/quantitykind/Currency), which does not appear in the vocabulary because QUDT lists currencies in a separate graph from other quantity kinds. + +This codelist is referenced by the following properties: + +- [`Metric/quantity_kind`](rdls_schema.json,/$defs/Metric,quantity_kind) + +This codelist has the following codes: + +````{dropdown} Codes --- -header-rows: 1 -widths: auto -file: ../../schema/codelists/open/media_type.csv +open: --- +```{csv-table-no-translate} +:header-rows: 1 +:widths: auto +:file: ../../schema/codelists/open/quantity_kind.csv ``` +```` ### roles @@ -192,13 +222,13 @@ This codelist is referenced by the following properties: This codelist has the following codes: +````{dropdown} Codes ```{csv-table-no-translate} ---- -header-rows: 1 -widths: auto -file: ../../schema/codelists/open/roles.csv ---- +:header-rows: 1 +:widths: auto +:file: ../../schema/codelists/open/roles.csv ``` +```` ## Closed codelists @@ -212,29 +242,16 @@ This codelist is referenced by the following properties: This codelist has the following codes: -```{csv-table-no-translate} +````{dropdown} Codes --- -header-rows: 1 -widths: auto -file: ../../schema/codelists/closed/analysis_type.csv +open: --- -``` - -### cost_type - -This codelist is referenced by the following properties: - -- [`Cost/type`](rdls_schema.json,/$defs/Cost,type) - -This codelist has the following codes: - ```{csv-table-no-translate} ---- -header-rows: 1 -widths: auto -file: ../../schema/codelists/closed/cost_type.csv ---- +:header-rows: 1 +:widths: auto +:file: ../../schema/codelists/closed/analysis_type.csv ``` +```` ### country @@ -244,13 +261,13 @@ This codelist is referenced by the following properties: This codelist has the following codes: +````{dropdown} Codes ```{csv-table-no-translate} ---- -header-rows: 1 -widths: auto -file: ../../schema/codelists/closed/country.csv ---- +:header-rows: 1 +:widths: auto +:file: ../../schema/codelists/closed/country.csv ``` +```` ### currency @@ -260,13 +277,13 @@ This codelist is referenced by the following properties: This codelist has the following codes: +````{dropdown} Codes ```{csv-table-no-translate} ---- -header-rows: 1 -widths: auto -file: ../../schema/codelists/closed/currency.csv ---- +:header-rows: 1 +:widths: auto +:file: ../../schema/codelists/closed/currency.csv ``` +```` ### data_calculation_type @@ -278,13 +295,16 @@ This codelist is referenced by the following properties: This codelist has the following codes: -```{csv-table-no-translate} +````{dropdown} Codes --- -header-rows: 1 -widths: auto -file: ../../schema/codelists/closed/data_calculation_type.csv +open: --- +```{csv-table-no-translate} +:header-rows: 1 +:widths: auto +:file: ../../schema/codelists/closed/data_calculation_type.csv ``` +```` ### exposure_category @@ -296,13 +316,16 @@ This codelist is referenced by the following properties: This codelist has the following codes: -```{csv-table-no-translate} +````{dropdown} Codes --- -header-rows: 1 -widths: auto -file: ../../schema/codelists/closed/exposure_category.csv +open: --- +```{csv-table-no-translate} +:header-rows: 1 +:widths: auto +:file: ../../schema/codelists/closed/exposure_category.csv ``` +```` ### frequency_distribution @@ -312,13 +335,16 @@ This codelist is referenced by the following properties: This codelist has the following codes: -```{csv-table-no-translate} +````{dropdown} Codes --- -header-rows: 1 -widths: auto -file: ../../schema/codelists/closed/frequency_distribution.csv +open: --- +```{csv-table-no-translate} +:header-rows: 1 +:widths: auto +:file: ../../schema/codelists/closed/frequency_distribution.csv ``` +```` ### function_approach @@ -332,13 +358,16 @@ This codelist is referenced by the following properties: This codelist has the following codes: -```{csv-table-no-translate} +````{dropdown} Codes --- -header-rows: 1 -widths: auto -file: ../../schema/codelists/closed/function_approach.csv +open: --- +```{csv-table-no-translate} +:header-rows: 1 +:widths: auto +:file: ../../schema/codelists/closed/function_approach.csv ``` +```` ### geometry_type @@ -348,13 +377,16 @@ This codelist is referenced by the following properties: This codelist has the following codes: -```{csv-table-no-translate} +````{dropdown} Codes --- -header-rows: 1 -widths: auto -file: ../../schema/codelists/closed/geometry_type.csv +open: --- +```{csv-table-no-translate} +:header-rows: 1 +:widths: auto +:file: ../../schema/codelists/closed/geometry_type.csv ``` +```` ### hazard_type @@ -372,13 +404,13 @@ This codelist is referenced by the following properties: This codelist has the following codes: +````{dropdown} Codes ```{csv-table-no-translate} ---- -header-rows: 1 -widths: auto -file: ../../schema/codelists/closed/hazard_type.csv ---- +:header-rows: 1 +:widths: auto +:file: ../../schema/codelists/closed/hazard_type.csv ``` +```` ### impact_type @@ -388,13 +420,16 @@ This codelist is referenced by the following properties: This codelist has the following codes: -```{csv-table-no-translate} +````{dropdown} Codes --- -header-rows: 1 -widths: auto -file: ../../schema/codelists/closed/impact_type.csv +open: --- +```{csv-table-no-translate} +:header-rows: 1 +:widths: auto +:file: ../../schema/codelists/closed/impact_type.csv ``` +```` ### loss_type @@ -404,13 +439,36 @@ This codelist is referenced by the following properties: This codelist has the following codes: +````{dropdown} Codes +--- +open: +--- ```{csv-table-no-translate} +:header-rows: 1 +:widths: auto +:file: ../../schema/codelists/closed/loss_type.csv +``` +```` + +### metric_dimension + +This codelist is referenced by the following properties: + +- [`Metric/dimension`](rdls_schema.json,/$defs/Metric,dimension) +- [`Cost/dimension`](rdls_schema.json,/$defs/Cost,dimension) + +This codelist has the following codes: + +````{dropdown} Codes --- -header-rows: 1 -widths: auto -file: ../../schema/codelists/closed/loss_type.csv +open: --- +```{csv-table-no-translate} +:header-rows: 1 +:widths: auto +:file: ../../schema/codelists/closed/metric_dimension.csv ``` +```` ### process_type @@ -426,13 +484,13 @@ This codelist is referenced by the following properties: This codelist has the following codes: +````{dropdown} Codes ```{csv-table-no-translate} ---- -header-rows: 1 -widths: auto -file: ../../schema/codelists/closed/process_type.csv ---- +:header-rows: 1 +:widths: auto +:file: ../../schema/codelists/closed/process_type.csv ``` +```` ### relationship_type @@ -445,13 +503,16 @@ This codelist is referenced by the following properties: This codelist has the following codes: -```{csv-table-no-translate} +````{dropdown} Codes --- -header-rows: 1 -widths: auto -file: ../../schema/codelists/closed/relationship_type.csv +open: --- +```{csv-table-no-translate} +:header-rows: 1 +:widths: auto +:file: ../../schema/codelists/closed/relationship_type.csv ``` +```` ### risk_data_type @@ -462,13 +523,16 @@ This codelist is referenced by the following properties: This codelist has the following codes: -```{csv-table-no-translate} +````{dropdown} Codes --- -header-rows: 1 -widths: auto -file: ../../schema/codelists/closed/risk_data_type.csv +open: --- +```{csv-table-no-translate} +:header-rows: 1 +:widths: auto +:file: ../../schema/codelists/closed/risk_data_type.csv ``` +```` ### seasonality @@ -478,13 +542,16 @@ This codelist is referenced by the following properties: This codelist has the following codes: -```{csv-table-no-translate} +````{dropdown} Codes --- -header-rows: 1 -widths: auto -file: ../../schema/codelists/closed/seasonality.csv +open: --- +```{csv-table-no-translate} +:header-rows: 1 +:widths: auto +:file: ../../schema/codelists/closed/seasonality.csv ``` +```` ### source_type @@ -494,13 +561,16 @@ This codelist is referenced by the following properties: This codelist has the following codes: -```{csv-table-no-translate} +````{dropdown} Codes --- -header-rows: 1 -widths: auto -file: ../../schema/codelists/closed/source_type.csv +open: --- +```{csv-table-no-translate} +:header-rows: 1 +:widths: auto +:file: ../../schema/codelists/closed/source_type.csv ``` +```` ### spatial_scale @@ -510,10 +580,13 @@ This codelist is referenced by the following properties: This codelist has the following codes: -```{csv-table-no-translate} +````{dropdown} Codes --- -header-rows: 1 -widths: auto -file: ../../schema/codelists/closed/spatial_scale.csv +open: --- +```{csv-table-no-translate} +:header-rows: 1 +:widths: auto +:file: ../../schema/codelists/closed/spatial_scale.csv ``` +```` diff --git a/docs/reference/schema.md b/docs/reference/schema.md index 9c5c47aa..82455fdc 100644 --- a/docs/reference/schema.md +++ b/docs/reference/schema.md @@ -10,58 +10,73 @@ This page presents the schema in tables with additional information in paragraph If any conflicts are found between the text on this page and the text within the schema, the text within the schema takes precedence. ``` -The RDLS schema covers [dataset attributes](#dataset), [resource attributes](#resource) and four components to document data used in risk analysis: +The RDLS schema covers [dataset fields](#dataset), [resource fields](#resource) and four risk-specific components to describe risk datasets: -- [Hazard](#hazard): metadata to describe hazard data, including the main hazard type and process, triggering hazard and process, hazard intensity units, occurrence frequency of individual events, multiple hazard footprints per event, historical and stochastic events sets, and analytical methods used. -- [Exposure](#exposure): metadata describing exposure data, including asset category (including human, built environment assets and natural assets), taxonomy scheme used to describe characteristics of assets and people, cost type, location and geometry types. -- [Vulnerability](#vulnerability): metadata to describe vulnerability and fragility relationships and indexes, including type of impact, type of exposure, hazard intensity measure and approach used to develop the relationship. This component uses attributes consistent with the hazard, exposure and loss components. -- [Loss](#loss): metadata describing monetary and non-monetary damage and losses produced in a risk assessment. This includes fields to link losses to the hazard, exposure, and vulnerability components used in the analysis. The loss component enables description of common impact and risk metrics for direct and indirect impacts, for individual historical and hypothetical events, and for large events sets in year loss tables and event loss tables. +- [Hazard](#hazard-metadata): Metadata that is specific to datasets that describe processes or phenomena that may cause loss of life, injury or other health impacts, property damage, social and economic disruption or environmental degradation. For example, a classification of the type of the hazard, the units in which the intensity of the hazard is measured, and the frequency at which the hazard occurs. +- [Exposure](#exposure-metadata): Metadata that is specific to datasets that describe the location and demographic information of people, and the location, characteristics and value of assets in the built and natural environment. For example, the type of building and the cost to replace it if it suffered damage. +- [Vulnerability](#vulnerability-metadata): Metadata that is specific to datasets that describe the vulnerability and fragility relationships and indexes used in risk analysis. This includes the type of exposure, hazard intensity and impact the relationship describes, and information on how the relationship was developed. This component uses attributes consistent with the hazard, exposure and loss components. +- [Loss](#loss-metadata): Metadata that is specific to datasets that contain the simulated (modeled) risk and impact estimates produced in a risk assessment, including explicit links to the hazard, exposure, and vulnerability datasets used in the analysis. For general definitions of hazard, exposure, vulnerability and loss, please see the [Glossary](../glossary.md). For fields that reference [sub-schemas](#sub-schemas), a link is provided to a table with details of the sub-schema. To see how the fields and sub-schemas fit together, consult the [schema browser](browser.md). -The diagram below shows the core relationships between schema components, and their core attributes. +## Dataset -```{eval-rst} - .. mermaid:: - - classDiagram - Dataset -- Hazard - Dataset -- Exposure - Dataset -- Vulnerability - Dataset -- Loss - Dataset: -Project name - Dataset: -Coverage - Dataset: -Purpose - Dataset: -Bibliography - class Hazard{ - -Type, Process - -Trigger - -Frequency, Intensity - -Analytical method - } - class Exposure{ - -Asset category - -Taxonomy - -Cost type - } - class Vulnerability{ - -Hazard process - -Exposure taxonomy - -Analytical method - } - class Loss{ - -Hazard process - -Exposure taxonomy - -Loss frequency - -Loss metric - } +The top-level object in the RDLS schema is a risk dataset. A risk dataset is described as: + +```{jsoninclude-quote} ../../docs/_readthedocs/html/rdls_schema.json +--- +jsonpointer: /description +--- ``` -## Dataset +The general attributes of a dataset are described by fields based on the [Data Catalog Vocabulary](https://www.w3.org/TR/vocab-dcat-3/) and the [Dublin Core Metadata Initiative Metadata Terms](https://www.dublincore.org/specifications/dublin-core/dcmi-terms). + +The following diagram shows key dataset-level fields, with required fields highlighted in blue: -In addition to schema-specific attributes, each dataset is identified by a list of attributes based on the [Dublin Core Metadata Initiative Metadata Terms](https://www.dublincore.org/specifications/dublin-core/dcmi-terms). +```{eval-rst} +.. uml:: + + @startjson + + #highlight "title" <> + #highlight "risk_data_type" <> + #highlight "publisher" <> + #highlight "publisher" / "name" <> + #highlight "spatial" <> + #highlight "license" <> + { + "title": "", + "description": "", + "risk_data_type": "", + "publisher": { + "name": "", + "email": "", + "url": "" + }, + "version": "", + "purpose": "", + "project": "", + "details": "", + "spatial": { + "countries": "", + "bbox": "" + }, + "license": "" + } + @endjson + +``` + +The following table lists all dataset-level fields: ```{jsonschema} ../../docs/_readthedocs/html/rdls_schema.json --- @@ -73,7 +88,17 @@ addtargets: ## Resource -Other attributes are specific to individual resources, covering level of aggregation, resolution and format. +A `Resource` is defined as: + +```{jsoninclude-quote} ../../docs/_readthedocs/html/rdls_schema.json +--- +jsonpointer: /$defs/Resource/description +--- +``` + +Each dataset can have many associated resources. + +The following table lists all resource-level fields: ```{jsonschema} ../../docs/_readthedocs/html/rdls_schema.json --- @@ -83,221 +108,512 @@ addtargets: --- ``` -## Hazard +## Hazard metadata + +The `hazard` component is described as: + +```{jsoninclude-quote} ../../docs/_readthedocs/html/rdls_schema.json +--- +jsonpointer: /properties/hazard/description +--- +``` The hazard component describes metadata about modeled natural hazards data, including hazard intensity footprints of historical or hypothetical events, return period hazard maps, hazard or susceptibility index, and stochastic event sets. The metadata defines the hazard type, physical process and intensity measures used in the dataset. Multiple hazards and processes (including cascading events) can be defined for each hazard, enabling users to describe dataset that contain, for example, earthquake ground shaking and liquefaction, and tsunami inundation triggered by the earthquake. -The hazard component uses hazard_type, process_type and intensity_measure consistent with the vulnerability and loss component’s of this standard. Spatial reference and location information are described using existing external standards. Temporal information can include date and duration of events or year of scenario, and is defined using the Dublin Core standards. +The hazard component uses hazard_type, process_type and intensity_measure consistent with the vulnerability and loss components of this standard. Spatial reference and location information are described using existing external standards. Temporal information can include date and duration of events or year of scenario, and is defined using the Dublin Core standards. + +The following diagram shows key hazard component fields, with required fields highlighted in blue. The ![array](../img/array.png) icon indicates that a field is an array. ```{eval-rst} - .. mermaid:: - - classDiagram - Event set -- Event1 - Event set -- Event2 - Event set: Hazard type - Event set: Analytical method - class Event1{ - Occurrence frequency - Time reference - Hazard trigger - } - class Event2{ - Occurrence frequency - Time reference - Hazard trigger - } - Event1 -- Footprint1 - Event1 -- Footprint2 - Event2 -- Footprint3 - Event2 -- Footprint4 - class Footprint1{ - Hazard process - Intensity measure - Uncertainty - } - class Footprint2{ - Hazard process - Intensity measure - Uncertainty - } - class Footprint3{ - Hazard process - Intensity measure - Uncertainty - } - class Footprint4{ - Hazard process - Intensity measure - Uncertainty +.. uml:: + + @startjson + + #highlight "event_sets" <> + #highlight "event_sets" / 0 / "analysis_type" <> + #highlight "event_sets" / 0 / "events" / 0 / "calculation_method" <> + #highlight "event_sets" / 0 / "events" / 0 / "hazard" <> + #highlight "event_sets" / 0 / "events" / 0 / "hazard" / "type" <> + #highlight "event_sets" / 0 / "events" / 0 / "hazard" / "processes" <> + #highlight "event_sets" / 0 / "events" / 0 / "occurrence" <> + #highlight "event_sets" / 0 / "events" / 0 / "footprints" / 0 / "intensity_measure" <> + { + "event_sets": [ + { + "analysis_type": "", + "frequency_distribution": "", + "seasonality": "", + "event_count": "", + "occurrence_range": "", + "spatial": "", + "temporal": "", + "events": [ + { + "disaster_identifiers": "", + "calculation_method": "", + "description": "", + "hazard": { + "type": "", + "processes": "", + "intensity_measure": "", + "trigger": "" + }, + "occurrence": "", + "footprints": [ + { + "intensity_measure": "", + "data_uncertainty": "" + } + ] + } + ] } -``` + ] + } + @endjson -`````{tab-set} +``` -````{tab-item} Schema +The following table lists all hazard component fields: ```{jsonschema} ../../docs/_readthedocs/html/rdls_schema.json --- pointer: /properties/hazard -collapse: event_sets/0/hazards,event_sets/0/spatial,event_sets/0/temporal,event_sets/0/events +collapse: + event_sets/0/hazards,event_sets/0/spatial,event_sets/0/temporal,event_sets/0/events addtargets: --- ``` +``````{dropdown} Example: Fathom Global Flood Map +--- +open: +--- +The following example shows RDLS metadata for the [Fathom Global Flood Map](https://www.fathom.global/product/global-flood-map/) in tabular format and JSON format. + +`````{tab-set} + +````{tab-item} Figure + +```{figure} ../../examples/hazard/fathom/figure.png +``` + ```` -````{tab-item} Examples +````{tab-item} Metadata (tabular) + +In tabular format, the metadata consists of several tables. To aid comprehension, the metadata is presented column wise using field titles. + +```{csv-table-no-translate} Datasets +--- +stub-columns: 1 +widths: auto +file: ../../examples/hazard/fathom/datasets.csv +--- + +``` + +```{csv-table-no-translate} Resources +--- +stub-columns: 1 +widths: auto +file: ../../examples/hazard/fathom/Resources.csv +--- + +``` + +```{csv-table-no-translate} Event sets +--- +stub-columns: 1 +widths: auto +file: ../../examples/hazard/fathom/Hazard metadata_Event sets.csv +--- + +``` -Hazard data are most often represented by geospatial grids (raster); sometimes they are represented by points or polygons. +```{csv-table-no-translate} Event set hazards +--- +stub-columns: 1 +widths: auto +file: ../../examples/hazard/fathom/Hazard metadata_Event sets_Hazards.csv +--- -**Flood hazard maps for Kabul** +``` -Schema attributes for flood hazard map related to the occurrence probability of a river flood event with a return period of once in 100 years over Kabul, Afghanistan. The hydrological data used for modelling the intensity of floods is derived from observations over the period 1958-2001 (44 years). The hazard intensity is measured as water depth, in meters. These information cover all mandatory fields, and a few optional fields. +```` -![Screenshot](../img/hzd_fl_kabul.jpg) +````{tab-item} Metadata (JSON) -| **Required** | **Attribute** | **Example** | -| :----------: | ----------------------- | --------------- | -| \* | Hazard type | Flood | -| \* | Analysis type | Probabilistic | -| \* | Calculation method | Simulated | -| | Geographic area | Kabul | -| | Frequency type | Return Period | -| | Occurrence probability | 100 years | -| | Occurrence time (start) | 1958 | -| | Occurrence time (end) | 2001 | -| | Occurrence time (span) | 44 years | -| \* | Hazard process | River flood | -| \* | Unit of measure | Water depth (m) | +```{eval-rst} +.. jsoninclude:: ../../examples/hazard/fathom/example.json + :jsonpointer: /datasets/0 + :title: Example +``` + +````` -**Earthquake hazard maps for Afghanistan** +`````` -Schema attributes for an earthquake hazard map related to an occurrence probability of an event with return period of once in 1000 years over Afghanistan. The seismic data catalogue behind the calculation of occurrence probability starts from year 800, covering a period of 1200 years. The hazard intensity is measured as Peak Ground Acceleration, expressed in (g). +``````{dropdown} Example: Aqueduct Floods Hazard Maps -![Screenshot](../img/hzd_eq_afg.jpg) +The following example shows RDLS metadata for the [Aqueduct Floods Hazard Maps](https://www.wri.org/data/aqueduct-floods-hazard-maps) in tabular format and JSON format. -| **Required** | **Attribute** | **Example** | -| :----------: | ----------------------- | ------------- | -| \* | Hazard type | Earthquake | -| \* | Analysis type | Probabilistic | -| \* | Calculation method | Simulated | -| | Frequency type | Return Period | -| | Occurrence probability | 1000 years | -| | Occurrence time (start) | 800 | -| | Occurrence time (end) | 2001 | -| | Occurrence time (span) | 1200 years | -| \* | Hazard process | Ground motion | -| \* | Unit of measure | PGA (g) | +`````{tab-set} +````{tab-item} Figure + +```{figure} ../../examples/hazard/aqueduct/figure.png +``` + +```` + +````{tab-item} Metadata (tabular) + +In tabular format, the metadata consists of several tables. To aid comprehension, the metadata is presented column wise using field titles. + +```{csv-table-no-translate} Datasets +--- +stub-columns: 1 +widths: auto +file: ../../examples/hazard/aqueduct/datasets.csv +--- + +``` + +```{csv-table-no-translate} Resources +--- +stub-columns: 1 +widths: auto +file: ../../examples/hazard/aqueduct/Resources.csv +--- + +``` + +```{csv-table-no-translate} Event sets +--- +stub-columns: 1 +widths: auto +file: ../../examples/hazard/aqueduct/Hazard metadata_Event sets.csv +--- + +``` + +```{csv-table-no-translate} Event set hazards +--- +stub-columns: 1 +widths: auto +file: ../../examples/hazard/aqueduct/Hazard metadata_Event sets_Hazards.csv +--- + +``` + +```` + +````{tab-item} Metadata (JSON) + +```{eval-rst} +.. jsoninclude:: ../../examples/hazard/aqueduct/example.json + :jsonpointer: /datasets/0 + :title: Example +``` ```` ````` +`````` -## Exposure +## Exposure metadata + +The `exposure` component is described as: + +```{jsoninclude-quote} ../../docs/_readthedocs/html/rdls_schema.json +--- +jsonpointer: /properties/exposure/description +--- +``` The exposure component describes metadata for datasets containing information on the distribution and characteristics of built environment assets (buildings and infrastructure) and natural assets and population, that are used in risk assessment. The exposure component provides codelists to describe the type of assets and costs, and the taxonomy scheme that is used to describe construction and demographic information contained in the dataset. For more information, see [exposure standards](../rdl/other-standards.md#exposure-standards). The exposure component uses exposure categories consistent with the vulnerability and loss components of this standard. Spatial reference and location information are described using existing external standards. Temporal information can include date and duration of events or year of scenario, and is defined using the Dublin Core standards. +The following diagram shows key exposure component fields, with required fields highlighted in blue. The ![array](../img/array.png) icon indicates that a field is an array. + ```{eval-rst} - .. mermaid:: - - classDiagram - Model -- Asset1 - Model -- Asset2 - Model: Category - Model: Occupancy - class Asset1{ - Taxonomy code - Value type - Value unit - } - class Asset2{ - Taxonomy code - Value type - Value unit - } -``` +.. uml:: + + @startjson + + #highlight "exposure" / "category" <> + #highlight "exposure" / "metrics" / 0 / "quantity_kind" <> + { + "exposure": { + "category": "", + "taxonomy": "", + "metrics": [ + { + "dimension": "", + "quantity_kind": "" + } + ] + } + } + @endjson -`````{tab-set} +``` -````{tab-item} Schema +The following table lists all exposure component fields: ```{jsonschema} ../../docs/_readthedocs/html/rdls_schema.json --- pointer: /properties/exposure -collapse: cost +collapse: metrics addtargets: --- ``` +``````{dropdown} Example: Central Asia projected residential exposure dataset + +The following example shows RDLS metadata for the [Central Asia projected residential exposure dataset](https://datacatalog.worldbank.org/search/dataset/0064254/Central-Asia-exposure-dataset---Projected-residential-exposure) in tabular format and JSON format. + +`````{tab-set} + +````{tab-item} Metadata (tabular) +hazard + +```{csv-table-no-translate} Datasets +--- +stub-columns: 1 +widths: auto +file: ../../examples/exposure/central_asia_residential_projected/datasets.csv +--- + +``` + +```{csv-table-no-translate} Resources +--- +stub-columns: 1 +widths: auto +file: ../../examples/exposure/central_asia_residential_projected/Resources.csv +--- + +``` + +```{csv-table-no-translate} Attributions +--- +stub-columns: 1 +widths: auto +file: ../../examples/exposure/central_asia_residential_projected/Attributions.csv +--- + +``` + +```{csv-table-no-translate} Referenced by +--- +stub-columns: 1 +widths: auto +file: ../../examples/exposure/central_asia_residential_projected/Referenced by.csv +--- + +``` + +```{csv-table-no-translate} Sources +--- +stub-columns: 1 +widths: auto +file: ../../examples/exposure/central_asia_residential_projected/Sources.csv +--- + +``` + +```{csv-table-no-translate} Gazetteer entries (spatial coverage) +--- +stub-columns: 1 +widths: auto +file: ../../examples/exposure/central_asia_residential_projected/Spatial coverage_Gazetteer entries.csv +--- + +``` + +```{csv-table-no-translate} Exposure metrics +--- +stub-columns: 1 +widths: auto +file: ../../examples/exposure/central_asia_residential_projected/Exposure metadata_Exposure metrics.csv +--- + +``` + ```` -````{tab-item} Examples +````{tab-item} Metadata (JSON) + +```{eval-rst} +.. jsoninclude:: ../../examples/exposure/central_asia_residential_projected/example.json + :jsonpointer: /datasets/0 + :title: Example +``` + +````` +`````` + +``````{dropdown} Example: Central Asia current residential exposure dataset + +The following example shows RDLS metadata for the [Central Asia current residential exposure dataset](https://datacatalog.worldbank.org/search/dataset/0064251/Central-Asia-exposure-dataset---Residential-buildings) in tabular format and JSON format. + +`````{tab-set} + +````{tab-item} Metadata (tabular) -Exposure data can be stored at multiple scales, more often using vectors, namely polygons (e.g. building footprint), points (e.g. asset geolocation) and lines (e.g. transport infrastructures, lifelines), but in same case exposure estimates are aggregated at ADM level or distributed over a raster grid. +In tabular format, the metadata consists of several tables. To aid comprehension, the metadata is presented column wise using field titles. -**Exposure map for Kabul** +```{csv-table-no-translate} Datasets +--- +stub-columns: 1 +widths: auto +file: ../../examples/exposure/central_asia_residential_current/datasets.csv +--- + +``` -Two exposure datasets are shown together in the example: building footprints polygons and population density raster at 90 m resolution. +```{csv-table-no-translate} Resources +--- +stub-columns: 1 +widths: auto +file: ../../examples/exposure/central_asia_residential_current/Resources.csv +--- -![Exposure example](../img/sample_exp.jpg) +``` -| **Required** | **Attribute** | **Example** | -| :----------: | ------------------- | ----------- | -| \* | Geographic coverage | Afghanistan | -| \* | Exposure category | Buildings | -| \* | Occupancy | Mixed | -| | Taxonomy | OSM | -| \* | Value type | Structure | -| \* | Unit of measure | USD | +```{csv-table-no-translate} Attributions +--- +stub-columns: 1 +widths: auto +file: ../../examples/exposure/central_asia_residential_current/Attributions.csv +--- -| **Required** | **Attribute** | **Example** | -| :----------: | ------------------- | ----------- | -| \* | Geographic coverage | Afghanistan | -| \* | Exposure category | Indicators | -| \* | Occupancy | Residential | -| | Period of occupancy | Night | -| \* | Value type | Other | -| \* | Unit of measure | Count | +``` +```{csv-table-no-translate} Referenced by +--- +stub-columns: 1 +widths: auto +file: ../../examples/exposure/central_asia_residential_current/Referenced by.csv +--- + +``` + +```{csv-table-no-translate} Sources +--- +stub-columns: 1 +widths: auto +file: ../../examples/exposure/central_asia_residential_current/Sources.csv +--- + +``` + +```{csv-table-no-translate} Gazetteer entries (spatial coverage) +--- +stub-columns: 1 +widths: auto +file: ../../examples/exposure/central_asia_residential_current/Spatial coverage_Gazetteer entries.csv +--- + +``` + +```{csv-table-no-translate} Exposure metrics +--- +stub-columns: 1 +widths: auto +file: ../../examples/exposure/central_asia_residential_current/Exposure metadata_Exposure metrics.csv +--- + +``` + +```` + +````{tab-item} Metadata (JSON) + +```{eval-rst} +.. jsoninclude:: ../../examples/exposure/central_asia_residential_current/example.json + :jsonpointer: /datasets/0 + :title: Example +``` ```` ````` +`````` + +## Vulnerability metadata -## Vulnerability +The `vulnerability` component is described as: + +```{jsoninclude-quote} ../../docs/_readthedocs/html/rdls_schema.json +--- +jsonpointer: /properties/vulnerability/description +--- +``` The vulnerability component describes metadata for datasets that detail fragility, damage-to-loss and vulnerability relationships and indexes for physical damage and social vulnerability that are used in risk analysis. It contains key information including the type of function, intensity and impact metrics used, which asset types or population groups it applies to, how it was developed and for what locations. The vulnerability component uses hazard_type, process_type and intensity_measure consistent with the hazard and loss components, exposure information consistent with the exposure and loss components. Spatial reference and location information are described using existing external standards. +The following diagram shows key vulnerability component fields, with required fields highlighted in blue: + ```{eval-rst} - .. mermaid:: - - classDiagram - Model -- Specifics - Model -- Additional - Model: Hazard type - Model: Exposure taxonomy - Model: Calculation method - class Specifics{ - Parameters - Damage states - Intensity measure - } - class Additional{ - Validation - Error - Fitness - } -``` +.. uml:: + + @startjson + + #highlight "hazard_primary" <> + #highlight "intensity" <> + #highlight "category" <> + #highlight "impact" <> + #highlight "functions" <> + { + "hazard_primary": "", + "hazard_secondary": "", + "intensity": "", + "category": "", + "impact": { + "type": "", + "metric": "", + "unit": "" + }, + "functions": { + "vulnerability": "", + "fragility": "", + "damage_to_loss": "", + "engineering_demand": "" + }, + "se_category": "" + } + @endjson -`````{tab-set} +``` -````{tab-item} Schema +The following table lists all vulnerability component fields: ```{jsonschema} ../../docs/_readthedocs/html/rdls_schema.json --- @@ -307,119 +623,144 @@ addtargets: --- ``` +``````{dropdown} Example: Global flood depth-damage functions +--- +open: +--- +The following example shows RDLS metadata for the [Global flood depth-damage functions](https://publications.jrc.ec.europa.eu/repository/handle/JRC105688) in tabular format and JSON format. + +`````{tab-set} + +````{tab-item} Figure + +```{figure} ../../examples/vulnerability/flood_jrc/figure.png +``` ```` -````` +````{tab-item} Metadata (tabular) -## Loss +In tabular format, the metadata consists of several tables. To aid comprehension, the metadata is presented column wise using field titles. -The loss component provides metadata describing data generated in risk assessments, i.e., modelled impacts and losses for single historical events or hypothetical scenarios and risk estimates from analysis of large event sets. The data can include monetary and non-monetary, and direct or indirect, impacts and losses. -Loss datasets can be explicitly linked to the exposure, hazard, and vulnerability datasets used in the analysis. This component uses descriptions of assets, hazards and impact types consistent with all other components of this standard. Spatial reference and location information are described using existing external standards. Temporal information can include date and duration of events or year of scenario, and is defined using the Dublin Core standards. +```{csv-table-no-translate} Datasets +--- +stub-columns: 1 +widths: auto +file: ../../examples/vulnerability/flood_jrc/datasets.csv +--- -```{eval-rst} - .. mermaid:: - - classDiagram - Model -- Map - Model -- Curve - Model: Hazard type - Model: Exposure category - Model: Calculation method - Model: Link data - - class Map{ - Occurrence frequency - Time reference - Impact type - Loss type - Loss metric - Loss unit - } - class Curve{ - Occurrence frequency - Time reference - Impact type - Loss type - Loss metric - Loss unit - } ``` -`````{tab-set} +```{csv-table-no-translate} Resources +--- +stub-columns: 1 +widths: auto +file: ../../examples/vulnerability/flood_jrc/Resources.csv +--- -````{tab-item} Schema +``` -```{jsonschema} ../../docs/_readthedocs/html/rdls_schema.json +```{csv-table-no-translate} Attributions --- -pointer: /properties/loss -collapse: cost,impact -addtargets: +stub-columns: 1 +widths: auto +file: ../../examples/vulnerability/flood_jrc/Attributions.csv --- -``` -```` +``` -````{tab-item} Examples +```{csv-table-no-translate} Referenced by +--- +stub-columns: 1 +widths: auto +file: ../../examples/vulnerability/flood_jrc/Referenced by.csv +--- -Losses can be represented in many different way: regular raster grids, points, or polygons. Often, the loss data consist of measures aggregated at the administrative unit level. +``` -**Flood loss scenarios for Afghanistan, 2050** +```{csv-table-no-translate} Asset costs +--- +stub-columns: 1 +widths: auto +file: ../../examples/vulnerability/flood_jrc/Vulnerability metadata_Asset cost.csv +--- -Schema attributes for loss map related to future river flood hazard scenarios (2050) over all types of exposure occupancies for Afghanistan. +``` -![Flood losses in Afghanistan](../img/lss_fl_afg.jpg) +```` -The losses are higher in the most densely built-up area of Kabul. +````{tab-item} Metadata (JSON) -![Flood losses in Kabul](../img/lss_fl_kabul.jpg) +```{eval-rst} +.. jsoninclude:: ../../examples/vulnerability/flood_jrc/example.json + :jsonpointer: /datasets/0 + :title: Example +``` -| **Required** | **Attribute** | **Example** | -| :----------: | ---------------------- | ----------------------------------------------------------------------- | -| \* | Hazard type | Flood | -| | Hazard process | River flood | -| \* | Exposure occupancy | Mixed | -| \* | Exposure category | Buildings | -| \* | Value type | Structure | -| | Hazard link | [Dataset](http://jkan.riskdatalibrary.org/datasets/hzd-afg-fl-baseline) | -| | Exposure link | | -| | Vulnerability link | | -| | Time year | 2050 | -| | Frequency type | Return Period | -| | Occurrence probability | RP 5-1000 years | -| \* | Impact | Direct | -| \* | Loss type | Ground up | -| \* | Metric | Average Annual Losses | -| \* | Unit | USD | +```` -______________________________________________________________________ +````` +`````` -Losses can be investigated as total or for individual exposed asset and infrastructure elements. +## Loss metadata -![Example of data showing exposed roads in Afghanistan](../img/exp_afg_roads.jpg) +The `loss` component is described as: -______________________________________________________________________ +```{jsoninclude-quote} ../../docs/_readthedocs/html/rdls_schema.json +--- +jsonpointer: /properties/loss/description +--- +``` -**Observed losses** +The loss component provides metadata describing data generated in risk assessments, i.e., modelled impacts and losses for single historical events or hypothetical scenarios and risk estimates from analysis of large event sets. The data can include monetary and non-monetary, and direct or indirect, impacts and losses. +Loss datasets can be explicitly linked to the exposure, hazard, and vulnerability datasets used in the analysis. This component uses descriptions of assets, hazards and impact types consistent with all other components of this standard. Spatial reference and location information are described using existing external standards. Temporal information can include date and duration of events or year of scenario, and is defined using the Dublin Core standards. -Insert example of recorded empirical losses. +The following diagram shows key loss component fields, with required fields highlighted in blue: -| **Required** | **Attribute** | **Example** | -| :----------: | ----------------------- | ------------- | -| \* | Hazard type | Earthquake | -| \* | Analysis type | Probabilistic | -| \* | Calculation method | Simulated | -| | Frequency type | Return Period | -| | Occurrence probability | 1000 years | -| | Occurrence time (start) | 800 | -| | Occurrence time (end) | 2001 | -| | Occurrence time (span) | 1200 years | -| \* | Hazard process | Ground motion | -| \* | Unit of measure | PGA (g) | +```{eval-rst} +.. uml:: + + @startjson + + #highlight "hazard_type" <> + #highlight "cost" <> + #highlight "cost" / "type" <> + #highlight "cost" / "unit" <> + { + "hazard_type": "", + "hazard_process": "", + "category": "", + "type": "", + "impact": { + "type": "", + "metric": "", + "unit": "" + }, + "approach": "", + "cost": { + "type": "", + "unit": "" + } + } + @endjson +``` -```` +The following table lists all loss component fields: -````` +```{jsonschema} ../../docs/_readthedocs/html/rdls_schema.json +--- +pointer: /properties/loss +collapse: cost,impact +addtargets: +--- +``` ## Sub-schemas @@ -586,7 +927,7 @@ jsonpointer: /$defs/Gazetteer_entry/description This sub-schema is referenced by the following properties: -- [`Location/gazetteerEntries`](rdls_schema.json,/$defs/Location,gazetteerEntries) +- [`Location/gazetteer_entries`](rdls_schema.json,/$defs/Location,gazetteer_entries) Each `Gazetteer_entry` has the following fields: @@ -743,6 +1084,30 @@ addtargets: --- ``` +### Metric + +`Metric` is defined as: + +```{jsoninclude-quote} ../../docs/_readthedocs/html/rdls_schema.json +--- +jsonpointer: /$defs/Metric/description +--- +``` + +This sub-schema is referenced by the following properties: + +- [`exposure/metrics`](rdls_schema.json,/properties/exposure,metrics) + +Each `Metric` has the following fields: + +```{jsonschema} ../../docs/_readthedocs/html/rdls_schema.json +--- +pointer: /$defs/Metric +collapse: +addtargets: +--- +``` + ### Cost `Cost` is defined as: @@ -755,7 +1120,6 @@ jsonpointer: /$defs/Cost/description This sub-schema is referenced by the following properties: -- [`exposure/cost`](rdls_schema.json,/properties/exposure,cost) - [`vulnerability/cost`](rdls_schema.json,/properties/vulnerability,cost) - [`loss/cost`](rdls_schema.json,/properties/loss,cost) @@ -831,6 +1195,7 @@ jsonpointer: /$defs/Classification/description This sub-schema is referenced by the following properties: - [`vulnerability/se_category`](rdls_schema.json,/properties/vulnerability,se_category) +- [`Event/disaster_identifiers`](rdls_schema.json,/$defs/Event,disaster_identifiers) Each `Classification` has the following fields: diff --git a/docs/utils/plantuml-1.2023.10.jar b/docs/utils/plantuml-1.2023.10.jar new file mode 100644 index 00000000..aa8d50fe Binary files /dev/null and b/docs/utils/plantuml-1.2023.10.jar differ diff --git a/examples/exposure/central_asia_residential_current/Attributions.csv b/examples/exposure/central_asia_residential_current/Attributions.csv new file mode 100644 index 00000000..b7a5ed02 --- /dev/null +++ b/examples/exposure/central_asia_residential_current/Attributions.csv @@ -0,0 +1,7 @@ +Dataset identifier,https://datacatalog.worldbank.org/search/dataset/0064251/Central-Asia-exposure-dataset---Residential-buildings,https://datacatalog.worldbank.org/search/dataset/0064251/Central-Asia-exposure-dataset---Residential-buildings +Attribution identifier,0064251_attr1,0064251_attr2 +"Entity: +Name",Chi-Yun Huang,"OGS, Italy" +"Entity: +Email address",chuang@worldbank.org, +Role,custodian,collaborator diff --git a/examples/exposure/central_asia_residential_current/Exposure metadata_Exposure metrics.csv b/examples/exposure/central_asia_residential_current/Exposure metadata_Exposure metrics.csv new file mode 100644 index 00000000..1ded8ec2 --- /dev/null +++ b/examples/exposure/central_asia_residential_current/Exposure metadata_Exposure metrics.csv @@ -0,0 +1,4 @@ +Dataset identifier,https://datacatalog.worldbank.org/search/dataset/0064251/Central-Asia-exposure-dataset---Residential-buildings +Identifier,0064251_metric1 +Metric dimension,structure +Metric quantity kind,currency diff --git a/examples/exposure/central_asia_residential_current/Links.csv b/examples/exposure/central_asia_residential_current/Links.csv new file mode 100644 index 00000000..a45c40b5 --- /dev/null +++ b/examples/exposure/central_asia_residential_current/Links.csv @@ -0,0 +1,3 @@ +Dataset identifier,https://datacatalog.worldbank.org/search/dataset/0064251/Central-Asia-exposure-dataset---Residential-buildings +Link target,https://raw.githubusercontent.com/GFDRR/rdl-standard/0__2__0/schema/rdls_schema.json +Link relation type,describedby diff --git a/examples/exposure/central_asia_residential_current/Referenced by.csv b/examples/exposure/central_asia_residential_current/Referenced by.csv new file mode 100644 index 00000000..520cb07e --- /dev/null +++ b/examples/exposure/central_asia_residential_current/Referenced by.csv @@ -0,0 +1,4 @@ +Dataset identifier,https://datacatalog.worldbank.org/search/dataset/0064251/Central-Asia-exposure-dataset---Residential-buildings,https://datacatalog.worldbank.org/search/dataset/0064251/Central-Asia-exposure-dataset---Residential-buildings +Related resource identifier,0064251_ref1,0064251_ref2 +Name,Central Asia exposure data development technical report - English version,Central Asia exposure data development technical report - Russian version +URL,https://datacatalogfiles.worldbank.org/ddh-published/0064117/DR0091010/Task4_Exposure_Report_r6_EN.pdf?versionId=2023-07-21T17:33:32.2845222Z,https://datacatalogfiles.worldbank.org/ddh-published/0064117/DR0091011/Task4_Exposure_Report_r6_RU.pdf?versionId=2023-07-21T17:33:26.6527091Z diff --git a/examples/exposure/central_asia_residential_current/Resources.csv b/examples/exposure/central_asia_residential_current/Resources.csv new file mode 100644 index 00000000..44edbb1c --- /dev/null +++ b/examples/exposure/central_asia_residential_current/Resources.csv @@ -0,0 +1,17 @@ +Dataset identifier,https://datacatalog.worldbank.org/search/dataset/0064251/Central-Asia-exposure-dataset---Residential-buildings,https://datacatalog.worldbank.org/search/dataset/0064251/Central-Asia-exposure-dataset---Residential-buildings,https://datacatalog.worldbank.org/search/dataset/0064251/Central-Asia-exposure-dataset---Residential-buildings,https://datacatalog.worldbank.org/search/dataset/0064251/Central-Asia-exposure-dataset---Residential-buildings,https://datacatalog.worldbank.org/search/dataset/0064251/Central-Asia-exposure-dataset---Residential-buildings +Resource identifier,0064251_res1,0064251_res2,0064251_res3,0064251_res4,0064251_res5 +Resource title,Central Asia exposure dataset - Residential buildings - KAZ,Central Asia exposure dataset - Residential buildings - KGZ,Central Asia exposure dataset - Residential buildings - TJK,Central Asia exposure dataset - Residential buildings - TKM,Central Asia exposure dataset - Residential buildings - UZB +Resource description,"Central Asia exposure layers – Residential buildings - KAZ +Files: RESIDENTIAL_[OBLAST].csv, RESIDENTIAL_[OBLAST].shp","Central Asia exposure layers – Residential buildings - KGZ +Files: RESIDENTIAL_[OBLAST].csv, RESIDENTIAL_[OBLAST].shp","Central Asia exposure layers – Residential buildings - TJK +Files: RESIDENTIAL_[OBLAST].csv, RESIDENTIAL_[OBLAST].shp","Central Asia exposure layers – Residential buildings - TKM +Files: RESIDENTIAL_[OBLAST].csv, RESIDENTIAL_[OBLAST].shp","Central Asia exposure layers – Residential buildings - UZB +Files: RESIDENTIAL_[OBLAST].csv, RESIDENTIAL_[OBLAST].shp" +Format,csv,csv,csv,csv,csv +Spatial resolution,500,500,500,500,500 +Download Url,https://datacatalogfiles.worldbank.org/ddh-published/0064251/DR0091988/KAZ_residential_exposure.zip?versionId=2023-07-11T15:15:39.6450392Z,https://datacatalogfiles.worldbank.org/ddh-published/0064251/DR0091661/KGZ_residential_exposure.zip?versionId=2023-07-11T15:15:41.4460187Z,,https://datacatalogfiles.worldbank.org/ddh-published/0064251/DR0091659/TKM_residential_exposure.zip?versionId=2023-07-11T15:15:34.9986705Z,https://datacatalogfiles.worldbank.org/ddh-published/0064251/DR0091989/UZB_residential_exposure.zip?versionId=2023-07-11T15:15:43.2479984Z +"Temporal coverage: +Start",2020,2020,2020,2020,2020 +"Temporal coverage: +End date",2020,2020,2020,2020,2020 +resources/0/url,,,https://datacatalogfiles.worldbank.org/ddh-published/0064251/DR0091660/TJK_residential_exposure.zip?versionId=2023-07-11T15:15:37.7301236Z,, diff --git a/examples/exposure/central_asia_residential_current/Sources.csv b/examples/exposure/central_asia_residential_current/Sources.csv new file mode 100644 index 00000000..6d1ec570 --- /dev/null +++ b/examples/exposure/central_asia_residential_current/Sources.csv @@ -0,0 +1,2 @@ +Dataset identifier,https://datacatalog.worldbank.org/search/dataset/0064251/Central-Asia-exposure-dataset---Residential-buildings +Source identifier,0064251_src1 diff --git a/examples/exposure/central_asia_residential_current/Spatial coverage_Gazetteer entries.csv b/examples/exposure/central_asia_residential_current/Spatial coverage_Gazetteer entries.csv new file mode 100644 index 00000000..59463b76 --- /dev/null +++ b/examples/exposure/central_asia_residential_current/Spatial coverage_Gazetteer entries.csv @@ -0,0 +1,3 @@ +Dataset identifier,https://datacatalog.worldbank.org/search/dataset/0064251/Central-Asia-exposure-dataset---Residential-buildings,https://datacatalog.worldbank.org/search/dataset/0064251/Central-Asia-exposure-dataset---Residential-buildings,https://datacatalog.worldbank.org/search/dataset/0064251/Central-Asia-exposure-dataset---Residential-buildings,https://datacatalog.worldbank.org/search/dataset/0064251/Central-Asia-exposure-dataset---Residential-buildings,https://datacatalog.worldbank.org/search/dataset/0064251/Central-Asia-exposure-dataset---Residential-buildings +Gazetteer entry identifier,KAZ,KGZ,TJK,TKM,UZB +Scheme,ISO 3166-1 alpha-3,ISO 3166-1 alpha-3,ISO 3166-1 alpha-3,ISO 3166-1 alpha-3,ISO 3166-1 alpha-3 diff --git a/examples/exposure/central_asia_residential_current/datasets.csv b/examples/exposure/central_asia_residential_current/datasets.csv new file mode 100644 index 00000000..f022cc59 --- /dev/null +++ b/examples/exposure/central_asia_residential_current/datasets.csv @@ -0,0 +1,28 @@ +Dataset identifier,https://datacatalog.worldbank.org/search/dataset/0064251/Central-Asia-exposure-dataset---Residential-buildings +Title,Central-Asia-exposure-dataset---Current-residential-exposure +Description,Regional layer of residential buildings in Central Asia +Risk data type,exposure +"Publisher: +Name",World Bank +"Publisher: +Email address",sfraser@worldbank.org +"Publisher: +URL",http://www.worldbank.org +Dataset version,12 +Dataset purpose,"Developed as part of the regional risk assessment, under the Strengthening Financial Resilience and Accelerating Risk Reduction in Central Asia program. (https://www.gfdrr.org/en/program/SFRARR-Central-Asia)" +Project title,Strengthening Financial Resilience and Accelerating Risk Reduction in Central Asia +"Spatial coverage: +Countries",KAZ;KGZ;TJK;TKM;UZB +License,CC-BY-4.0 +"Contact point: +Name",Stuart Fraser +"Contact point: +Email address",sfraser@worldbank.org +"Creator: +Name",Risk Engineering and Development +"Creator: +URL",http://www.redrisk.com +"Exposure metadata: +Exposure category",buildings +"Exposure metadata: +Exposure taxonomy scheme",GED4ALL diff --git a/examples/exposure/central_asia_residential_current/example.json b/examples/exposure/central_asia_residential_current/example.json new file mode 100644 index 00000000..821f6e93 --- /dev/null +++ b/examples/exposure/central_asia_residential_current/example.json @@ -0,0 +1,173 @@ +{ + "datasets": [ + { + "id": "https://datacatalog.worldbank.org/search/dataset/0064251/Central-Asia-exposure-dataset---Residential-buildings", + "title": "Central-Asia-exposure-dataset---Current-residential-exposure", + "description": "Regional layer of residential buildings in Central Asia", + "risk_data_type": [ + "exposure" + ], + "publisher": { + "name": "World Bank", + "email": "sfraser@worldbank.org", + "url": "http://www.worldbank.org" + }, + "version": "12", + "purpose": "Developed as part of the regional risk assessment, under the Strengthening Financial Resilience and Accelerating Risk Reduction in Central Asia program. (https://www.gfdrr.org/en/program/SFRARR-Central-Asia)", + "project": "Strengthening Financial Resilience and Accelerating Risk Reduction in Central Asia ", + "spatial": { + "countries": [ + "KAZ", + "KGZ", + "TJK", + "TKM", + "UZB" + ], + "gazetteer_entries": [ + { + "id": "KAZ", + "scheme": "ISO 3166-1 alpha-3" + }, + { + "id": "KGZ", + "scheme": "ISO 3166-1 alpha-3" + }, + { + "id": "TJK", + "scheme": "ISO 3166-1 alpha-3" + }, + { + "id": "TKM", + "scheme": "ISO 3166-1 alpha-3" + }, + { + "id": "UZB", + "scheme": "ISO 3166-1 alpha-3" + } + ] + }, + "license": "CC-BY-4.0", + "contact_point": { + "name": "Stuart Fraser", + "email": "sfraser@worldbank.org" + }, + "creator": { + "name": "Risk Engineering and Development", + "url": "http://www.redrisk.com " + }, + "exposure": { + "category": "buildings", + "taxonomy": "GED4ALL", + "metrics": [ + { + "id": "0064251_metric1", + "dimension": "structure", + "quantity_kind": "currency" + } + ] + }, + "attributions": [ + { + "id": "0064251_attr1", + "entity": { + "name": "Chi-Yun Huang", + "email": "chuang@worldbank.org" + }, + "role": "custodian" + }, + { + "id": "0064251_attr2", + "entity": { + "name": "OGS, Italy" + }, + "role": "collaborator" + } + ], + "sources": [ + { + "id": "0064251_src1" + } + ], + "referenced_by": [ + { + "id": "0064251_ref1", + "name": "Central Asia exposure data development technical report - English version", + "url": "https://datacatalogfiles.worldbank.org/ddh-published/0064117/DR0091010/Task4_Exposure_Report_r6_EN.pdf?versionId=2023-07-21T17:33:32.2845222Z" + }, + { + "id": "0064251_ref2", + "name": "Central Asia exposure data development technical report - Russian version", + "url": "https://datacatalogfiles.worldbank.org/ddh-published/0064117/DR0091011/Task4_Exposure_Report_r6_RU.pdf?versionId=2023-07-21T17:33:26.6527091Z" + } + ], + "resources": [ + { + "id": "0064251_res1", + "title": "Central Asia exposure dataset - Residential buildings - KAZ", + "description": "Central Asia exposure layers – Residential buildings - KAZ\nFiles: RESIDENTIAL_[OBLAST].csv, RESIDENTIAL_[OBLAST].shp", + "format": "csv", + "spatial_resolution": 500, + "download_url": "https://datacatalogfiles.worldbank.org/ddh-published/0064251/DR0091988/KAZ_residential_exposure.zip?versionId=2023-07-11T15:15:39.6450392Z", + "temporal": { + "start": "2020", + "end": "2020" + } + }, + { + "id": "0064251_res2", + "title": "Central Asia exposure dataset - Residential buildings - KGZ", + "description": "Central Asia exposure layers – Residential buildings - KGZ\nFiles: RESIDENTIAL_[OBLAST].csv, RESIDENTIAL_[OBLAST].shp", + "format": "csv", + "spatial_resolution": 500, + "download_url": "https://datacatalogfiles.worldbank.org/ddh-published/0064251/DR0091661/KGZ_residential_exposure.zip?versionId=2023-07-11T15:15:41.4460187Z", + "temporal": { + "start": "2020", + "end": "2020" + } + }, + { + "id": "0064251_res3", + "title": "Central Asia exposure dataset - Residential buildings - TJK", + "description": "Central Asia exposure layers – Residential buildings - TJK\nFiles: RESIDENTIAL_[OBLAST].csv, RESIDENTIAL_[OBLAST].shp", + "format": "csv", + "spatial_resolution": 500, + "url": "https://datacatalogfiles.worldbank.org/ddh-published/0064251/DR0091660/TJK_residential_exposure.zip?versionId=2023-07-11T15:15:37.7301236Z", + "temporal": { + "start": "2020", + "end": "2020" + } + }, + { + "id": "0064251_res4", + "title": "Central Asia exposure dataset - Residential buildings - TKM", + "description": "Central Asia exposure layers – Residential buildings - TKM\nFiles: RESIDENTIAL_[OBLAST].csv, RESIDENTIAL_[OBLAST].shp", + "format": "csv", + "spatial_resolution": 500, + "download_url": "https://datacatalogfiles.worldbank.org/ddh-published/0064251/DR0091659/TKM_residential_exposure.zip?versionId=2023-07-11T15:15:34.9986705Z", + "temporal": { + "start": "2020", + "end": "2020" + } + }, + { + "id": "0064251_res5", + "title": "Central Asia exposure dataset - Residential buildings - UZB", + "description": "Central Asia exposure layers – Residential buildings - UZB\nFiles: RESIDENTIAL_[OBLAST].csv, RESIDENTIAL_[OBLAST].shp", + "format": "csv", + "spatial_resolution": 500, + "download_url": "https://datacatalogfiles.worldbank.org/ddh-published/0064251/DR0091989/UZB_residential_exposure.zip?versionId=2023-07-11T15:15:43.2479984Z", + "temporal": { + "start": "2020", + "end": "2020" + } + } + ], + "links": [ + { + "href": "https://raw.githubusercontent.com/GFDRR/rdl-standard/0__2__0/schema/rdls_schema.json", + "rel": "describedby" + } + ] + } + ] +} diff --git a/examples/exposure/central_asia_residential_projected/Attributions.csv b/examples/exposure/central_asia_residential_projected/Attributions.csv new file mode 100644 index 00000000..50066cf1 --- /dev/null +++ b/examples/exposure/central_asia_residential_projected/Attributions.csv @@ -0,0 +1,7 @@ +Dataset identifier,https://datacatalog.worldbank.org/search/dataset/0064254/Central-Asia-exposure-dataset---Projected-residential-exposure,https://datacatalog.worldbank.org/search/dataset/0064254/Central-Asia-exposure-dataset---Projected-residential-exposure +Attribution identifier,0064254_attr1,0064254_attr2 +"Entity: +Name",Chi-Yun Huang,"OGS, Italy" +"Entity: +Email address",chuang@worldbank.org, +Role,custodian,collaborator diff --git a/examples/exposure/central_asia_residential_projected/Exposure metadata_Exposure metrics.csv b/examples/exposure/central_asia_residential_projected/Exposure metadata_Exposure metrics.csv new file mode 100644 index 00000000..a120d14e --- /dev/null +++ b/examples/exposure/central_asia_residential_projected/Exposure metadata_Exposure metrics.csv @@ -0,0 +1,4 @@ +Dataset identifier,https://datacatalog.worldbank.org/search/dataset/0064254/Central-Asia-exposure-dataset---Projected-residential-exposure +Identifier,0064254_metric1 +Metric dimension,structure +Metric quantity kind,currency diff --git a/examples/exposure/central_asia_residential_projected/Links.csv b/examples/exposure/central_asia_residential_projected/Links.csv new file mode 100644 index 00000000..92e0bce5 --- /dev/null +++ b/examples/exposure/central_asia_residential_projected/Links.csv @@ -0,0 +1,3 @@ +Dataset identifier,https://datacatalog.worldbank.org/search/dataset/0064254/Central-Asia-exposure-dataset---Projected-residential-exposure +Link target,https://raw.githubusercontent.com/GFDRR/rdl-standard/0__2__0/schema/rdls_schema.json +Link relation type,describedby diff --git a/examples/exposure/central_asia_residential_projected/Referenced by.csv b/examples/exposure/central_asia_residential_projected/Referenced by.csv new file mode 100644 index 00000000..081921fe --- /dev/null +++ b/examples/exposure/central_asia_residential_projected/Referenced by.csv @@ -0,0 +1,4 @@ +Dataset identifier,https://datacatalog.worldbank.org/search/dataset/0064254/Central-Asia-exposure-dataset---Projected-residential-exposure,https://datacatalog.worldbank.org/search/dataset/0064254/Central-Asia-exposure-dataset---Projected-residential-exposure +Related resource identifier,0064254_ref1,0064254_ref2 +Name,Central Asia exposure data development technical report - English version,Central Asia exposure data development technical report - Russian version +URL,https://datacatalogfiles.worldbank.org/ddh-published/0064117/DR0091010/Task4_Exposure_Report_r6_EN.pdf?versionId=2023-07-21T17:33:32.2845222Z,https://datacatalogfiles.worldbank.org/ddh-published/0064117/DR0091011/Task4_Exposure_Report_r6_RU.pdf?versionId=2023-07-21T17:33:26.6527091Z diff --git a/examples/exposure/central_asia_residential_projected/Resources.csv b/examples/exposure/central_asia_residential_projected/Resources.csv new file mode 100644 index 00000000..90dbe3c2 --- /dev/null +++ b/examples/exposure/central_asia_residential_projected/Resources.csv @@ -0,0 +1,18 @@ +Dataset identifier,https://datacatalog.worldbank.org/search/dataset/0064254/Central-Asia-exposure-dataset---Projected-residential-exposure,https://datacatalog.worldbank.org/search/dataset/0064254/Central-Asia-exposure-dataset---Projected-residential-exposure,https://datacatalog.worldbank.org/search/dataset/0064254/Central-Asia-exposure-dataset---Projected-residential-exposure +Resource identifier,0064254_res1,0064254_res2,0064254_res3 +Resource title,"Central Asia projected (2080) residential exposure - all countries, Oblast level: SSP1","Central Asia projected (2080) residential exposure - all countries, Oblast level: SSP4","Central Asia projected (2080) residential exposure - all countries, Oblast level: SSP5" +Resource description,"Central Asia projected (2080) residential exposure - for all five Central Asia countries included in the analysis, one file per Oblast (ADM1) for SSP1 +Dataset includes projected residneital data for SSP1, SSP4, SSP5 scenarios. +Files: RESIDENTIAL_[OBLAST]._2080_[SSP].csv","Central Asia projected (2080) residential exposure - for all five Central Asia countries included in the analysis, one file per Oblast (ADM1) for SSP4 +Dataset includes projected residneital data for SSP1, SSP4, SSP5 scenarios. +Files: RESIDENTIAL_[OBLAST]._2080_[SSP].csv","Central Asia projected (2080) residential exposure - for all five Central Asia countries included in the analysis, one file per Oblast (ADM1) for SSP5 +Dataset includes projected residneital data for SSP1, SSP4, SSP5 scenarios. +Files: RESIDENTIAL_[OBLAST]._2080_[SSP].csv" +Format,csv,csv,csv +Spatial resolution,500,500,500 +resources/0/downloadurl,https://datacatalogfiles.worldbank.org/ddh-published/0064254/DR0091991/P2080_SSP1.zip?versionId=2023-07-11T15:12:01.4656749Z,, +"Temporal coverage: +Start",2080,2080,2080 +"Temporal coverage: +End date",2080,2080,2080 +Download Url,,https://datacatalogfiles.worldbank.org/ddh-published/0064254/DR0091992/P2080_SSP4.zip?versionId=2023-07-11T15:12:06.1470219Z,https://datacatalogfiles.worldbank.org/ddh-published/0064254/DR0091993/P2080_SSP5.zip?versionId=2023-07-11T15:12:03.5145140Z diff --git a/examples/exposure/central_asia_residential_projected/Sources.csv b/examples/exposure/central_asia_residential_projected/Sources.csv new file mode 100644 index 00000000..7846c4fe --- /dev/null +++ b/examples/exposure/central_asia_residential_projected/Sources.csv @@ -0,0 +1,2 @@ +Dataset identifier,https://datacatalog.worldbank.org/search/dataset/0064254/Central-Asia-exposure-dataset---Projected-residential-exposure +Source identifier,0064254_src1 diff --git a/examples/exposure/central_asia_residential_projected/Spatial coverage_Gazetteer entries.csv b/examples/exposure/central_asia_residential_projected/Spatial coverage_Gazetteer entries.csv new file mode 100644 index 00000000..54d9cff2 --- /dev/null +++ b/examples/exposure/central_asia_residential_projected/Spatial coverage_Gazetteer entries.csv @@ -0,0 +1,3 @@ +Dataset identifier,https://datacatalog.worldbank.org/search/dataset/0064254/Central-Asia-exposure-dataset---Projected-residential-exposure,https://datacatalog.worldbank.org/search/dataset/0064254/Central-Asia-exposure-dataset---Projected-residential-exposure,https://datacatalog.worldbank.org/search/dataset/0064254/Central-Asia-exposure-dataset---Projected-residential-exposure,https://datacatalog.worldbank.org/search/dataset/0064254/Central-Asia-exposure-dataset---Projected-residential-exposure,https://datacatalog.worldbank.org/search/dataset/0064254/Central-Asia-exposure-dataset---Projected-residential-exposure +Gazetteer entry identifier,KAZ,KGZ,TJK,TKM,UZB +Scheme,ISO 3166-1 alpha-3,ISO 3166-1 alpha-3,ISO 3166-1 alpha-3,ISO 3166-1 alpha-3,ISO 3166-1 alpha-3 diff --git a/examples/exposure/central_asia_residential_projected/datasets.csv b/examples/exposure/central_asia_residential_projected/datasets.csv new file mode 100644 index 00000000..6a732368 --- /dev/null +++ b/examples/exposure/central_asia_residential_projected/datasets.csv @@ -0,0 +1,28 @@ +Dataset identifier,https://datacatalog.worldbank.org/search/dataset/0064254/Central-Asia-exposure-dataset---Projected-residential-exposure +Title,Central-Asia-exposure-dataset---Projected-residential-exposure +Description,"Regional layer of residential buildings in Central Asia, projected to 2080" +Risk data type,exposure +"Publisher: +Name",World Bank +"Publisher: +Email address",sfraser@worldbank.org +"Publisher: +URL",http://www.worldbank.org +Dataset version,12 +Dataset purpose,"Developed as part of the regional risk assessment, under the Strengthening Financial Resilience and Accelerating Risk Reduction in Central Asia program. (https://www.gfdrr.org/en/program/SFRARR-Central-Asia)" +Project title,Strengthening Financial Resilience and Accelerating Risk Reduction in Central Asia +"Spatial coverage: +Countries",KAZ;KGZ;TJK;TKM;UZB +License,CC-BY-4.0 +"Contact point: +Name",Stuart Fraser +"Contact point: +Email address",sfraser@worldbank.org +"Creator: +Name",Risk Engineering and Development +"Creator: +URL",http://www.redrisk.com +"Exposure metadata: +Exposure category",buildings +"Exposure metadata: +Exposure taxonomy scheme",GED4ALL diff --git a/examples/exposure/central_asia_residential_projected/example.json b/examples/exposure/central_asia_residential_projected/example.json new file mode 100644 index 00000000..77cf6a75 --- /dev/null +++ b/examples/exposure/central_asia_residential_projected/example.json @@ -0,0 +1,149 @@ +{ + "datasets": [ + { + "id": "https://datacatalog.worldbank.org/search/dataset/0064254/Central-Asia-exposure-dataset---Projected-residential-exposure", + "title": "Central-Asia-exposure-dataset---Projected-residential-exposure", + "description": "Regional layer of residential buildings in Central Asia, projected to 2080", + "risk_data_type": [ + "exposure" + ], + "publisher": { + "name": "World Bank", + "email": "sfraser@worldbank.org", + "url": "http://www.worldbank.org" + }, + "version": "12", + "purpose": "Developed as part of the regional risk assessment, under the Strengthening Financial Resilience and Accelerating Risk Reduction in Central Asia program. (https://www.gfdrr.org/en/program/SFRARR-Central-Asia)", + "project": "Strengthening Financial Resilience and Accelerating Risk Reduction in Central Asia ", + "spatial": { + "countries": [ + "KAZ", + "KGZ", + "TJK", + "TKM", + "UZB" + ], + "gazetteer_entries": [ + { + "id": "KAZ", + "scheme": "ISO 3166-1 alpha-3" + }, + { + "id": "KGZ", + "scheme": "ISO 3166-1 alpha-3" + }, + { + "id": "TJK", + "scheme": "ISO 3166-1 alpha-3" + }, + { + "id": "TKM", + "scheme": "ISO 3166-1 alpha-3" + }, + { + "id": "UZB", + "scheme": "ISO 3166-1 alpha-3" + } + ] + }, + "license": "CC-BY-4.0", + "contact_point": { + "name": "Stuart Fraser", + "email": "sfraser@worldbank.org" + }, + "creator": { + "name": "Risk Engineering and Development", + "url": "http://www.redrisk.com " + }, + "exposure": { + "category": "buildings", + "taxonomy": "GED4ALL", + "metrics": [ + { + "id": "0064254_metric1", + "dimension": "structure", + "quantity_kind": "currency" + } + ] + }, + "attributions": [ + { + "id": "0064254_attr1", + "entity": { + "name": "Chi-Yun Huang", + "email": "chuang@worldbank.org" + }, + "role": "custodian" + }, + { + "id": "0064254_attr2", + "entity": { + "name": "OGS, Italy" + }, + "role": "collaborator" + } + ], + "sources": [ + { + "id": "0064254_src1" + } + ], + "referenced_by": [ + { + "id": "0064254_ref1", + "name": "Central Asia exposure data development technical report - English version", + "url": "https://datacatalogfiles.worldbank.org/ddh-published/0064117/DR0091010/Task4_Exposure_Report_r6_EN.pdf?versionId=2023-07-21T17:33:32.2845222Z" + }, + { + "id": "0064254_ref2", + "name": "Central Asia exposure data development technical report - Russian version", + "url": "https://datacatalogfiles.worldbank.org/ddh-published/0064117/DR0091011/Task4_Exposure_Report_r6_RU.pdf?versionId=2023-07-21T17:33:26.6527091Z" + } + ], + "resources": [ + { + "id": "0064254_res1", + "title": "Central Asia projected (2080) residential exposure - all countries, Oblast level: SSP1", + "description": "Central Asia projected (2080) residential exposure - for all five Central Asia countries included in the analysis, one file per Oblast (ADM1) for SSP1\nDataset includes projected residneital data for SSP1, SSP4, SSP5 scenarios.\nFiles: RESIDENTIAL_[OBLAST]._2080_[SSP].csv", + "format": "csv", + "spatial_resolution": 500, + "downloadurl": "https://datacatalogfiles.worldbank.org/ddh-published/0064254/DR0091991/P2080_SSP1.zip?versionId=2023-07-11T15:12:01.4656749Z", + "temporal": { + "start": "2080", + "end": "2080" + } + }, + { + "id": "0064254_res2", + "title": "Central Asia projected (2080) residential exposure - all countries, Oblast level: SSP4", + "description": "Central Asia projected (2080) residential exposure - for all five Central Asia countries included in the analysis, one file per Oblast (ADM1) for SSP4\nDataset includes projected residneital data for SSP1, SSP4, SSP5 scenarios.\nFiles: RESIDENTIAL_[OBLAST]._2080_[SSP].csv", + "format": "csv", + "spatial_resolution": 500, + "download_url": "https://datacatalogfiles.worldbank.org/ddh-published/0064254/DR0091992/P2080_SSP4.zip?versionId=2023-07-11T15:12:06.1470219Z", + "temporal": { + "start": "2080", + "end": "2080" + } + }, + { + "id": "0064254_res3", + "title": "Central Asia projected (2080) residential exposure - all countries, Oblast level: SSP5", + "description": "Central Asia projected (2080) residential exposure - for all five Central Asia countries included in the analysis, one file per Oblast (ADM1) for SSP5\nDataset includes projected residneital data for SSP1, SSP4, SSP5 scenarios.\nFiles: RESIDENTIAL_[OBLAST]._2080_[SSP].csv", + "format": "csv", + "spatial_resolution": 500, + "download_url": "https://datacatalogfiles.worldbank.org/ddh-published/0064254/DR0091993/P2080_SSP5.zip?versionId=2023-07-11T15:12:03.5145140Z", + "temporal": { + "start": "2080", + "end": "2080" + } + } + ], + "links": [ + { + "href": "https://raw.githubusercontent.com/GFDRR/rdl-standard/0__2__0/schema/rdls_schema.json", + "rel": "describedby" + } + ] + } + ] +} diff --git a/examples/full/SFRARR_fluvialhazardmaps/Attributions.csv b/examples/full/SFRARR_fluvialhazardmaps/Attributions.csv new file mode 100644 index 00000000..dc3124b4 --- /dev/null +++ b/examples/full/SFRARR_fluvialhazardmaps/Attributions.csv @@ -0,0 +1,9 @@ +Dataset identifier,https://datacatalog.worldbank.org/search/dataset/0064232 +Attribution identifier,0064232_1attr +"Entity: +Name",World Bank +"Entity: +Email address",chuang@worldbank.org +"Entity: +URL",http://www.worldbank.org +Role,custodian diff --git a/examples/full/SFRARR_fluvialhazardmaps/Hazard metadata_Event sets.csv b/examples/full/SFRARR_fluvialhazardmaps/Hazard metadata_Event sets.csv new file mode 100644 index 00000000..6609d787 --- /dev/null +++ b/examples/full/SFRARR_fluvialhazardmaps/Hazard metadata_Event sets.csv @@ -0,0 +1,10 @@ +Dataset identifier,https://datacatalog.worldbank.org/search/dataset/0064232 +Event set identifier,0064232_EventSet1 +Analysis type,probabilistic +Seasonality distribution,uniform +Calculation Method,simulated +Event count,10000 +"Spatial coverage: +Countries",KAZ;KGZ;TJK;TKM;UZB +"Spatial coverage: +Spatial scale",regional diff --git a/examples/full/SFRARR_fluvialhazardmaps/Hazard metadata_Event sets_Events.csv b/examples/full/SFRARR_fluvialhazardmaps/Hazard metadata_Event sets_Events.csv new file mode 100644 index 00000000..02116cd5 --- /dev/null +++ b/examples/full/SFRARR_fluvialhazardmaps/Hazard metadata_Event sets_Events.csv @@ -0,0 +1,16 @@ +Dataset identifier,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232 +Event set identifier,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1 +Event identifier,0064232_EventSet1_KAZ_5,0064232_EventSet1_KAZ_10,0064232_EventSet1_KAZ_20,0064232_EventSet1_KAZ_50,0064232_EventSet1_KAZ_100,0064232_EventSet1_KAZ_200,0064232_EventSet1_KAZ_500,0064232_EventSet1_KAZ_1000,0064232_EventSet1_KGZ_5,0064232_EventSet1_KGZ_10,0064232_EventSet1_KGZ_20,0064232_EventSet1_KGZ_50,0064232_EventSet1_KGZ_100,0064232_EventSet1_KGZ_200,0064232_EventSet1_KGZ_500,0064232_EventSet1_KGZ_1000,0064232_EventSet1_TJK_5,0064232_EventSet1_TJK_10,0064232_EventSet1_TJK_20,0064232_EventSet1_TJK_50,0064232_EventSet1_TJK_100,0064232_EventSet1_TJK_200,0064232_EventSet1_TJK_500,0064232_EventSet1_TJK_1000,0064232_EventSet1_TKM_5,0064232_EventSet1_TKM_10,0064232_EventSet1_TKM_20,0064232_EventSet1_TKM_50,0064232_EventSet1_TKM_100,0064232_EventSet1_TKM_200,0064232_EventSet1_TKM_500,0064232_EventSet1_TKM_1000,0064232_EventSet1_UZB_5,0064232_EventSet1_UZB_10,0064232_EventSet1_UZB_20,0064232_EventSet1_UZB_50,0064232_EventSet1_UZB_100,0064232_EventSet1_UZB_200,0064232_EventSet1_UZB_500,0064232_EventSet1_UZB_1000 +Disaster identifier,n/a,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,, +Model calculation method,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated,simulated +"Hazard: +Hazard identifier",0064232_EventSet1_KAZ_5,0064232_EventSet1_KAZ_10,0064232_EventSet1_KAZ_20,0064232_EventSet1_KAZ_50,0064232_EventSet1_KAZ_100,0064232_EventSet1_KAZ_200,0064232_EventSet1_KAZ_500,0064232_EventSet1_KAZ_1000,0064232_EventSet1_KGZ_5,0064232_EventSet1_KGZ_10,0064232_EventSet1_KGZ_20,0064232_EventSet1_KGZ_50,0064232_EventSet1_KGZ_100,0064232_EventSet1_KGZ_200,0064232_EventSet1_KGZ_500,0064232_EventSet1_KGZ_1000,0064232_EventSet1_TJK_5,0064232_EventSet1_TJK_10,0064232_EventSet1_TJK_20,0064232_EventSet1_TJK_50,0064232_EventSet1_TJK_100,0064232_EventSet1_TJK_200,0064232_EventSet1_TJK_500,0064232_EventSet1_TJK_1000,0064232_EventSet1_TKM_5,0064232_EventSet1_TKM_10,0064232_EventSet1_TKM_20,0064232_EventSet1_TKM_50,0064232_EventSet1_TKM_100,0064232_EventSet1_TKM_200,0064232_EventSet1_TKM_500,0064232_EventSet1_TKM_1000,0064232_EventSet1_UZB_5,0064232_EventSet1_UZB_10,0064232_EventSet1_UZB_20,0064232_EventSet1_UZB_50,0064232_EventSet1_UZB_100,0064232_EventSet1_UZB_200,0064232_EventSet1_UZB_500,0064232_EventSet1_UZB_1000 +"Hazard: +Hazard type",flood,flood,flood,flood,flood,flood,flood,flood,flood,flood,flood,flood,flood,flood,flood,flood,flood,flood,flood,flood,flood,flood,flood,flood,flood,flood,flood,flood,flood,flood,flood,flood,flood,flood,flood,flood,flood,flood,flood,flood +"Hazard: +Hazard processes",fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood,fluvial_flood +"Hazard: +Intensity measure",fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m +"Occurrence: +Probabilistic frequency: +Return period",5,10,20,50,100,200,500,1000,5,10,20,50,100,200,500,1000,5,10,20,50,100,200,500,1000,5,10,20,50,100,200,500,1000,5,10,20,50,100,200,500,1000 diff --git a/examples/full/SFRARR_fluvialhazardmaps/Hazard metadata_Event sets_Events_Footprints.csv b/examples/full/SFRARR_fluvialhazardmaps/Hazard metadata_Event sets_Events_Footprints.csv new file mode 100644 index 00000000..acd4bbb5 --- /dev/null +++ b/examples/full/SFRARR_fluvialhazardmaps/Hazard metadata_Event sets_Events_Footprints.csv @@ -0,0 +1,5 @@ +Dataset identifier,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232 +Event set identifier,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1 +Event identifier,0064232_EventSet1_KAZ_5,0064232_EventSet1_KAZ_10,0064232_EventSet1_KAZ_20,0064232_EventSet1_KAZ_50,0064232_EventSet1_KAZ_100,0064232_EventSet1_KAZ_200,0064232_EventSet1_KAZ_500,0064232_EventSet1_KAZ_1000,0064232_EventSet1_KGZ_5,0064232_EventSet1_KGZ_10,0064232_EventSet1_KGZ_20,0064232_EventSet1_KGZ_50,0064232_EventSet1_KGZ_100,0064232_EventSet1_KGZ_200,0064232_EventSet1_KGZ_500,0064232_EventSet1_KGZ_1000,0064232_EventSet1_TJK_5,0064232_EventSet1_TJK_10,0064232_EventSet1_TJK_20,0064232_EventSet1_TJK_50,0064232_EventSet1_TJK_100,0064232_EventSet1_TJK_200,0064232_EventSet1_TJK_500,0064232_EventSet1_TJK_1000,0064232_EventSet1_TKM_5,0064232_EventSet1_TKM_10,0064232_EventSet1_TKM_20,0064232_EventSet1_TKM_50,0064232_EventSet1_TKM_100,0064232_EventSet1_TKM_200,0064232_EventSet1_TKM_500,0064232_EventSet1_TKM_1000,0064232_EventSet1_UZB_5,0064232_EventSet1_UZB_10,0064232_EventSet1_UZB_20,0064232_EventSet1_UZB_50,0064232_EventSet1_UZB_100,0064232_EventSet1_UZB_200,0064232_EventSet1_UZB_500,0064232_EventSet1_UZB_1000 +Footprint identifier,0064232_EventSet1_KAZ_5,0064232_EventSet1_KAZ_10,0064232_EventSet1_KAZ_20,0064232_EventSet1_KAZ_50,0064232_EventSet1_KAZ_100,0064232_EventSet1_KAZ_200,0064232_EventSet1_KAZ_500,0064232_EventSet1_KAZ_1000,0064232_EventSet1_KGZ_5,0064232_EventSet1_KGZ_10,0064232_EventSet1_KGZ_20,0064232_EventSet1_KGZ_50,0064232_EventSet1_KGZ_100,0064232_EventSet1_KGZ_200,0064232_EventSet1_KGZ_500,0064232_EventSet1_KGZ_1000,0064232_EventSet1_TJK_5,0064232_EventSet1_TJK_10,0064232_EventSet1_TJK_20,0064232_EventSet1_TJK_50,0064232_EventSet1_TJK_100,0064232_EventSet1_TJK_200,0064232_EventSet1_TJK_500,0064232_EventSet1_TJK_1000,0064232_EventSet1_TKM_5,0064232_EventSet1_TKM_10,0064232_EventSet1_TKM_20,0064232_EventSet1_TKM_50,0064232_EventSet1_TKM_100,0064232_EventSet1_TKM_200,0064232_EventSet1_TKM_500,0064232_EventSet1_TKM_1000,0064232_EventSet1_UZB_5,0064232_EventSet1_UZB_10,0064232_EventSet1_UZB_20,0064232_EventSet1_UZB_50,0064232_EventSet1_UZB_100,0064232_EventSet1_UZB_200,0064232_EventSet1_UZB_500,0064232_EventSet1_UZB_1000 +Hazard intensity measurement,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m,fl_wd:m diff --git a/examples/full/SFRARR_fluvialhazardmaps/Hazard metadata_Event sets_Hazards.csv b/examples/full/SFRARR_fluvialhazardmaps/Hazard metadata_Event sets_Hazards.csv new file mode 100644 index 00000000..dbb986ab --- /dev/null +++ b/examples/full/SFRARR_fluvialhazardmaps/Hazard metadata_Event sets_Hazards.csv @@ -0,0 +1,6 @@ +Dataset identifier,https://datacatalog.worldbank.org/search/dataset/0064232 +Event set identifier,0064232_EventSet1 +Hazard identifier,0064232_EventSet1_FL +Hazard type,flood +Hazard processes,fluvial_flood +Intensity measure,fl_wd:m diff --git a/examples/full/SFRARR_fluvialhazardmaps/Hazard metadata_Event sets_Spatial coverage_Gazetteer entries.csv b/examples/full/SFRARR_fluvialhazardmaps/Hazard metadata_Event sets_Spatial coverage_Gazetteer entries.csv new file mode 100644 index 00000000..9cfde234 --- /dev/null +++ b/examples/full/SFRARR_fluvialhazardmaps/Hazard metadata_Event sets_Spatial coverage_Gazetteer entries.csv @@ -0,0 +1,5 @@ +Dataset identifier,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232 +Event set identifier,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1,0064232_EventSet1 +Gazetteer entry identifier,KAZ,KGZ,TJK,TKM,UZB +Scheme,ISO 3166-1 alpha-3,ISO 3166-1 alpha-3,ISO 3166-1 alpha-3,ISO 3166-1 alpha-3,ISO 3166-1 alpha-3 +Description,Kazakhstan,Kyrgyz Republic,Tajikistan,Turkmenistan,Uzbekistan diff --git a/examples/full/SFRARR_fluvialhazardmaps/Links.csv b/examples/full/SFRARR_fluvialhazardmaps/Links.csv new file mode 100644 index 00000000..74f6da51 --- /dev/null +++ b/examples/full/SFRARR_fluvialhazardmaps/Links.csv @@ -0,0 +1,3 @@ +Dataset identifier,https://datacatalog.worldbank.org/search/dataset/0064232 +Link target,https://raw.githubusercontent.com/GFDRR/rdl-standard/0__2__0/schema/rdls_schema.json +Link relation type,describedby diff --git a/examples/full/SFRARR_fluvialhazardmaps/Referenced by.csv b/examples/full/SFRARR_fluvialhazardmaps/Referenced by.csv new file mode 100644 index 00000000..df274b78 --- /dev/null +++ b/examples/full/SFRARR_fluvialhazardmaps/Referenced by.csv @@ -0,0 +1,6 @@ +Dataset identifier,https://datacatalog.worldbank.org/search/dataset/0064232 +Related resource identifier,0064232_ref1 +Name,Central Asia flood hazard technical report - English version +Author names,Risk Engineering and Development +Publication date,2023-02-09 +URL,https://datacatalogfiles.worldbank.org/ddh-published/0064084/DR0090774/Task3_FloodHazard_Report_r5_EN.pdf?versionId=2023-07-21T17:34:14.1038579Z diff --git a/examples/full/SFRARR_fluvialhazardmaps/Resources.csv b/examples/full/SFRARR_fluvialhazardmaps/Resources.csv new file mode 100644 index 00000000..ec517a96 --- /dev/null +++ b/examples/full/SFRARR_fluvialhazardmaps/Resources.csv @@ -0,0 +1,9 @@ +Dataset identifier,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232,https://datacatalog.worldbank.org/search/dataset/0064232 +Resource identifier,0064232_res1,0064232_res2,0064232_res3,0064232_res4,0064232_res5,0064232_res6 +Resource title,Central Asia fluvial flood hazard maps - defended – KAZ 5-50y RP,Central Asia fluvial flood hazard maps - defended – KAZ 100-1000y RP,Central Asia fluvial flood hazard maps - defended - KGZ,Central Asia fluvial flood hazard maps - defended - TJK,Central Asia fluvial flood hazard maps - defended - TKM,Central Asia fluvial flood hazard maps - defended - UZB +Resource description,"Fluvial flood hazard maps for Central Asia, derived from a regional model. Filenaming: FLU_DEF_XXy_ZZZ.tif (XX= return period, ZZZ= country initials). Cell value gives maximum flood depth (m) expected for the return period of that raster dataset. Due to file size, this is a partial set of data covering 1-in-5-50y return period. See dataset “Central Asia fluvial flood hazard maps - defended – KAZ 100-1000y RP” for the remaining data.","Fluvial flood hazard maps for Central Asia, derived from a regional model. Filenaming: FLU_DEF_XXy_ZZZ.tif (XX= return period, ZZZ= country initials). Cell value gives maximum flood depth (m) expected for the return period of that raster dataset. Due to file size, this is a partial set of data covering 1-in-100-1000y return period. See dataset “Central Asia fluvial flood hazard maps - defended – KaZ 5-50y RP” for the remaining data.","Fluvial flood hazard maps for Central Asia, derived from a regional model. Filenaming: FLU_DEF_XXy_ZZZ.tif (XX= return period, ZZZ= country initials). Cell value gives maximum flood depth (m) expected for the return period of that raster dataset.","Fluvial flood hazard maps for Central Asia, derived from a regional model. Filenaming: FLU_DEF_XXy_ZZZ.tif (XX= return period, ZZZ= country initials). Cell value gives maximum flood depth (m) expected for the return period of that raster dataset.","Fluvial flood hazard maps for Central Asia, derived from a regional model. Filenaming: FLU_DEF_XXy_ZZZ.tif (XX= return period, ZZZ= country initials). Cell value gives maximum flood depth (m) expected for the return period of that raster dataset.","Fluvial flood hazard maps for Central Asia, derived from a regional model. Filenaming: FLU_DEF_XXy_ZZZ.tif (XX= return period, ZZZ= country initials). Cell value gives maximum flood depth (m) expected for the return period of that raster dataset." +Media type,image/tiff,image/tiff,image/tiff,image/tiff,image/tiff,image/tiff +Format,geotiff,geotiff,geotiff,geotiff,geotiff,geotiff +Spatial resolution,90,90,90,90,90,90 +Coordinate reference system,EPSG:4326,EPSG:4326,EPSG:4326,EPSG:4326,EPSG:4326,EPSG:4326 +Download Url,https://datacatalogfiles.worldbank.org/ddh-published/0064232/DR0092000/FLU_DEF_KAZ_5-50yRP.zip?versionId=2023-07-11T15:17:06.8346489Z,https://datacatalogfiles.worldbank.org/ddh-published/0064232/DR0092001/FLU_DEF_KAZ_100-1000yRP.zip?versionId=2023-07-11T15:17:09.5061377Z,https://datacatalogfiles.worldbank.org/ddh-published/0064232/DR0091440/FLU_DEF_KGZ.zip?versionId=2023-07-11T15:16:59.0750434Z,https://datacatalogfiles.worldbank.org/ddh-published/0064232/DR0091439/FLU_DEF_TJK.zip?versionId=2023-07-11T15:17:11.4860175Z,https://datacatalogfiles.worldbank.org/ddh-published/0064232/DR0091768/FLU_DEF_TKM.zip?versionId=2023-07-11T15:17:01.5896193Z,https://datacatalogfiles.worldbank.org/ddh-published/0064232/DR0091769/FLU_DEF_UZB.zip?versionId=2023-07-11T15:17:04.1441727Z diff --git a/examples/full/SFRARR_fluvialhazardmaps/Sources.csv b/examples/full/SFRARR_fluvialhazardmaps/Sources.csv new file mode 100644 index 00000000..ac0cfb3a --- /dev/null +++ b/examples/full/SFRARR_fluvialhazardmaps/Sources.csv @@ -0,0 +1,2 @@ +Dataset identifier,https://datacatalog.worldbank.org/search/dataset/0064232 +Source identifier,0064232_1src diff --git a/examples/full/SFRARR_fluvialhazardmaps/Spatial coverage_Gazetteer entries.csv b/examples/full/SFRARR_fluvialhazardmaps/Spatial coverage_Gazetteer entries.csv new file mode 100644 index 00000000..956dd693 --- /dev/null +++ b/examples/full/SFRARR_fluvialhazardmaps/Spatial coverage_Gazetteer entries.csv @@ -0,0 +1,3 @@ +Dataset identifier,https://datacatalog.worldbank.org/search/dataset/0064232 +Gazetteer entry identifier,0064232_gaz1 +Scheme,ISO 3166-1 alpha-3 diff --git a/examples/full/SFRARR_fluvialhazardmaps/datasets.csv b/examples/full/SFRARR_fluvialhazardmaps/datasets.csv new file mode 100644 index 00000000..1553d3dc --- /dev/null +++ b/examples/full/SFRARR_fluvialhazardmaps/datasets.csv @@ -0,0 +1,22 @@ +Dataset identifier,https://datacatalog.worldbank.org/search/dataset/0064232 +Title,Central Asia flood hazard - fluvial flood hazard maps DEFENDED +Description,Simulated fluvial flood hazard maps with the simulated effects of flood protection. +Risk data type,hazard +"Publisher: +Name",World Bank Europe and Central Asia DRM team +"Publisher: +Email address",sfraser@worldbank.org +Dataset version,2 +Dataset purpose,Developed as part of a regional probabilistic flood and earthquake risk assessment under the Strengthening Financial Resilience and Accelerating Risk Reduction in Central Asia program. (https://www.gfdrr.org/en/program/SFRARR-Central-Asia) +Project title,Strengthening Financial Resilience and Accelerating Risk Reduction in Central Asia +"Spatial coverage: +Countries",KAZ;KGZ;TJK;TKM;UZB +"Spatial coverage: +Spatial scale",regional +License,CC-BY-4.0 +"Contact point: +Name",Stuart Fraser +"Contact point: +Email address",sfraser@worldbank.org +"Creator: +Name",Risk Engineering and Development diff --git a/examples/full/SFRARR_fluvialhazardmaps/example.json b/examples/full/SFRARR_fluvialhazardmaps/example.json new file mode 100644 index 00000000..7ad6d630 --- /dev/null +++ b/examples/full/SFRARR_fluvialhazardmaps/example.json @@ -0,0 +1,1118 @@ +{ + "datasets": [ + { + "id": "https://datacatalog.worldbank.org/search/dataset/0064232", + "title": "Central Asia flood hazard - fluvial flood hazard maps DEFENDED", + "description": "Simulated fluvial flood hazard maps with the simulated effects of flood protection. ", + "risk_data_type": [ + "hazard" + ], + "publisher": { + "name": "World Bank Europe and Central Asia DRM team", + "email": "sfraser@worldbank.org" + }, + "version": "2", + "purpose": "Developed as part of a regional probabilistic flood and earthquake risk assessment under the Strengthening Financial Resilience and Accelerating Risk Reduction in Central Asia program. (https://www.gfdrr.org/en/program/SFRARR-Central-Asia)", + "project": "Strengthening Financial Resilience and Accelerating Risk Reduction in Central Asia ", + "spatial": { + "countries": [ + "KAZ", + "KGZ", + "TJK", + "TKM", + "UZB" + ], + "scale": "regional", + "gazetteer_entries": [ + { + "id": "0064232_gaz1", + "scheme": "ISO 3166-1 alpha-3" + } + ] + }, + "license": "CC-BY-4.0", + "contact_point": { + "name": "Stuart Fraser", + "email": "sfraser@worldbank.org" + }, + "creator": { + "name": "Risk Engineering and Development" + }, + "attributions": [ + { + "id": "0064232_1attr", + "entity": { + "name": "World Bank", + "email": "chuang@worldbank.org", + "url": "http://www.worldbank.org" + }, + "role": "custodian" + } + ], + "sources": [ + { + "id": "0064232_1src" + } + ], + "referenced_by": [ + { + "id": "0064232_ref1", + "name": "Central Asia flood hazard technical report - English version", + "author_names": [ + "Risk Engineering and Development" + ], + "date_published": "2023-02-09", + "url": "https://datacatalogfiles.worldbank.org/ddh-published/0064084/DR0090774/Task3_FloodHazard_Report_r5_EN.pdf?versionId=2023-07-21T17:34:14.1038579Z" + } + ], + "resources": [ + { + "id": "0064232_res1", + "title": "Central Asia fluvial flood hazard maps - defended – KAZ 5-50y RP", + "description": "Fluvial flood hazard maps for Central Asia, derived from a regional model. Filenaming: FLU_DEF_XXy_ZZZ.tif (XX= return period, ZZZ= country initials). Cell value gives maximum flood depth (m) expected for the return period of that raster dataset. Due to file size, this is a partial set of data covering 1-in-5-50y return period. See dataset “Central Asia fluvial flood hazard maps - defended – KAZ 100-1000y RP” for the remaining data.", + "media_type": "image/tiff", + "format": "geotiff", + "spatial_resolution": 90, + "coordinate_system": "EPSG:4326", + "download_url": "https://datacatalogfiles.worldbank.org/ddh-published/0064232/DR0092000/FLU_DEF_KAZ_5-50yRP.zip?versionId=2023-07-11T15:17:06.8346489Z" + }, + { + "id": "0064232_res2", + "title": "Central Asia fluvial flood hazard maps - defended – KAZ 100-1000y RP", + "description": "Fluvial flood hazard maps for Central Asia, derived from a regional model. Filenaming: FLU_DEF_XXy_ZZZ.tif (XX= return period, ZZZ= country initials). Cell value gives maximum flood depth (m) expected for the return period of that raster dataset. Due to file size, this is a partial set of data covering 1-in-100-1000y return period. See dataset “Central Asia fluvial flood hazard maps - defended – KaZ 5-50y RP” for the remaining data.", + "media_type": "image/tiff", + "format": "geotiff", + "spatial_resolution": 90, + "coordinate_system": "EPSG:4326", + "download_url": "https://datacatalogfiles.worldbank.org/ddh-published/0064232/DR0092001/FLU_DEF_KAZ_100-1000yRP.zip?versionId=2023-07-11T15:17:09.5061377Z" + }, + { + "id": "0064232_res3", + "title": "Central Asia fluvial flood hazard maps - defended - KGZ", + "description": "Fluvial flood hazard maps for Central Asia, derived from a regional model. Filenaming: FLU_DEF_XXy_ZZZ.tif (XX= return period, ZZZ= country initials). Cell value gives maximum flood depth (m) expected for the return period of that raster dataset.", + "media_type": "image/tiff", + "format": "geotiff", + "spatial_resolution": 90, + "coordinate_system": "EPSG:4326", + "download_url": "https://datacatalogfiles.worldbank.org/ddh-published/0064232/DR0091440/FLU_DEF_KGZ.zip?versionId=2023-07-11T15:16:59.0750434Z" + }, + { + "id": "0064232_res4", + "title": "Central Asia fluvial flood hazard maps - defended - TJK", + "description": "Fluvial flood hazard maps for Central Asia, derived from a regional model. Filenaming: FLU_DEF_XXy_ZZZ.tif (XX= return period, ZZZ= country initials). Cell value gives maximum flood depth (m) expected for the return period of that raster dataset.", + "media_type": "image/tiff", + "format": "geotiff", + "spatial_resolution": 90, + "coordinate_system": "EPSG:4326", + "download_url": "https://datacatalogfiles.worldbank.org/ddh-published/0064232/DR0091439/FLU_DEF_TJK.zip?versionId=2023-07-11T15:17:11.4860175Z" + }, + { + "id": "0064232_res5", + "title": "Central Asia fluvial flood hazard maps - defended - TKM", + "description": "Fluvial flood hazard maps for Central Asia, derived from a regional model. Filenaming: FLU_DEF_XXy_ZZZ.tif (XX= return period, ZZZ= country initials). Cell value gives maximum flood depth (m) expected for the return period of that raster dataset.", + "media_type": "image/tiff", + "format": "geotiff", + "spatial_resolution": 90, + "coordinate_system": "EPSG:4326", + "download_url": "https://datacatalogfiles.worldbank.org/ddh-published/0064232/DR0091768/FLU_DEF_TKM.zip?versionId=2023-07-11T15:17:01.5896193Z" + }, + { + "id": "0064232_res6", + "title": "Central Asia fluvial flood hazard maps - defended - UZB", + "description": "Fluvial flood hazard maps for Central Asia, derived from a regional model. Filenaming: FLU_DEF_XXy_ZZZ.tif (XX= return period, ZZZ= country initials). Cell value gives maximum flood depth (m) expected for the return period of that raster dataset.", + "media_type": "image/tiff", + "format": "geotiff", + "spatial_resolution": 90, + "coordinate_system": "EPSG:4326", + "download_url": "https://datacatalogfiles.worldbank.org/ddh-published/0064232/DR0091769/FLU_DEF_UZB.zip?versionId=2023-07-11T15:17:04.1441727Z" + } + ], + "hazard": { + "event_sets": [ + { + "id": "0064232_EventSet1", + "analysis_type": "probabilistic", + "seasonality": "uniform", + "calculation_method": "simulated", + "event_count": 10000, + "spatial": { + "countries": [ + "KAZ", + "KGZ", + "TJK", + "TKM", + "UZB" + ], + "scale": "regional", + "gazetteer_entries": [ + { + "id": "KAZ", + "scheme": "ISO 3166-1 alpha-3", + "description": "Kazakhstan" + }, + { + "id": "KGZ", + "scheme": "ISO 3166-1 alpha-3", + "description": "Kyrgyz Republic" + }, + { + "id": "TJK", + "scheme": "ISO 3166-1 alpha-3", + "description": "Tajikistan" + }, + { + "id": "TKM", + "scheme": "ISO 3166-1 alpha-3", + "description": "Turkmenistan" + }, + { + "id": "UZB", + "scheme": "ISO 3166-1 alpha-3", + "description": "Uzbekistan" + } + ] + }, + "hazards": [ + { + "id": "0064232_EventSet1_FL", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + } + ], + "events": [ + { + "id": "0064232_EventSet1_KAZ_5", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_KAZ_5", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 5 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_KAZ_5", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_KAZ_10", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_KAZ_10", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 10 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_KAZ_10", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_KAZ_20", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_KAZ_20", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 20 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_KAZ_20", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_KAZ_50", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_KAZ_50", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 50 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_KAZ_50", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_KAZ_100", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_KAZ_100", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 100 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_KAZ_100", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_KAZ_200", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_KAZ_200", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 200 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_KAZ_200", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_KAZ_500", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_KAZ_500", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 500 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_KAZ_500", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_KAZ_1000", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_KAZ_1000", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 1000 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_KAZ_1000", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_KGZ_5", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_KGZ_5", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 5 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_KGZ_5", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_KGZ_10", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_KGZ_10", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 10 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_KGZ_10", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_KGZ_20", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_KGZ_20", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 20 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_KGZ_20", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_KGZ_50", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_KGZ_50", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 50 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_KGZ_50", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_KGZ_100", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_KGZ_100", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 100 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_KGZ_100", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_KGZ_200", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_KGZ_200", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 200 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_KGZ_200", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_KGZ_500", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_KGZ_500", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 500 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_KGZ_500", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_KGZ_1000", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_KGZ_1000", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 1000 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_KGZ_1000", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_TJK_5", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_TJK_5", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 5 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_TJK_5", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_TJK_10", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_TJK_10", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 10 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_TJK_10", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_TJK_20", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_TJK_20", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 20 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_TJK_20", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_TJK_50", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_TJK_50", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 50 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_TJK_50", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_TJK_100", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_TJK_100", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 100 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_TJK_100", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_TJK_200", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_TJK_200", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 200 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_TJK_200", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_TJK_500", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_TJK_500", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 500 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_TJK_500", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_TJK_1000", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_TJK_1000", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 1000 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_TJK_1000", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_TKM_5", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_TKM_5", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 5 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_TKM_5", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_TKM_10", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_TKM_10", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 10 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_TKM_10", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_TKM_20", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_TKM_20", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 20 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_TKM_20", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_TKM_50", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_TKM_50", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 50 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_TKM_50", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_TKM_100", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_TKM_100", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 100 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_TKM_100", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_TKM_200", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_TKM_200", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 200 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_TKM_200", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_TKM_500", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_TKM_500", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 500 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_TKM_500", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_TKM_1000", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_TKM_1000", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 1000 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_TKM_1000", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_UZB_5", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_UZB_5", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 5 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_UZB_5", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_UZB_10", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_UZB_10", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 10 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_UZB_10", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_UZB_20", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_UZB_20", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 20 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_UZB_20", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_UZB_50", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_UZB_50", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 50 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_UZB_50", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_UZB_100", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_UZB_100", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 100 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_UZB_100", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_UZB_200", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_UZB_200", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 200 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_UZB_200", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_UZB_500", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_UZB_500", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 500 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_UZB_500", + "intensity_measure": "fl_wd:m" + } + ] + }, + { + "id": "0064232_EventSet1_UZB_1000", + "calculation_method": "simulated", + "hazard": { + "id": "0064232_EventSet1_UZB_1000", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + "occurrence": { + "probabilistic": { + "return_period": 1000 + } + }, + "footprints": [ + { + "id": "0064232_EventSet1_UZB_1000", + "intensity_measure": "fl_wd:m" + } + ] + } + ] + } + ] + }, + "links": [ + { + "href": "https://raw.githubusercontent.com/GFDRR/rdl-standard/0__2__0/schema/rdls_schema.json", + "rel": "describedby" + } + ] + } + ] +} diff --git a/examples/hazard/aqueduct/Hazard metadata_Event sets.csv b/examples/hazard/aqueduct/Hazard metadata_Event sets.csv new file mode 100644 index 00000000..d4f65773 --- /dev/null +++ b/examples/hazard/aqueduct/Hazard metadata_Event sets.csv @@ -0,0 +1,8 @@ +Dataset identifier,https://www.wri.org/data/aqueduct-floods-hazard-maps +Event set identifier,1 +Analysis type,probabilistic +Calculation Method,simulated +Event count,10 +Occurrence range,1/2 to 1/1000 years +"Spatial coverage: +Spatial scale",global diff --git a/examples/hazard/aqueduct/Hazard metadata_Event sets_Hazards.csv b/examples/hazard/aqueduct/Hazard metadata_Event sets_Hazards.csv new file mode 100644 index 00000000..f0bf1995 --- /dev/null +++ b/examples/hazard/aqueduct/Hazard metadata_Event sets_Hazards.csv @@ -0,0 +1,6 @@ +Dataset identifier,https://www.wri.org/data/aqueduct-floods-hazard-maps,https://www.wri.org/data/aqueduct-floods-hazard-maps +Event set identifier,1,1 +Hazard identifier,1,2 +Hazard type,flood,flood +Hazard processes,fluvial_flood,coastal_flood +Intensity measure,fl_wd:m,fl_wd:m diff --git a/examples/hazard/aqueduct/Links.csv b/examples/hazard/aqueduct/Links.csv new file mode 100644 index 00000000..5310cc7e --- /dev/null +++ b/examples/hazard/aqueduct/Links.csv @@ -0,0 +1,3 @@ +Dataset identifier,https://www.wri.org/data/aqueduct-floods-hazard-maps +Link target,https://raw.githubusercontent.com/GFDRR/rdl-standard/0__2__0/schema/rdls_schema.json +Link relation type,describedby diff --git a/examples/hazard/aqueduct/Resources.csv b/examples/hazard/aqueduct/Resources.csv new file mode 100644 index 00000000..593a6bed --- /dev/null +++ b/examples/hazard/aqueduct/Resources.csv @@ -0,0 +1,8 @@ +Dataset identifier,https://www.wri.org/data/aqueduct-floods-hazard-maps +Resource identifier,1 +Resource title,Flood hazard maps +Resource description,Collection of fluvial and pluvial hazard maps; baseline and climate scenarios +Format,geotiff +Spatial resolution,1000 +Coordinate reference system,EPSG:4326 +Access Url,http://wri-projects.s3.amazonaws.com/AqueductFloodTool/download/v2/index.html diff --git a/examples/hazard/aqueduct/datasets.csv b/examples/hazard/aqueduct/datasets.csv new file mode 100644 index 00000000..b483bdef --- /dev/null +++ b/examples/hazard/aqueduct/datasets.csv @@ -0,0 +1,20 @@ +Dataset identifier,https://www.wri.org/data/aqueduct-floods-hazard-maps +Title,Aqueduct Floods Hazard Maps +Description,"Aqueduct Floods is an online platform that measures riverine and coastal flood risks under both current baseline conditions and future projections in 2030, 2050, an 2080. In addition to providing hazard maps and assessing risks, Aqueduct Floods enables its users to conduct comprehensive cost-benefit analysis to evaluate the value of dike flood protection strategies." +Risk data type,hazard +"Publisher: +Name",Water Resource Institute +"Publisher: +URL",https://www.wri.org +Dataset version,2020 +Project title,Aqueduct +Additional details,"The Aqueduct flood-hazard model is a global gridded dataset of flood hazard produced at the global scale. It provides flood water extent and depth for a range of pluvial and fluvial hazard scenarios, expressed as “return period”, which indicates the probability of occurrence (i.e. once in 2, 5, 10, 20, 50, 100, 250, 500 and 1000 years). The Data are at 1 km resolution and have a global coverage." +"Spatial coverage: +Spatial scale",global +"Contact point: +Name",Mattia Amadio +"Contact point: +Email address",mamadio@worldbank.org +"Creator: +Name",Water Resource Institute +License,CC-BY-4.0 diff --git a/examples/hazard/aqueduct/example.json b/examples/hazard/aqueduct/example.json new file mode 100644 index 00000000..30467081 --- /dev/null +++ b/examples/hazard/aqueduct/example.json @@ -0,0 +1,79 @@ +{ + "datasets": [ + { + "id": "https://www.wri.org/data/aqueduct-floods-hazard-maps", + "title": "Aqueduct Floods Hazard Maps", + "description": "Aqueduct Floods is an online platform that measures riverine and coastal flood risks under both current baseline conditions and future projections in 2030, 2050, an 2080. In addition to providing hazard maps and assessing risks, Aqueduct Floods enables its users to conduct comprehensive cost-benefit analysis to evaluate the value of dike flood protection strategies.", + "risk_data_type": [ + "hazard" + ], + "publisher": { + "name": "Water Resource Institute", + "url": "https://www.wri.org" + }, + "version": "2020", + "project": "Aqueduct", + "details": "The Aqueduct flood-hazard model is a global gridded dataset of flood hazard produced at the global scale. It provides flood water extent and depth for a range of pluvial and fluvial hazard scenarios, expressed as “return period”, which indicates the probability of occurrence (i.e. once in 2, 5, 10, 20, 50, 100, 250, 500 and 1000 years). The Data are at 1 km resolution and have a global coverage.", + "spatial": { + "scale": "global" + }, + "contact_point": { + "name": "Mattia Amadio", + "email": "mamadio@worldbank.org" + }, + "creator": { + "name": "Water Resource Institute" + }, + "license": "CC-BY-4.0", + "resources": [ + { + "id": "1", + "title": "Flood hazard maps ", + "description": "Collection of fluvial and pluvial hazard maps; baseline and climate scenarios", + "format": "geotiff", + "spatial_resolution": 1000, + "coordinate_system": "EPSG:4326", + "access_url": "http://wri-projects.s3.amazonaws.com/AqueductFloodTool/download/v2/index.html" + } + ], + "hazard": { + "event_sets": [ + { + "id": "1", + "analysis_type": "probabilistic", + "calculation_method": "simulated", + "event_count": 10, + "occurrence_range": "1/2 to 1/1000 years", + "spatial": { + "scale": "global" + }, + "hazards": [ + { + "id": "1", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + { + "id": "2", + "type": "flood", + "processes": [ + "coastal_flood" + ], + "intensity_measure": "fl_wd:m" + } + ] + } + ] + }, + "links": [ + { + "href": "https://raw.githubusercontent.com/GFDRR/rdl-standard/0__2__0/schema/rdls_schema.json", + "rel": "describedby" + } + ] + } + ] +} diff --git a/examples/hazard/aqueduct/figure.png b/examples/hazard/aqueduct/figure.png new file mode 100644 index 00000000..b02715fe Binary files /dev/null and b/examples/hazard/aqueduct/figure.png differ diff --git a/examples/hazard/fathom/Hazard metadata_Event sets.csv b/examples/hazard/fathom/Hazard metadata_Event sets.csv new file mode 100644 index 00000000..b885f4e0 --- /dev/null +++ b/examples/hazard/fathom/Hazard metadata_Event sets.csv @@ -0,0 +1,8 @@ +Dataset identifier,FTH_example +Event set identifier,1 +Analysis type,probabilistic +Calculation Method,simulated +Event count,10 +Occurrence range,1/10 to 1/1000 years +"Spatial coverage: +Spatial scale",global diff --git a/examples/hazard/fathom/Hazard metadata_Event sets_Hazards.csv b/examples/hazard/fathom/Hazard metadata_Event sets_Hazards.csv new file mode 100644 index 00000000..1869b6c2 --- /dev/null +++ b/examples/hazard/fathom/Hazard metadata_Event sets_Hazards.csv @@ -0,0 +1,6 @@ +Dataset identifier,FTH_example,FTH_example +Event set identifier,1,1 +Hazard identifier,1,2 +Hazard type,flood,flood +Hazard processes,fluvial_flood,pluvial_flood +Intensity measure,fl_wd:m,fl_wd:m diff --git a/examples/hazard/fathom/Links.csv b/examples/hazard/fathom/Links.csv new file mode 100644 index 00000000..fcfe7cef --- /dev/null +++ b/examples/hazard/fathom/Links.csv @@ -0,0 +1,3 @@ +Dataset identifier,FTH_example +Link target,https://raw.githubusercontent.com/GFDRR/rdl-standard/0__2__0/schema/rdls_schema.json +Link relation type,describedby diff --git a/examples/hazard/fathom/Resources.csv b/examples/hazard/fathom/Resources.csv new file mode 100644 index 00000000..6120938a --- /dev/null +++ b/examples/hazard/fathom/Resources.csv @@ -0,0 +1,8 @@ +Dataset identifier,FTH_example,FTH_example,FTH_example +Resource identifier,1,2,3 +Resource title,Fluvial hazard - Undefended,Fluvial hazard - Defended,Pluvial hazard - Undefended +Resource description,"Fluvial flood hazard maps (10), not accounting any flood defence","Fluvial flood hazard maps (10), accounting for flood defence (estimate)","Pluvial flood hazard maps (10), not accounting any flood defence" +Format,geotiff,geotiff,geotiff +Spatial resolution,90,90,90 +Coordinate reference system,EPSG:4326,EPSG:4326,EPSG:4326 +Download Url,http://example.com/FTH-THA-fluvial-undefended,http://example.com/FTH-THA-fluvial-defended,http://example.com/FTH-THA-pluvial-undefended diff --git a/examples/hazard/fathom/datasets.csv b/examples/hazard/fathom/datasets.csv new file mode 100644 index 00000000..d518544c --- /dev/null +++ b/examples/hazard/fathom/datasets.csv @@ -0,0 +1,24 @@ +Dataset identifier,FTH_example +Title,FATHOM flood hazard maps +Description,Probabilistic modelling of fluvial and pluvial flood hazard +Risk data type,hazard +"Publisher: +Name",Fathom +"Publisher: +URL",https://www.fathom.global/ +Dataset version,2 +Additional details,"The FATHOM flood-hazard model (previously known as SSBN), is a global gridded dataset of flood hazard produced at the global scale. It provides flood water extent and depth for a range of pluvial and fluvial hazard scenarios, expressed as “return period”, which indicates the probability of occurrence (i.e. once in 5, 10, 20, 50, 75, 100, 200, 250, 500, 750 and 1000 years). The Data are at 3 arc second (approximately 90m) resolution and have a global coverage between 56°S and 60°N. Each country set includes three subsets: +- Fluvial Undefended (FU): no flood defence accounted +- Fluvial Defended (FD): flood defence estimated by protection standards proxied by GDP (FloProS) +- Pluvial Undefended (PU): pluvial cumulation hazard maps, no flood defence accounted" +"Spatial coverage: +Spatial scale",national +License,commercial +"Contact point: +Name",Mattia Amadio +"Contact point: +Email address",mamadio@worldbank.org +"Creator: +Name",Mattia Amadio +"Creator: +Email address",mamadio@worldbank.org diff --git a/examples/hazard/fathom/example.json b/examples/hazard/fathom/example.json new file mode 100644 index 00000000..150650fe --- /dev/null +++ b/examples/hazard/fathom/example.json @@ -0,0 +1,97 @@ +{ + "datasets": [ + { + "id": "FTH_example", + "title": "FATHOM flood hazard maps", + "description": "Probabilistic modelling of fluvial and pluvial flood hazard", + "risk_data_type": [ + "hazard" + ], + "publisher": { + "name": "Fathom", + "url": "https://www.fathom.global/" + }, + "version": "2", + "details": "The FATHOM flood-hazard model (previously known as SSBN), is a global gridded dataset of flood hazard produced at the global scale. It provides flood water extent and depth for a range of pluvial and fluvial hazard scenarios, expressed as “return period”, which indicates the probability of occurrence (i.e. once in 5, 10, 20, 50, 75, 100, 200, 250, 500, 750 and 1000 years). The Data are at 3 arc second (approximately 90m) resolution and have a global coverage between 56°S and 60°N. Each country set includes three subsets:\n- Fluvial Undefended (FU): no flood defence accounted\n- Fluvial Defended (FD): flood defence estimated by protection standards proxied by GDP (FloProS)\n- Pluvial Undefended (PU): pluvial cumulation hazard maps, no flood defence accounted", + "spatial": { + "scale": "national" + }, + "license": "commercial", + "contact_point": { + "name": "Mattia Amadio", + "email": "mamadio@worldbank.org" + }, + "creator": { + "name": "Mattia Amadio", + "email": "mamadio@worldbank.org" + }, + "resources": [ + { + "id": "1", + "title": "Fluvial hazard - Undefended", + "description": "Fluvial flood hazard maps (10), not accounting any flood defence", + "format": "geotiff", + "spatial_resolution": 90, + "coordinate_system": "EPSG:4326", + "download_url": "http://example.com/FTH-THA-fluvial-undefended" + }, + { + "id": "2", + "title": "Fluvial hazard - Defended", + "description": "Fluvial flood hazard maps (10), accounting for flood defence (estimate)", + "format": "geotiff", + "spatial_resolution": 90, + "coordinate_system": "EPSG:4326", + "download_url": "http://example.com/FTH-THA-fluvial-defended" + }, + { + "id": "3", + "title": "Pluvial hazard - Undefended", + "description": "Pluvial flood hazard maps (10), not accounting any flood defence", + "format": "geotiff", + "spatial_resolution": 90, + "coordinate_system": "EPSG:4326", + "download_url": "http://example.com/FTH-THA-pluvial-undefended" + } + ], + "hazard": { + "event_sets": [ + { + "id": "1", + "analysis_type": "probabilistic", + "calculation_method": "simulated", + "event_count": 10, + "occurrence_range": "1/10 to 1/1000 years", + "spatial": { + "scale": "global" + }, + "hazards": [ + { + "id": "1", + "type": "flood", + "processes": [ + "fluvial_flood" + ], + "intensity_measure": "fl_wd:m" + }, + { + "id": "2", + "type": "flood", + "processes": [ + "pluvial_flood" + ], + "intensity_measure": "fl_wd:m" + } + ] + } + ] + }, + "links": [ + { + "href": "https://raw.githubusercontent.com/GFDRR/rdl-standard/0__2__0/schema/rdls_schema.json", + "rel": "describedby" + } + ] + } + ] +} diff --git a/examples/hazard/fathom/figure.png b/examples/hazard/fathom/figure.png new file mode 100644 index 00000000..b7ad990e Binary files /dev/null and b/examples/hazard/fathom/figure.png differ diff --git a/examples/vulnerability/flood_jrc/Attributions.csv b/examples/vulnerability/flood_jrc/Attributions.csv new file mode 100644 index 00000000..40f415ae --- /dev/null +++ b/examples/vulnerability/flood_jrc/Attributions.csv @@ -0,0 +1,7 @@ +Dataset identifier,https://publications.jrc.ec.europa.eu/repository/handle/JRC105688,https://publications.jrc.ec.europa.eu/repository/handle/JRC105688 +Attribution identifier,1,2 +"Entity: +Name",JRC,Jan Huizinga +"Entity: +URL",https://publications.jrc.ec.europa.eu/repository/handle/JRC105688, +Role,distributor,author diff --git a/examples/vulnerability/flood_jrc/Links.csv b/examples/vulnerability/flood_jrc/Links.csv new file mode 100644 index 00000000..bcb44a2c --- /dev/null +++ b/examples/vulnerability/flood_jrc/Links.csv @@ -0,0 +1,3 @@ +Dataset identifier,https://publications.jrc.ec.europa.eu/repository/handle/JRC105688 +Link target,https://raw.githubusercontent.com/GFDRR/rdl-standard/0__2__0/schema/rdls_schema.json +Link relation type,describedby diff --git a/examples/vulnerability/flood_jrc/Referenced by.csv b/examples/vulnerability/flood_jrc/Referenced by.csv new file mode 100644 index 00000000..5717c537 --- /dev/null +++ b/examples/vulnerability/flood_jrc/Referenced by.csv @@ -0,0 +1,7 @@ +Dataset identifier,https://publications.jrc.ec.europa.eu/repository/handle/JRC105688 +Related resource identifier,1 +Name,JRC Technical report - Global flood depth-damage functions +Author names,Jan Huizinga;Hans de Moel;Wojciech Szewczyk +Publication date,2017-04-12 +URL,https://publications.jrc.ec.europa.eu/repository/bitstream/JRC105688/global_flood_depth-damage_functions__10042017.pdf +Digital object identifier,10.2760/16510 diff --git a/examples/vulnerability/flood_jrc/Resources.csv b/examples/vulnerability/flood_jrc/Resources.csv new file mode 100644 index 00000000..26d694d9 --- /dev/null +++ b/examples/vulnerability/flood_jrc/Resources.csv @@ -0,0 +1,6 @@ +Dataset identifier,https://publications.jrc.ec.europa.eu/repository/handle/JRC105688 +Resource identifier,1 +Resource title,Global flood depth-damage functions database +Resource description,"This spreadsheet contains two components required for flood damage assessment: fractional depth-damage functions and maximum damage values. The damage functions provide the share of asset that is damaged at a given flood depth, while the maximum damage values provide the associated maximum damage value for the given asset and, when combined together, they yield the monetary value of the damage." +Format,xlsx +Download Url,https://publications.jrc.ec.europa.eu/repository/bitstream/JRC105688/copy_of_global_flood_depth-damage_functions__30102017.xlsx diff --git a/examples/vulnerability/flood_jrc/Vulnerability metadata_Asset cost.csv b/examples/vulnerability/flood_jrc/Vulnerability metadata_Asset cost.csv new file mode 100644 index 00000000..f36311ed --- /dev/null +++ b/examples/vulnerability/flood_jrc/Vulnerability metadata_Asset cost.csv @@ -0,0 +1,4 @@ +Dataset identifier,https://publications.jrc.ec.europa.eu/repository/handle/JRC105688,https://publications.jrc.ec.europa.eu/repository/handle/JRC105688 +Cost identifier,1,2 +Cost dimension,structure,content +Cost unit,EUR,EUR diff --git a/examples/vulnerability/flood_jrc/datasets.csv b/examples/vulnerability/flood_jrc/datasets.csv new file mode 100644 index 00000000..e64df8a5 --- /dev/null +++ b/examples/vulnerability/flood_jrc/datasets.csv @@ -0,0 +1,47 @@ +Dataset identifier,https://publications.jrc.ec.europa.eu/repository/handle/JRC105688 +Title,Global flood depth-damage functions +Description,This dataset contains damage curves depicting fractional damage function of water depth as well as maximum damage values for a variety of assets and land use classes. +Risk data type,vulnerability +"Publisher: +Name",EU Joint Research Center (JRC) +"Publisher: +URL",https://publications.jrc.ec.europa.eu/repository/handle/JRC105688 +Dataset version,2017 +Dataset purpose,"Assessing potential damage of flood events is an important component in flood risk management. Determining direct flood damage is commonly done using depth-damage curves, which denote the flood damage that would occur at specific water depths per asset or per land-use class. Many countries have developed flood damage models using depth-damage curves based on analysis of past flood events and on expert judgement. However, the fact that such damage curves are not available for all regions hampers damage assessments in some areas. Moreover, due to different methodologies employed for various damage models in different countries, damage assessments cannot be directly compared with each other, obstructing also supra-national flood damage assessments." +Additional details,"Based on an extensive literature survey concave damage curves have been developed for each continent, while differentiation in flood damage between countries is established by determining maximum damage values at the country scale. These maximum damage values are based on construction cost surveys from multinational construction companies, which provide a coherent set of detailed building cost data across dozens of countries. A consistent set of maximum flood damage values for all countries was computed using statistical regressions with socio-economic World Development Indicators. Further, based on insights from the literature survey, guidance is also given on how the damage curves and maximum damage values can be adjusted for specific local circumstances, such as urban vs. rural locations or use of specific building material. This dataset can be used for consistent supra-national scale flood damage assessments, and guide assessment in countries where no damage model is currently available." +"Spatial coverage: +Spatial scale",global +License,CC-BY-4.0 +"Contact point: +Name",Mattia Amadio +"Contact point: +Email address",mamadio@worldbank.org +"Creator: +Name",EU Joint Research Center (JRC) +"Vulnerability metadata: +Primary hazard type",flood +"Vulnerability metadata: +Hazard intensity measurement",fl_wd:m +"Vulnerability metadata: +Exposure category",buildings +"Vulnerability metadata: +Exposure taxonomy scheme",internal +"Vulnerability metadata: +Vulnerability impact: +Impact type",direct +"Vulnerability metadata: +Vulnerability impact: +Impact metric",damage_ratio +"Vulnerability metadata: +Vulnerability impact: +Impact unit",percentage +"Vulnerability metadata: +Vulnerability impact: +Impact base data type",inferred +"Vulnerability metadata: +Spatial coverage: +Spatial scale",global +"Vulnerability metadata: +Impact functions: +Fragility function: +Fragility function approach",hybrid diff --git a/examples/vulnerability/flood_jrc/example.json b/examples/vulnerability/flood_jrc/example.json new file mode 100644 index 00000000..3c7ec320 --- /dev/null +++ b/examples/vulnerability/flood_jrc/example.json @@ -0,0 +1,108 @@ +{ + "datasets": [ + { + "id": "https://publications.jrc.ec.europa.eu/repository/handle/JRC105688", + "title": "Global flood depth-damage functions", + "description": "This dataset contains damage curves depicting fractional damage function of water depth as well as maximum damage values for a variety of assets and land use classes.", + "risk_data_type": [ + "vulnerability" + ], + "publisher": { + "name": "EU Joint Research Center (JRC)", + "url": "https://publications.jrc.ec.europa.eu/repository/handle/JRC105688" + }, + "version": "2017", + "purpose": "Assessing potential damage of flood events is an important component in flood risk management. Determining direct flood damage is commonly done using depth-damage curves, which denote the flood damage that would occur at specific water depths per asset or per land-use class. Many countries have developed flood damage models using depth-damage curves based on analysis of past flood events and on expert judgement. However, the fact that such damage curves are not available for all regions hampers damage assessments in some areas. Moreover, due to different methodologies employed for various damage models in different countries, damage assessments cannot be directly compared with each other, obstructing also supra-national flood damage assessments.", + "details": "Based on an extensive literature survey concave damage curves have been developed for each continent, while differentiation in flood damage between countries is established by determining maximum damage values at the country scale. These maximum damage values are based on construction cost surveys from multinational construction companies, which provide a coherent set of detailed building cost data across dozens of countries. A consistent set of maximum flood damage values for all countries was computed using statistical regressions with socio-economic World Development Indicators. Further, based on insights from the literature survey, guidance is also given on how the damage curves and maximum damage values can be adjusted for specific local circumstances, such as urban vs. rural locations or use of specific building material. This dataset can be used for consistent supra-national scale flood damage assessments, and guide assessment in countries where no damage model is currently available.", + "spatial": { + "scale": "global" + }, + "license": "CC-BY-4.0", + "contact_point": { + "name": "Mattia Amadio", + "email": "mamadio@worldbank.org" + }, + "creator": { + "name": "EU Joint Research Center (JRC)" + }, + "vulnerability": { + "hazard_primary": "flood", + "intensity": "fl_wd:m", + "category": "buildings", + "taxonomy": "internal", + "impact": { + "type": "direct", + "metric": "damage_ratio", + "unit": "percentage", + "base_data_type": "inferred" + }, + "spatial": { + "scale": "global" + }, + "functions": { + "fragility": { + "approach": "hybrid" + } + }, + "cost": [ + { + "id": "1", + "dimension": "structure", + "unit": "EUR" + }, + { + "id": "2", + "dimension": "content", + "unit": "EUR" + } + ] + }, + "attributions": [ + { + "id": "1", + "entity": { + "name": "JRC", + "url": "https://publications.jrc.ec.europa.eu/repository/handle/JRC105688" + }, + "role": "distributor" + }, + { + "id": "2", + "entity": { + "name": "Jan Huizinga" + }, + "role": "author" + } + ], + "referenced_by": [ + { + "id": "1", + "name": "JRC Technical report - Global flood depth-damage functions", + "author_names": [ + "Jan Huizinga", + "Hans de Moel", + "Wojciech Szewczyk" + ], + "date_published": "2017-04-12", + "url": "https://publications.jrc.ec.europa.eu/repository/bitstream/JRC105688/global_flood_depth-damage_functions__10042017.pdf", + "doi": "10.2760/16510" + } + ], + "resources": [ + { + "id": "1", + "title": "Global flood depth-damage functions database", + "description": "This spreadsheet contains two components required for flood damage assessment: fractional depth-damage functions and maximum damage values. The damage functions provide the share of asset that is damaged at a given flood depth, while the maximum damage values provide the associated maximum damage value for the given asset and, when combined together, they yield the monetary value of the damage.", + "format": "xlsx", + "download_url": "https://publications.jrc.ec.europa.eu/repository/bitstream/JRC105688/copy_of_global_flood_depth-damage_functions__30102017.xlsx" + } + ], + "links": [ + { + "href": "https://raw.githubusercontent.com/GFDRR/rdl-standard/0__2__0/schema/rdls_schema.json", + "rel": "describedby" + } + ] + } + ] +} diff --git a/examples/vulnerability/flood_jrc/figure.png b/examples/vulnerability/flood_jrc/figure.png new file mode 100644 index 00000000..1a3b1a8b Binary files /dev/null and b/examples/vulnerability/flood_jrc/figure.png differ diff --git a/flatten-tool b/flatten-tool new file mode 160000 index 00000000..6a8e94d9 --- /dev/null +++ b/flatten-tool @@ -0,0 +1 @@ +Subproject commit 6a8e94d955fcab5c2ef818ac2b034503c2807579 diff --git a/manage.py b/manage.py index 7e88b230..563ee7d7 100755 --- a/manage.py +++ b/manage.py @@ -18,6 +18,7 @@ referencedir = basedir / 'docs' / 'reference' schemadir = basedir / 'schema' codelistdir = schemadir / 'codelists' +exampledir = basedir / 'examples' def read_lines(filename): @@ -154,13 +155,18 @@ def generate_codelist_markdown(codelist, type, references, definitions, defs_pat markdown.append(f"- [`{'/'.join(ref)}`]({url})\n") + newline = "\n" + markdown.extend([ "\nThis codelist has the following codes:\n\n" + "````{dropdown} Codes\n", + f"{f':open:{newline}' if len(read_lines(f'{codelistdir}/{type}/{codelist}.csv')) < 10 else ''}", "```{csv-table-no-translate}\n", ":header-rows: 1\n", ":widths: auto\n", f":file: ../../schema/codelists/{type}/{codelist}.csv\n", - "```\n\n" + "```\n", + "````\n\n" ]) return markdown @@ -379,12 +385,40 @@ def cli(): @cli.command() def pre_commit(): - """Update reference documentation and format Markdown files + """Update example CSV files, update reference documentation and format Markdown files. """ # Load schema schema = json_load('rdls_schema.json') + # Remove example CSV files + for path in glob.glob(f"{exampledir}/*/*/*.csv"): + os.remove(path) + + # Generate example CSV files + for example_path in glob.glob(f"{exampledir}/*/*/example.json"): + + command = f"flatten-tool flatten -s schema/rdls_schema.json -f csv --root-list-path datasets -m datasets -o {'/'.join(example_path.split('/')[:-1])} --truncation-length 50 --use-titles --remove-empty-schema-columns --line-terminator LF {example_path}" + + subprocess.run(command.split(" ")) + + for path in glob.glob(f"{exampledir}/*/*/*.csv"): + with open(path, 'r') as f: + # Transpose example CSV files for column-wise presentation + rows = zip(*csv.reader(f)) + + with open(path, 'w') as f: + writer = csv.writer(f, lineterminator="\n") + + # Omit titles of parent objects + parent_titles = path.split("/")[-1].split(".csv")[0].split("_") + for row in rows: + row_title = row[0] + for i in range(0, len(parent_titles)): + row_title = row_title.replace(f"{':'.join(parent_titles[0:len(parent_titles)-i])}:", "") + + writer.writerow([row_title.replace(":", ":\n")] + list(row[1:])) + # Update schema.md update_schema_docs(schema) diff --git a/pull_request_template.md b/pull_request_template.md index ace70a58..88d5eabb 100644 --- a/pull_request_template.md +++ b/pull_request_template.md @@ -10,12 +10,16 @@ -- [ ] Update the changelog ([style guide](developer_docs.md#changelog-style-guide)) -- [ ] Run `./manage.py` pre-commit - -If you added or removed a field: +If you added, removed or renamed a field: - [ ] Update the `collapse` option of the jsonschema directives for dataset, resource, hazard, exposure, vulnerability and loss on `reference/schema.md` +- [ ] Update the diagrams in `reference/schema/md` +- [ ] Update the JSON files in `examples` + +Always: + +- [ ] Run `./manage.py` pre-commit +- [ ] Update the changelog ([style guide](developer_docs.md#changelog-style-guide)) **Having trouble?** diff --git a/requirements.in b/requirements.in index 805bd237..7c58114a 100644 --- a/requirements.in +++ b/requirements.in @@ -5,6 +5,7 @@ sphinx-togglebutton sphinxcontrib-mermaid sphinxcontrib-opendataservices sphinxcontrib-opendataservices-jsonschema +sphinxcontrib-plantuml sphinx-intl #transifex-client sphinx_rtd_theme diff --git a/requirements.txt b/requirements.txt index 65cc158c..617850d0 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,7 +2,7 @@ # This file is autogenerated by pip-compile with Python 3.11 # by the following command: # -# pip-compile +# pip-compile requirements.in # alabaster==0.7.12 # via sphinx @@ -160,6 +160,7 @@ sphinx==5.3.0 # sphinx-rtd-theme # sphinx-togglebutton # sphinxcontrib-opendataservices + # sphinxcontrib-plantuml sphinx-autobuild==2021.3.14 # via -r requirements.in sphinx-design==0.3.0 @@ -186,6 +187,8 @@ sphinxcontrib-opendataservices-jsonschema==0.5.1 # via # -r requirements.in # sphinxcontrib-opendataservices +sphinxcontrib-plantuml==0.25 + # via -r requirements.in sphinxcontrib-qthelp==1.0.3 # via sphinx sphinxcontrib-serializinghtml==1.1.5 diff --git a/schema/codelists/closed/cost_type.csv b/schema/codelists/closed/cost_type.csv deleted file mode 100644 index 4f5b10db..00000000 --- a/schema/codelists/closed/cost_type.csv +++ /dev/null @@ -1,5 +0,0 @@ -Code,Title,Definition -structure,Structure,Costs associated with the repair or replacement (reconstruction) of a physical structure such as a building or piece of infrastructure that sustain damage. -content,Content,Costs associated with the repair or replacement of the physical contents of a structure that sustain damage. -product,Product,"Costs associated with the loss of products produced by businesses, which may or may not be physical items." -disruption,Disruption (Business Interruption),Costs associated with disruption to the planned operations or service provision of a business or infrastructure. diff --git a/schema/codelists/closed/metric_dimension.csv b/schema/codelists/closed/metric_dimension.csv new file mode 100644 index 00000000..6ea98ca5 --- /dev/null +++ b/schema/codelists/closed/metric_dimension.csv @@ -0,0 +1,6 @@ +Code,Title,Definition +structure,Structure,Physical structure such as a building or piece of infrastructure. +content,Content,Physical contents of a structure. +product,Product,"Products produced by businesses, which may or may not be physical items." +disruption,Disruption (Business Interruption),Planned operations or service provision of a business or infrastructure. +population,Population,"Injuries, fatalities, and displacements of a population." diff --git a/schema/codelists/closed/process_type.csv b/schema/codelists/closed/process_type.csv index f30a0b19..80c31a2f 100644 --- a/schema/codelists/closed/process_type.csv +++ b/schema/codelists/closed/process_type.csv @@ -7,7 +7,7 @@ hydrological_drought,Hydrological Drought,Occurs when low water supply becomes e meteorological_drought,Meteorological Drought,Occurs when dry weather patterns dominate an area. It is defined usually on the basis of the degree of dryness and the duration of the dry period. socioeconomic_drought,Socio-economic Drought,"Relates the supply and demand of some economic goods with elements of meteorological, hydrological, and agricultural drought. It also occurs when the demand for an economic good exceeds supply as a result of a weather-related shortfall in water supply." primary_rupture,Primary Rupture,"Earthquake surface ruptures and fissures are localised ground displacements that develop during and immediately after an earthquake. Surface ruptures represent the upward continuation of fault slip at depth, while fissures are smaller displacements, or more distributed deformation in and around the rupture area." -secondary_rupture,Secondary Rupture,TBA +secondary_rupture,Secondary Rupture,"Earthquake ruptures occur due to stress transfer from a primary rupture, causing concurrent or subsequent rupture of intersecting faults in the same fault set." ground_motion,Ground Motion,Earthquake ground shaking is the movement of the Earth's surface produced by seismic waves that are generated when an earthquake occurs. liquefaction,Liquefaction,"Soil liquefaction occurs when soil is transformed from a solid to a liquid state as a result of increased pore pressure and reduced effective stress. It is typically caused by rapid loading of the soil during earthquake shaking (AGI, 2017)." extreme_cold,Extreme cold,"A period of marked and unusual cold weather characterised by a sharp and significant drop in air temperatures near the surface (maximum, minimum and daily average) over a large area and persisting below certain thresholds for at least two consecutive days during the cold season (WMO, 2020)." diff --git a/schema/codelists/open/classification_scheme.csv b/schema/codelists/open/classification_scheme.csv index 61f714ff..a2a46d18 100644 --- a/schema/codelists/open/classification_scheme.csv +++ b/schema/codelists/open/classification_scheme.csv @@ -1,3 +1,6 @@ Code,Title,Definition,Source,Category GED4ALL-socio-economic,GED4ALL socio-economic taxonomy,The socio-economic taxonomy defined in the Global Exposure Database for Multi-Hazard Risk Analysis (GED4ALL).,https://wiki.openstreetmap.org/wiki/GED4ALL#Socio-Economic,Socio-economic index -MOVER_social_vulnerability_categories,MOVER social vulnerability categories,The social vulnerability categories defined in the Multi-Hazard Open Vulnerability Platform for Evaluating Risk (MOVER).,https://www.gfdrr.org/en/publication/mover,Socio-economic index +MOVER-social-vulnerability-categories,MOVER social vulnerability categories,The social vulnerability categories defined in the Multi-Hazard Open Vulnerability Platform for Evaluating Risk (MOVER).,https://www.gfdrr.org/en/publication/mover,Socio-economic index +GLIDE,Global Identifier Numbers,Identification codes generated by GLIDE since 2004 for all new disaster events reported by the Asian Disaster Reduction Center and GLIDE partner organizations.,https://www.glidenumber.net/glide/public/search/search.jsp,Distaster identifier +EMDAT,EM-DAT International Disaster Database,"EM-DAT contains data on the occurrence and impacts of over 26,000 mass disasters worldwide from 1900 to the present day. The database is compiled from various sources, including UN agencies, non-governmental organizations, reinsurance companies, research institutes, and press agencies. The Centre for Research on the Epidemiology of Disasters (CRED) distributes the data in open access for non-commercial use.",https://www.emdat.be/,Disaster identifier +USGS_EHP,USGS Earthquake Hazards Program,"The USGS monitors and reports on earthquakes globally, assigning each reported event a unique identifier. These event identifiers are used in the associated USGS products including PAGER, ShakeMap and DYFI.",https://earthquake.usgs.gov/earthquakes/search/,Disaster identifier diff --git a/schema/codelists/open/quantity_kind.csv b/schema/codelists/open/quantity_kind.csv new file mode 100644 index 00000000..deb5f265 --- /dev/null +++ b/schema/codelists/open/quantity_kind.csv @@ -0,0 +1,5 @@ +Code,Title,Definition +area,Area,The two-dimensional size of the part of a surface. +count,Count,A count of items. +currency,Currency,A financial value. +length,Length,A measure of distance. diff --git a/schema/rdls_package_schema.json b/schema/rdls_package_schema.json index 781ff28a..baaf116f 100644 --- a/schema/rdls_package_schema.json +++ b/schema/rdls_package_schema.json @@ -8,7 +8,7 @@ "datasets" ], "properties": { - "networks": { + "datasets": { "title": "Datasets", "description": "RDLS metadata describing one or more datasets.", "type": "array", diff --git a/schema/rdls_schema.json b/schema/rdls_schema.json index 792939c4..e3bc3681 100644 --- a/schema/rdls_schema.json +++ b/schema/rdls_schema.json @@ -2,7 +2,7 @@ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/GFDRR/rdl-standard/0__2__0/schema/rdls_schema.json", "title": "Risk dataset (Risk Data Library Schema)", - "description": "A risk dataset described using metadata structured according to the [Risk Data Library Standard](https://docs.riskdatalibrary.org/).", + "description": "A collection of risk data, published or curated by a single entity, consisting of one or more resources and described using metadata structured according to the [Risk Data Library Standard](https://docs.riskdatalibrary.org/).", "type": "object", "required": [ "id", @@ -17,7 +17,7 @@ ], "properties": { "id": { - "title": "Identifier", + "title": "Dataset identifier", "type": "string", "description": "A unique identifier for the dataset. Consult the [dataset identifier guidance](https://rdl-standard.readthedocs.io/en/dev/guides/metadata/#how-to-publish-rdls-metadata) for details on assigning a unique dataset id.", "minLength": 1 @@ -36,16 +36,21 @@ }, "risk_data_type": { "title": "Risk data type", - "type": "string", - "description": "The type of risk data included in the dataset, from the closed [risk data type codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#risk-data-type).", + "type": "array", + "description": "The types of risk data included in the dataset, from the closed [risk_data_type codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#risk-data-type).", + "items": { + "type": "string", + "enum": [ + "hazard", + "exposure", + "vulnerability", + "loss" + ] + }, "codelist": "risk_data_type.csv", "openCodelist": false, - "enum": [ - "hazard", - "exposure", - "vulnerability", - "loss" - ] + "minItems": 1, + "uniqueItems": true }, "publisher": { "title": "Publisher", @@ -76,21 +81,17 @@ "description": "Additional details about the dataset.", "minLength": 1 }, - "referenced_by": { - "title": "Referenced by", - "type": "array", - "description": "Related resources, such as publications, that reference, cite, or otherwise point to the dataset.", - "items": { - "$ref": "#/$defs/Related_resource" - }, - "minItems": 1, - "uniqueItems": true - }, "spatial": { "title": "Spatial coverage", - "description": "The geographical area covered by the dataset.", + "description": "The geographical area covered by the dataset. If specified using coordinates, the use of `.bbox` is recommended over `.geometry` or `.centroid`.", "$ref": "#/$defs/Location" }, + "temporal_resolution": { + "title": "Temporal resolution", + "type": "string", + "description": "The minimum period of time resolvable in this dataset, in ISO8601 duration format.", + "format": "duration" + }, "license": { "title": "License", "type": "string", @@ -121,6 +122,26 @@ "minItems": 1, "uniqueItems": true }, + "sources": { + "title": "Sources", + "type": "array", + "description": "Sources of information that contribute to the creation of the dataset.", + "items": { + "$ref": "#/$defs/Source" + }, + "minItems": 1, + "uniqueItems": true + }, + "referenced_by": { + "title": "Referenced by", + "type": "array", + "description": "Related resources, such as publications, that reference, cite, or otherwise point to the dataset.", + "items": { + "$ref": "#/$defs/Related_resource" + }, + "minItems": 1, + "uniqueItems": true + }, "resources": { "title": "Resources", "type": "array", @@ -132,7 +153,7 @@ "uniqueItems": true }, "hazard": { - "title": "Hazard dataset metadata", + "title": "Hazard metadata", "type": "object", "description": "Metadata that is specific to datasets that describe processes or phenomena that may cause loss of life, injury or other health impacts, property damage, social and economic disruption or environmental degradation.", "required": [ @@ -153,17 +174,17 @@ "minProperties": 1 }, "exposure": { - "title": "Exposure dataset metadata", + "title": "Exposure metadata", "type": "object", "description": "Metadata that is specific to datasets that describe the situation of people, infrastructure, housing, production capacities and other tangible human assets located in hazard-prone areas.", "required": [ "category", - "cost" + "metrics" ], "properties": { "category": { "title": "Exposure category", - "description": "The category of the exposed assets, from the closed [exposure category codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#exposure_category).", + "description": "The category of the exposed assets, from the closed [exposure_category codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#exposure-category).", "type": "string", "codelist": "exposure_category.csv", "openCodelist": false, @@ -181,12 +202,12 @@ "description": "The name of the taxonomy scheme used to create descriptive individual asset feature strings within the dataset.", "minLength": 1 }, - "cost": { - "title": "Asset cost", + "metrics": { + "title": "Exposure metrics", "type": "array", - "description": "The exposure costs associated with specific elements of assets detailed in the dataset.", + "description": "The measurements used to quantify the extent to which assets are exposed.", "items": { - "$ref": "#/$defs/Cost" + "$ref": "#/$defs/Metric" }, "minItems": 1, "uniqueItems": true @@ -195,7 +216,7 @@ "minProperties": 1 }, "vulnerability": { - "title": "Vulnerability dataset metadata", + "title": "Vulnerability metadata", "type": "object", "description": "Metadata that is specific to datasets that describe the physical fragility and vulnerability relationships in relation to specific hazards or combinations of individual hazards.", "required": [ @@ -203,7 +224,6 @@ "intensity", "category", "cost", - "taxonomy", "impact", "spatial", "functions" @@ -349,7 +369,7 @@ }, "category": { "title": "Exposure category", - "description": "The category of the exposed assets, from the closed [exposure category codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#exposure_category).", + "description": "The category of the exposed assets, from the closed [exposure_category codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#exposure-category).", "type": "string", "codelist": "exposure_category.csv", "openCodelist": false, @@ -404,7 +424,7 @@ "approach": { "title": "Vulnerability function approach", "type": "string", - "description": "The approach the vulnerability function is based upon, taken from the closed [function approach codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#function_approach).", + "description": "The approach the vulnerability function is based upon, taken from the closed [function_approach codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#function-approach).", "enum": [ "analytical", "empirical", @@ -418,7 +438,7 @@ "relationship": { "title": "Vulnerability impact relationship type", "type": "string", - "description": "The type of function relationships used to calculate the vulnerability impact values, taken from the closed [relationship type codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#relationship_type).", + "description": "The type of function relationships used to calculate the vulnerability impact values, taken from the closed [relationship_type codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#relationship-type).", "enum": [ "discrete", "math_bespoke", @@ -439,7 +459,7 @@ "approach": { "title": "Fragility function approach", "type": "string", - "description": "The approach the fragility function is based upon, taken from the closed [function approach codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#function_approach).", + "description": "The approach the fragility function is based upon, taken from the closed [function_approach codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#function-approach).", "enum": [ "analytical", "empirical", @@ -453,7 +473,7 @@ "relationship": { "title": "Fragility impact relationship type", "type": "string", - "description": "The type of function relationships used to calculate the impact values, taken from the closed [relationship type codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#relationship_type).", + "description": "The type of function relationships used to calculate the impact values, taken from the closed [relationship type_codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#relationship-type).", "enum": [ "discrete", "math_bespoke", @@ -466,7 +486,7 @@ "damage_scale_name": { "title": "Damage scale name", "type": "string", - "description": "The name of the damage scale used in the fragility function, taken from the open [damage scale name codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#damage_scale_name).", + "description": "The name of the damage scale used in the fragility function, taken from the open [damage_scale_name codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#damage-scale-name).", "codelist": "damage_scale_name.csv", "openCodelist": true, "minLength": 1 @@ -493,7 +513,7 @@ "approach": { "title": "Damage-to-loss function approach", "type": "string", - "description": "The approach the damage-to-loss impact function is based upon, taken from the closed [function approach codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#function_approach).", + "description": "The approach the damage-to-loss impact function is based upon, taken from the closed [function_approach codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#function-approach).", "enum": [ "analytical", "empirical", @@ -507,7 +527,7 @@ "relationship": { "title": "Damage-to-loss impact relationship type", "type": "string", - "description": "The type of function relationships used to calculate the damage-to-loss impact values, taken from the closed [relationship type codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#relationship_type).", + "description": "The type of function relationships used to calculate the damage-to-loss impact values, taken from the closed [relationship_type codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#relationship-type).", "enum": [ "discrete", "math_bespoke", @@ -520,7 +540,7 @@ "damage_scale_name": { "title": "Damage scale name", "type": "string", - "description": "The name of the damage scale used in the damage-to-loss function, taken from the open [damage scale name codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#damage_scale_name).", + "description": "The name of the damage scale used in the damage-to-loss function, taken from the open [damage_scale_name codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#damage-scale-name).", "codelist": "damage_scale_name.csv", "openCodelist": true, "minLength": 1 @@ -547,7 +567,7 @@ "parameter": { "title": "Engineering demand parameter", "type": "string", - "description": "The name of the engineering demand parameter, taken from the open [engineering demand parameter codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#engineering_demand_parameter).", + "description": "The name of the engineering demand parameter, taken from the open [engineering_demand_parameter codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#engineering-demand-parameter).", "codelist": "engineering_demand_parameter.csv", "openCodelist": true, "minLength": 1 @@ -555,7 +575,7 @@ "approach": { "title": "Engineering demand impact function approach", "type": "string", - "description": "The approach the engineering demand impact function is based upon, taken from the closed [function approach codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#function_approach).", + "description": "The approach the engineering demand impact function is based upon, taken from the closed [function_approach codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#function-approach).", "enum": [ "analytical", "empirical", @@ -569,7 +589,7 @@ "relationship": { "title": "Engineering demand impact relationship type", "type": "string", - "description": "The type of function relationships used to calculate the engineering impact values, taken from the closed [relationship type codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#relationship_type).", + "description": "The type of function relationships used to calculate the engineering impact values, taken from the closed [relationship_type codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#relationship-type).", "enum": [ "discrete", "math_bespoke", @@ -600,15 +620,12 @@ "minProperties": 1 }, "loss": { - "title": "Loss dataset metadata", + "title": "Loss metadata", "type": "object", "description": "Metadata that is specific to datasets that describe the losses associated with people, infrastructure, housing, production capacities and other tangible human assets due to the occurrence of one or more hazards.", "required": [ "hazard_type", - "cost", - "hazard_id", - "exposure_id", - "vulnerability_id" + "cost" ], "properties": { "hazard_type": { @@ -678,7 +695,7 @@ }, "category": { "title": "Exposure category", - "description": "The category of the exposed assets, from the closed [exposure category codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#exposure_category).", + "description": "The category of the exposed assets, from the closed [exposure_category codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#exposure-category).", "type": "string", "codelist": "exposure_category.csv", "openCodelist": false, @@ -709,7 +726,7 @@ "type": { "title": "Loss type", "type": "string", - "description": "The type of loss described in the dataset, from the closed [loss type codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#loss_type).", + "description": "The type of loss described in the dataset, from the closed [loss_type codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#loss-type).", "codelist": "loss_type.csv", "openCodelist": false, "enum": [ @@ -724,7 +741,7 @@ "approach": { "title": "Loss approach", "type": "string", - "description": "The approach the loss calculation function is based upon, taken from the closed [function approach codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#function_approach).", + "description": "The approach the loss calculation function is based upon, taken from the closed [function_approach codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#function-approach).", "codelist": "function_approach.csv", "openCodelist": false, "enum": [ @@ -737,7 +754,7 @@ "hazard_analysis_type": { "title": "Event frequency type", "type": "string", - "description": "The type of occurrence frequency represented in the modelled scenario, from the closed [analysis type codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#loss_type).", + "description": "The type of occurrence frequency represented in the modelled scenario, from the closed [analysis_type codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#loss-type).", "enum": [ "deterministic", "empirical", @@ -767,22 +784,6 @@ }, "minProperties": 1 }, - "sources": { - "title": "Sources", - "type": "array", - "description": "Sources of information that contribute to the creation of the dataset.", - "items": { - "$ref": "#/$defs/Source" - }, - "minItems": 1, - "uniqueItems": true - }, - "temporal_resolution": { - "title": "Temporal resolution", - "type": "string", - "description": "The minimum period of time resolvable in this dataset, in ISO8601 duration format.", - "format": "duration" - }, "links": { "title": "Links", "description": "Links to related resources. The first item in the links array must be a link to the canonical JSON schema that describes the structure of the data.", @@ -821,8 +822,7 @@ "id", "title", "description", - "format", - "url" + "format" ], "properties": { "id": { @@ -846,7 +846,7 @@ "media_type": { "title": "Media type", "type": "string", - "description": "The media type of the resource, from the open [media_type codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#media_type). For example a custom binary file has media_type 'application/octet-stream. A geojson file has the media_type 'application/geo+json'.", + "description": "The media type of the resource, from the open [media_type codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#media-type). For example a custom binary file has media_type 'application/octet-stream. A geojson file has the media_type 'application/geo+json'.", "codelist": "media_type.csv", "openCodelist": true, "minLength": 1 @@ -854,7 +854,7 @@ "format": { "title": "Format", "type": "string", - "description": "A human-readable description of the file format of the resource, taken from the open [data formats codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#data_formats).", + "description": "A human-readable description of the file format of the resource, taken from the open [data_formats codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#data-formats).", "codelist": "data_formats.csv", "openCodelist": true, "minLength": 1 @@ -866,17 +866,23 @@ "exclusiveMinimum": 0 }, "coordinate_system": { - "title": "Reference coordinate system", + "title": "Coordinate reference system", "type": "string", - "description": "The reference co-ordinate system of this resource, using the [EPSG codelist](https://epsg.org).", + "description": "An identifier string for the coordinate reference system (CRS) used in this resource. The CRS must be identified by a code issued by either [EPSG](https://epsg.org/) or [ESRI](https://www.esri.com/). The identifier string format is {authority}:{code}, e.g. EPSG:4326. [https://epsg.io/](https://epsg.io/) provides a searchable database of EPSG and ESRI coordinate system codes.", + "pattern": "^(ESRI:|EPSG:)[0-9]+$", "minLength": 1 }, - "url": { - "title": "Url", + "access_url": { + "title": "Access Url", "type": "string", - "description": "The web address this resource can be downloaded from.", + "description": "A web address that gives access to this resource, e.g. a webpage through which a user can request access by completing a form.", "format": "iri" }, + "download_url": { + "title": "Download Url", + "type": "string", + "description": "The web address this resource can be downloaded from in the given `.format`." + }, "temporal": { "title": "Temporal coverage", "description": "The period of time covered by this resource.", @@ -931,7 +937,7 @@ ], "properties": { "id": { - "title": "Identifier", + "title": "Attribution identifier", "type": "string", "description": "A locally unique identifier for the attribution.", "minLength": 1 @@ -961,7 +967,7 @@ ], "properties": { "id": { - "title": "Identifier", + "title": "Related resource identifier", "type": "string", "description": "A locally unique identifier for the related resource.", "minLength": 1 @@ -972,7 +978,7 @@ "description": "The name or title of the resource.", "minLength": 1 }, - "authorNames": { + "author_names": { "title": "Author names", "type": "array", "description": "The names of the authors of the resource.", @@ -983,7 +989,7 @@ "minItems": 1, "uniqueItems": true }, - "datePublished": { + "date_published": { "title": "Publication date", "type": "string", "description": "The date that the resource was first published.", @@ -1013,7 +1019,7 @@ ], "properties": { "id": { - "title": "Identifier", + "title": "Source identifier", "type": "string", "description": "A locally unique identifier for the source.", "minLength": 1 @@ -1033,7 +1039,7 @@ "type": { "title": "type", "type": "string", - "description": "The nature of the source, from the closed [source type codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#source_type).", + "description": "The nature of the source, from the closed [source_type codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#source-type).", "codelist": "source_type.csv", "openCodelist": false, "enum": [ @@ -1044,7 +1050,7 @@ "component": { "title": "Component", "type": "string", - "description": "The risk data component the source has been used in, from the closed [risk data type codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#risk_data_type).", + "description": "The risk data component the source has been used in, from the closed [risk_data_type codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#risk-data-type).", "codelist": "risk_data_type.csv", "openCodelist": false, "enum": [ @@ -1373,7 +1379,7 @@ "minItems": 1, "uniqueItems": true }, - "gazetteerEntries": { + "gazetteer_entries": { "title": "Gazetteer entries", "type": "array", "description": "Entries from geographical indices or directories describing the geographical area. This field should be used to describe sub-national coverage. Use of ISO 3166-2 is recommended.", @@ -1386,7 +1392,7 @@ "bbox": { "title": "Bounding box", "type": "array", - "description": "A geographic bounding box delimiting the geographical area.", + "description": "A geographic bounding box delimiting the geographical area. This field is an array of numbers. It must contain exactly four numbers with the first two numbers being the longitude and latitude of the most southwesterly point and the second two numbers being the longitude and latitude of the most northeasterly point. Coordinates must be specified using the World Geodetic System 1984 (WGS 84) datum, with longitude and latitude units of decimal degrees. This is equivalent to the coordinate reference system identified by the Open Geospatial Consortium URN urn:ogc:def:crs:OGC::CRS84.", "items": { "type": "number" }, @@ -1395,13 +1401,13 @@ }, "geometry": { "title": "Geometry", - "description": "A set of coordinates denoting the vertices of the geographical area.", + "description": "A set of coordinates denoting the vertices of the geographical area. This field describes the extent of the geographical area. To avoid creating very large metadata, geometries should have fewer than 50 vertices.", "$ref": "#/$defs/Geometry" }, "centroid": { "title": "Centroid", "type": "array", - "description": "The coordinates of the centre of the geographical area.", + "description": "The coordinates of the centre of the geographical area. This field is an array of numbers. It must contain exactly two numbers with longitude (easting) first and latitude (northing) second. Coordinates must be specified using the World Geodetic System 1984 (WGS 84) datum, with longitude and latitude units of decimal degrees. This is equivalent to the coordinate reference system identified by the Open Geospatial Consortium URN urn:ogc:def:crs:OGC::CRS84.", "items": { "type": "number" }, @@ -1433,7 +1439,7 @@ ], "properties": { "id": { - "title": "Identifier", + "title": "Gazetteer entry identifier", "type": "string", "description": "An identifier drawn from the gazetteer identified in `.scheme`.", "minLength": 1 @@ -1484,12 +1490,29 @@ "coordinates": { "title": "Coordinates", "type": "array", - "description": "One or more GeoJSON positions according to the GeoJSON geometry type defined in `.type`.", + "description": "One or more GeoJSON positions according to the GeoJSON geometry type defined in `.type`. Each position is an array of numbers containing exactly two numbers with longitude (easting) first and latitude (northing) second. Coordinates must be specified using the World Geodetic System 1984 (WGS 84) datum, with longitude and latitude units of decimal degrees. This is equivalent to the coordinate reference system identified by the Open Geospatial Consortium URN urn:ogc:def:crs:OGC::CRS84.", "items": { "type": [ "number", "array" ], + "items": { + "type": [ + "number", + "array" + ], + "items": { + "type": [ + "number", + "array" + ], + "items": { + "type": "number" + }, + "minItems": 1 + }, + "minItems": 1 + }, "minItems": 1 }, "minItems": 1 @@ -1508,14 +1531,14 @@ ], "properties": { "id": { - "title": "Identifier", + "title": "Hazard identifier", "description": "A local identifier for this hazard.", "type": "string", "minLength": 1 }, "type": { "title": "Hazard type", - "description": "The hazard type for this hazard, from the closed [hazard type codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#hazard_type).", + "description": "The hazard type for this hazard, from the closed [hazard_type codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#hazard-type).", "type": "string", "codelist": "hazard_type.csv", "openCodelist": false, @@ -1600,7 +1623,7 @@ "properties": { "type": { "title": "Hazard type", - "description": "The hazard type for this hazard, from the closed [hazard type codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#hazard_type).", + "description": "The hazard type for this hazard, from the closed [hazard_type codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#hazard-type).", "type": "string", "codelist": "hazard_type.csv", "openCodelist": false, @@ -1706,7 +1729,7 @@ "frequency_distribution": { "title": "Frequency distribution", "type": "string", - "description": "The frequency distribution assumed for the occurrence of events over a multi-year timeline, from the [frequency distribution codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#frequency_distribution).", + "description": "The frequency distribution assumed for the occurrence of events over a multi-year timeline, from the [frequency_distribution codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#frequency-distribution).", "codelist": "frequency_distribution.csv", "openCodelist": false, "enum": [ @@ -1719,7 +1742,7 @@ "seasonality": { "title": "Seasonality distribution", "type": "string", - "description": "The seasonality distribution assumed for the occurrence of events across a calendar year, from the [seasonality distribution codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#seasonality_distribution)", + "description": "The seasonality distribution assumed for the occurrence of events across a calendar year, from the [seasonality_distribution codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#seasonality-distribution)", "codelist": "seasonality.csv", "openCodelist": false, "enum": [ @@ -1730,7 +1753,7 @@ "calculation_method": { "title": "Calculation Method", "type": "string", - "description": "The methodology used for the calculation of the event set in the modelled scenario(s), taken from the closed [data calculation type codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#data_calculation_type).", + "description": "The methodology used for the calculation of the event set in the modelled scenario(s), taken from the closed [data_calculation_type codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#data-calculation-type).", "enum": [ "inferred", "observed", @@ -1790,11 +1813,14 @@ "description": "A locally unique identifier for this event.", "minLength": 1 }, - "disaster_identifier": { - "title": "Disaster identifier", - "type": "string", - "description": "The GLIDE number associated with this disaster event. A globally unique identifier for the event, assigned by [GLIDE](https://www.glidenumber.net/glide/public/search/search.jsp).", - "minLength": 1 + "disaster_identifiers": { + "title": "Disaster identifiers", + "type": "array", + "description": "Identifiers for the disaster to which this event relates.", + "items": { + "$ref": "#/$defs/Classification" + }, + "minItems": 1 }, "calculation_method": { "title": "Model calculation method", @@ -1923,33 +1949,74 @@ }, "minProperties": 1 }, + "Metric": { + "title": "Asset exposure metric", + "type": "object", + "description": "A measurement used to quantify the extent to which assets detailed in the dataset are exposed.", + "required": [ + "id", + "dimension", + "quantity_kind" + ], + "properties": { + "id": { + "title": "Identifier", + "type": "string", + "description": "A locally unique identifier for this metric.", + "minLength": 1 + }, + "dimension": { + "title": "Metric dimension", + "description": "The dimension on which the asset's exposure is measured, from the closed [metric_dimension codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#metric-dimension).", + "type": "string", + "codelist": "metric_dimension.csv", + "openCodelist": false, + "enum": [ + "structure", + "content", + "product", + "disruption", + "population" + ] + }, + "quantity_kind": { + "title": "Metric quantity kind", + "type": "string", + "description": "The kind of quantity by which the exposure is quantified, from the open [quantity_kind codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#quantity-kind). If the metric measures a quantity kind that is not included in the codelist, look up the correct code in the [QUDT Quantity Kind Vocabulary](https://www.qudt.org/doc/DOC_VOCAB-QUANTITY-KINDS.html).", + "codelist": "quantity_kind.csv", + "openCodelist": true + } + }, + "minProperties": 1 + }, "Cost": { "title": "Asset cost", "type": "object", - "description": "The costs associated with specific elements of assets detailed in the dataset.", + "description": "The costs associated with damage and disruption to specific elements of assets detailed in the dataset.", "required": [ "id", - "type", + "dimension", "unit" ], "properties": { "id": { - "title": "Identifier", + "title": "Cost identifier", "type": "string", "description": "A locally unique identifier for this cost.", "minLength": 1 }, - "type": { - "title": "Cost type", - "description": "The type of the cost, from the closed [cost type codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#cost_type).", + "dimension": { + "title": "Cost dimension", + "description": "The dimension of the assets that have incurred the cost, from the closed [metric_dimension codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#metric-dimension).", "type": "string", - "codelist": "cost_type.csv", + "codelist": "metric_dimension.csv", "openCodelist": false, "enum": [ "structure", "content", "product", - "disruption" + "disruption", + "population" ] }, "unit": { @@ -2318,7 +2385,7 @@ "type": { "title": "Impact type", "type": "string", - "description": "The type of impact calculated, taken from the closed [impact type codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#impact_type).", + "description": "The type of impact calculated, taken from the closed [impact_type codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#impact-type).", "codelist": "impact_type.csv", "openCodelist": false, "enum": [ @@ -2330,7 +2397,7 @@ "metric": { "title": "Impact metric", "type": "string", - "description": "The metric used to describe the impact, taken from the open [impact metric codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#impact_metric).", + "description": "The metric used to describe the impact, taken from the open [impact_metric codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#impact-metric).", "codelist": "impact_metric.csv", "openCodelist": true, "minLength": 1 @@ -2338,7 +2405,7 @@ "unit": { "title": "Impact unit", "type": "string", - "description": "The unit the impact value is expressed in, taken from the open [impact unit codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#impact_unit).", + "description": "The unit the impact value is expressed in, taken from the open [impact_unit codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#impact-unit).", "codelist": "impact_unit.csv", "openCodelist": true, "minLength": 1 @@ -2346,7 +2413,7 @@ "base_data_type": { "title": "Impact base data type", "type": "string", - "description": "The type of data used to calculate the impact values, taken from the closed [data calculation type codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#data_calculation_type).", + "description": "The type of data used to calculate the impact values, taken from the closed [data_calculation_type codelist](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#data-calculation-type).", "codelist": "data_calculation_type.csv", "openCodelist": false, "enum": [ @@ -2362,17 +2429,20 @@ "title": "Classification", "description": "A classification consists of at least two parts: an identifier for the list (scheme) from which the classification is taken, and an identifier for the category from that list being applied. It is useful to also publish a text label and/or URI that users can draw on to interpret the classification.", "type": "object", + "required": [ + "id" + ], "properties": { "scheme": { "title": "Scheme", - "description": "The scheme or codelist from which the classification code is taken, using the open [classification_scheme](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#classification_scheme) codelist.", + "description": "The scheme or codelist from which the classification code is taken, using the open [classification_scheme](https://rdl-standard.readthedocs.io/en/{{version}}/reference/codelists/#classification-scheme) codelist.", "type": "string", "codelist": "classification_scheme.csv", "openCodelist": true, "minLength": 1 }, "id": { - "title": "ID", + "title": "Classification identifier", "description": "The classification code taken from the scheme.", "type": "string", "minLength": 1 diff --git a/tests/test_csv.py b/tests/test_csv.py index 4090d285..ecb26590 100644 --- a/tests/test_csv.py +++ b/tests/test_csv.py @@ -29,7 +29,7 @@ def test_valid(): """ errors = 0 - for path, name, text, fieldnames, rows in walk_csv_data(): + for path, name, text, fieldnames, rows in walk_csv_data(excluded=('.git', '.ve', '_static', 'build', 'fixtures', 'flatten-tool', 'docson', 'examples')): codelist = is_codelist(fieldnames) width = len(fieldnames) columns = [] diff --git a/tests/test_json.py b/tests/test_json.py index 91776eea..1a191381 100644 --- a/tests/test_json.py +++ b/tests/test_json.py @@ -11,7 +11,7 @@ def test_empty(): """Tests that files (JSON and other files) are not empty.""" - empty_files_paths = [path for path in get_empty_files() if "src/" not in path[0]] + empty_files_paths = [path for path in get_empty_files(excluded=('.git', '.ve', '_static', 'build', 'fixtures', 'flatten-tool', 'docson')) if "src/" not in path[0]] warn_and_assert(empty_files_paths, "{0} is empty, run: rm {0}", "Files are empty. See warnings below.") @@ -20,7 +20,7 @@ def test_indent(): Test that JSON files are indented properly. Note this test can often fail on problems that are not to do with indents. """ - misindented_files_paths = [path for path in get_misindented_files() if "src/" not in path[0]] + misindented_files_paths = [path for path in get_misindented_files(excluded=('.git', '.ve', '_static', 'build', 'fixtures', 'flatten-tool', 'docson')) if "src/" not in path[0]] warn_and_assert( misindented_files_paths, "{0} is not indented as expected", @@ -31,5 +31,5 @@ def test_indent(): def test_invalid_json(): """Test whether all JSON files can be parsed.""" warn_and_assert( - get_invalid_json_files(excluded=('.git', '.ve', '_static', 'build', 'fixtures', "_build")), "{0} is not valid JSON: {1}", "JSON files are invalid. See warnings below." + get_invalid_json_files(excluded=('.git', '.ve', '_static', 'build', 'fixtures', 'flatten-tool', 'docson')), "{0} is not valid JSON: {1}", "JSON files are invalid. See warnings below." )