@hestia-earth/guide 0.0.17 → 0.0.19

package/dist/content/models/siteMeasurements/soil/sandContent/geospatialDatabase.json

@@ -1 +1 @@
-{"tags":{"author":["Guillaume Royer"],"group":["Site: Measurements"],"subgroup":["Soil"],"tab":["Geospatial Database"],"modelId":["sandContent"],"citation":["[FAO & IIASA (2023) Harmonized World Soil Database Version 2.0.](https://dx.doi.org/10.4060/cc3823en)"],"modelRequires":["clayContent","sandContent","siltContent"]},"content":"# Sand content\n\n\n\n\n\n\n\n\n\n\n\n<div class=\"collapsibles\">\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">\n      <span>Returns</span>\n    </div>\n    <div class=\"collapsible-content\"><ul>\n<li>A list of <a href=\"https://hestia.earth/schema/Measurement\">Measurements</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Measurement#term\">term</a> with <a href=\"https://hestia.earth/term/sandContent\">sandContent</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#value\">value</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#depthUpper\">depthUpper</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#depthLower\">depthLower</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#methodClassification\">methodClassification</a> with <code>geospatial dataset</code></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#source\">source</a> with <a href=\"https://hestia.earth/source/z__sv8swbjhp\">FAO &amp; IIASA (2023)</a></li>\n</ul>\n</li>\n</ul>\n</div>\n  </div>\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">\n      <span>Requirements</span>\n    </div>\n    <div class=\"collapsible-content\"><ul>\n<li>A <a href=\"https://hestia.earth/schema/Site\">Site</a> with:<ul>\n<li>a <a href=\"https://hestia.earth/schema/Site#siteType\">siteType</a> = <code>forest</code> <strong>or</strong> <code>other natural vegetation</code> <strong>or</strong> <code>cropland</code> <strong>or</strong> <code>glass or high accessible cover</code> <strong>or</strong> <code>permanent pasture</code></li>\n<li>either:<ul>\n<li>the following fields:<ul>\n<li><a href=\"https://hestia.earth/schema/Site#latitude\">latitude</a></li>\n<li><a href=\"https://hestia.earth/schema/Site#longitude\">longitude</a></li>\n</ul>\n</li>\n<li>the following fields:<ul>\n<li>a <a href=\"https://hestia.earth/schema/Site#boundary\">boundary</a></li>\n</ul>\n</li>\n<li>the following fields:<ul>\n<li>a <a href=\"https://hestia.earth/schema/Site#region\">region</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Term#termType\">termType</a> = <a href=\"https://hestia.earth/glossary?termType=region\">region</a></li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n<li>none of:<ul>\n<li>a list of <a href=\"https://hestia.earth/schema/Site#measurements\">measurements</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Measurement#term\">term</a> with <a href=\"https://hestia.earth/term/clayContent\">clayContent</a> <strong>or</strong> <a href=\"https://hestia.earth/term/sandContent\">sandContent</a> <strong>or</strong> <a href=\"https://hestia.earth/term/siltContent\">siltContent</a></li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</div>\n  </div>\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">\n      <span>Lookups used</span>\n    </div>\n    <div class=\"collapsible-content\"><ul>\n<li><a href=\"https://hestia.earth/glossary/lookups/measurement.csv\">measurement.csv</a> -&gt; <code>siteTypesAllowed</code></li>\n</ul>\n</div>\n  </div>\n  \n</div>"}
+{"tags":{"author":["Guillaume Royer"],"group":["Site: Measurements"],"subgroup":["Soil"],"tab":["Geospatial Database"],"tag":["Soil content"],"modelId":["sandContent"],"citation":["[FAO & IIASA (2023) Harmonized World Soil Database Version 2.0.](https://dx.doi.org/10.4060/cc3823en)"],"modelRequires":["clayContent","sandContent","siltContent"]},"content":"# Sand content\n\n## Overview\n\nThis model takes a site with geospatial content but no existing soil content measurements and gap-fills mean sand content values. \n\n## Data sources\n\nThis model relies on data from the Harmonized World Soil Database Version 2.0.\n\n## Model logic\n\nThe model looks up mean values for four depth ranges:\n\n - 0-20cm\n - 20-40cm\n - 40-60cm\n - 60-80cm\n\nFor every value found at one of these depth ranges, a new sand content measurement is created.\n\n\n\n\n\n\n\n\n\n\n\n\n<div class=\"collapsibles\">\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">\n      <span>Returns</span>\n    </div>\n    <div class=\"collapsible-content\"><ul>\n<li>A list of <a href=\"https://hestia.earth/schema/Measurement\">Measurements</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Measurement#term\">term</a> with <a href=\"https://hestia.earth/term/sandContent\">sandContent</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#value\">value</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#depthUpper\">depthUpper</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#depthLower\">depthLower</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#methodClassification\">methodClassification</a> with <code>geospatial dataset</code></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#source\">source</a> with <a href=\"https://hestia.earth/source/z__sv8swbjhp\">FAO &amp; IIASA (2023)</a></li>\n</ul>\n</li>\n</ul>\n</div>\n  </div>\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">\n      <span>Requirements</span>\n    </div>\n    <div class=\"collapsible-content\"><ul>\n<li>A <a href=\"https://hestia.earth/schema/Site\">Site</a> with:<ul>\n<li>a <a href=\"https://hestia.earth/schema/Site#siteType\">siteType</a> = <code>forest</code> <strong>or</strong> <code>other natural vegetation</code> <strong>or</strong> <code>cropland</code> <strong>or</strong> <code>glass or high accessible cover</code> <strong>or</strong> <code>permanent pasture</code></li>\n<li>either:<ul>\n<li>the following fields:<ul>\n<li><a href=\"https://hestia.earth/schema/Site#latitude\">latitude</a></li>\n<li><a href=\"https://hestia.earth/schema/Site#longitude\">longitude</a></li>\n</ul>\n</li>\n<li>the following fields:<ul>\n<li>a <a href=\"https://hestia.earth/schema/Site#boundary\">boundary</a></li>\n</ul>\n</li>\n<li>the following fields:<ul>\n<li>a <a href=\"https://hestia.earth/schema/Site#region\">region</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Term#termType\">termType</a> = <a href=\"https://hestia.earth/glossary?termType=region\">region</a></li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n<li>none of:<ul>\n<li>a list of <a href=\"https://hestia.earth/schema/Site#measurements\">measurements</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Measurement#term\">term</a> with <a href=\"https://hestia.earth/term/clayContent\">clayContent</a> <strong>or</strong> <a href=\"https://hestia.earth/term/sandContent\">sandContent</a> <strong>or</strong> <a href=\"https://hestia.earth/term/siltContent\">siltContent</a></li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</div>\n  </div>\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">\n      <span>Lookups used</span>\n    </div>\n    <div class=\"collapsible-content\"><ul>\n<li><a href=\"https://hestia.earth/glossary/lookups/measurement.csv\">measurement.csv</a> -&gt; <code>siteTypesAllowed</code></li>\n</ul>\n</div>\n  </div>\n  \n</div>"}

package/dist/content/models/siteMeasurements/soil/siltContent/content.json

@@ -1 +1 @@
-{"tags":{"author":["Guillaume Royer"],"group":["Site: Measurements"],"subgroup":["Soil"],"tab":["Geospatial Database"]},"content":"# Silt content\n\n\n\n\n"}
+{"tags":{"author":["Guillaume Royer"],"group":["Site: Measurements"],"subgroup":["Soil"],"tab":["Geospatial Database"],"tag":["Soil content"]},"content":"# Silt content\n\n## Overview\n\nThis model takes a site with existing measurements and gap-fills silt content values.\n\n## Data sources\n\nData is taken from the Harmonized World Soil Database Version 2.0 and existing soil content measurements.\n\n## Model logic\n\n - Existing measurement values for `clayContent` and `sandContent` are collected.\n - `siltContent` is calculated as the remainder from 100 after other soil content has been subtracted.\n\n$siltContent = 100 - ~clayContent + sandContent~$\n\n\n\n\n\n"}

package/dist/content/models/siteMeasurements/soil/siltContent/geospatialDatabase.json

@@ -1 +1 @@
-{"tags":{"author":["Guillaume Royer"],"group":["Site: Measurements"],"subgroup":["Soil"],"tab":["Geospatial Database"],"modelId":["siltContent"],"citation":["[FAO & IIASA (2023) Harmonized World Soil Database Version 2.0.](https://dx.doi.org/10.4060/cc3823en)"],"modelRequires":["clayContent","sandContent"]},"content":"# Silt content\n\n\n\n\n\n\n\n\n\n\n<div class=\"collapsibles\">\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">\n      <span>Returns</span>\n    </div>\n    <div class=\"collapsible-content\"><ul>\n<li>A list of <a href=\"https://hestia.earth/schema/Measurement\">Measurements</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Measurement#term\">term</a> with <a href=\"https://hestia.earth/term/siltContent\">siltContent</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#value\">value</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#depthUpper\">depthUpper</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#depthLower\">depthLower</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#methodClassification\">methodClassification</a> with <code>geospatial dataset</code></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#source\">source</a> with <a href=\"https://hestia.earth/source/z__sv8swbjhp\">FAO &amp; IIASA (2023)</a></li>\n</ul>\n</li>\n</ul>\n</div>\n  </div>\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">\n      <span>Requirements</span>\n    </div>\n    <div class=\"collapsible-content\"><ul>\n<li>A <a href=\"https://hestia.earth/schema/Site\">Site</a> with:<ul>\n<li>a <a href=\"https://hestia.earth/schema/Site#siteType\">siteType</a> = <code>forest</code> <strong>or</strong> <code>other natural vegetation</code> <strong>or</strong> <code>cropland</code> <strong>or</strong> <code>glass or high accessible cover</code> <strong>or</strong> <code>permanent pasture</code></li>\n<li>a list of <a href=\"https://hestia.earth/schema/Site#measurements\">measurements</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Measurement#term\">term</a> with <a href=\"https://hestia.earth/term/clayContent\">clayContent</a> and <a href=\"https://hestia.earth/schema/Measurement#value\">value</a> <code>&gt;= 0</code> and <a href=\"https://hestia.earth/schema/Measurement#depthUpper\">depthUpper</a> <code>&gt;= 0</code> and <a href=\"https://hestia.earth/schema/Measurement#depthLower\">depthLower</a> <code>&gt;= 0</code></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#term\">term</a> with <a href=\"https://hestia.earth/term/sandContent\">sandContent</a> and <a href=\"https://hestia.earth/schema/Measurement#value\">value</a> <code>&gt;= 0</code> and <a href=\"https://hestia.earth/schema/Measurement#depthUpper\">depthUpper</a> <code>&gt;= 0</code> and <a href=\"https://hestia.earth/schema/Measurement#depthLower\">depthLower</a> <code>&gt;= 0</code></li>\n</ul>\n</li>\n<li>either:<ul>\n<li>the following fields:<ul>\n<li><a href=\"https://hestia.earth/schema/Site#latitude\">latitude</a></li>\n<li><a href=\"https://hestia.earth/schema/Site#longitude\">longitude</a></li>\n</ul>\n</li>\n<li>the following fields:<ul>\n<li>a <a href=\"https://hestia.earth/schema/Site#boundary\">boundary</a></li>\n</ul>\n</li>\n<li>the following fields:<ul>\n<li>a <a href=\"https://hestia.earth/schema/Site#region\">region</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Term#termType\">termType</a> = <a href=\"https://hestia.earth/glossary?termType=region\">region</a></li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</div>\n  </div>\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">\n      <span>Lookups used</span>\n    </div>\n    <div class=\"collapsible-content\"><ul>\n<li><a href=\"https://hestia.earth/glossary/lookups/measurement.csv\">measurement.csv</a> -&gt; <code>siteTypesAllowed</code></li>\n</ul>\n</div>\n  </div>\n  \n</div>"}
+{"tags":{"author":["Guillaume Royer"],"group":["Site: Measurements"],"subgroup":["Soil"],"tab":["Geospatial Database"],"tag":["Soil content"],"modelId":["siltContent"],"citation":["[FAO & IIASA (2023) Harmonized World Soil Database Version 2.0.](https://dx.doi.org/10.4060/cc3823en)"],"modelRequires":["clayContent","sandContent"]},"content":"# Silt content\n\n## Overview\n\nThis model takes a site with existing measurements and gap-fills silt content values.\n\n## Data sources\n\nData is taken from the Harmonized World Soil Database Version 2.0 and existing soil content measurements.\n\n## Model logic\n\n - Existing measurement values for `clayContent` and `sandContent` are collected.\n - `siltContent` is calculated as the remainder from 100 after other soil content has been subtracted.\n\n$siltContent = 100 - ~clayContent + sandContent~$\n\n\n\n\n\n\n\n\n\n\n\n<div class=\"collapsibles\">\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">\n      <span>Returns</span>\n    </div>\n    <div class=\"collapsible-content\"><ul>\n<li>A list of <a href=\"https://hestia.earth/schema/Measurement\">Measurements</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Measurement#term\">term</a> with <a href=\"https://hestia.earth/term/siltContent\">siltContent</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#value\">value</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#depthUpper\">depthUpper</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#depthLower\">depthLower</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#methodClassification\">methodClassification</a> with <code>geospatial dataset</code></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#source\">source</a> with <a href=\"https://hestia.earth/source/z__sv8swbjhp\">FAO &amp; IIASA (2023)</a></li>\n</ul>\n</li>\n</ul>\n</div>\n  </div>\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">\n      <span>Requirements</span>\n    </div>\n    <div class=\"collapsible-content\"><ul>\n<li>A <a href=\"https://hestia.earth/schema/Site\">Site</a> with:<ul>\n<li>a <a href=\"https://hestia.earth/schema/Site#siteType\">siteType</a> = <code>forest</code> <strong>or</strong> <code>other natural vegetation</code> <strong>or</strong> <code>cropland</code> <strong>or</strong> <code>glass or high accessible cover</code> <strong>or</strong> <code>permanent pasture</code></li>\n<li>a list of <a href=\"https://hestia.earth/schema/Site#measurements\">measurements</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Measurement#term\">term</a> with <a href=\"https://hestia.earth/term/clayContent\">clayContent</a> and <a href=\"https://hestia.earth/schema/Measurement#value\">value</a> <code>&gt;= 0</code> and <a href=\"https://hestia.earth/schema/Measurement#depthUpper\">depthUpper</a> <code>&gt;= 0</code> and <a href=\"https://hestia.earth/schema/Measurement#depthLower\">depthLower</a> <code>&gt;= 0</code></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#term\">term</a> with <a href=\"https://hestia.earth/term/sandContent\">sandContent</a> and <a href=\"https://hestia.earth/schema/Measurement#value\">value</a> <code>&gt;= 0</code> and <a href=\"https://hestia.earth/schema/Measurement#depthUpper\">depthUpper</a> <code>&gt;= 0</code> and <a href=\"https://hestia.earth/schema/Measurement#depthLower\">depthLower</a> <code>&gt;= 0</code></li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</div>\n  </div>\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">\n      <span>Lookups used</span>\n    </div>\n    <div class=\"collapsible-content\"><ul>\n<li><a href=\"https://hestia.earth/glossary/lookups/measurement.csv\">measurement.csv</a> -&gt; <code>siteTypesAllowed</code></li>\n</ul>\n</div>\n  </div>\n  \n</div>"}

package/dist/content/models/siteMeasurements/soil/soilClassification/content.json

@@ -1 +1 @@
-{"tags":{"author":["Florian Payen"],"group":["Site: Measurements"],"subgroup":["Soil"],"tab":["HESTIA"],"tag":["soc modelling"]},"content":"# Soil Classification\n\nThis model summarises a Site's `soilType` Measurements. It returns a value for:\n\n1. `organicSoils` -> The total `% area` of the Site with organic soils (_i.e_., soils with an organic carbon content by weight equal to or higher than 20%.)\n2. `mineralSoils` -> The total `% area` of the Site with mineral soils (_i.e._, soils with an organic carbon content by weight lower than 20%.)\n\nThe model will attempt to run for all standard soil measurement depth intervals (0-30cm and 0-50cm) and, where possible, return values for each. The sum of `organicSoils` and `mineralSoils` for each unique depth interval should not exceed 100%.\n\nA Site's soil type can be expressed using World Reference Base (WRB) (`soilType`) or United States Department of Agriculture (USDA) (`usdaSoilType`) terms. Currently, this model only takes into account WRB data because this is gapfilled by other HESTIA models.\n\n## How the model works\n\nDifferent combinations of organic and mineral `soilType` Measurements may be present on a Site. All `soilType` terms are associated with an IPCC Soil Category (`IPCC_SOIL_CATEGORY`). All soils that are **not** `IPCC_SOIL_CATEGORY` = `Organic soils` are mineral soils.\n\n| `IPCC_SOIL_CATEGORY` lookup value | Classification | Description                                                                                                                                     |\n| --------------------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |\n| `Organic soils`                   | Organic soils  | Soils having organic material.                                                                                                                  |\n| `High-activity clay soils`        | Mineral soils  | Soils with high activity clay (HAC) minerals are lightly to moderately weathered soils dominated by 2:1 silicate clay minerals.                 |\n| `Low-activity clay soils`         | Mineral soils  | Soils with low activity clay (LAC) minerals are highly weathered soils, dominated by 1:1 clay minerals and amorphous iron and aluminium oxides. |\n| `Sandy soils`                     | Mineral soils  | Soils (regardless of taxonomic classification) having > 70% sand and < 8% clay.                                                                 |\n| `Spodic soils`                    | Mineral soils  | Soils exhibiting strong podzolization.                                                                                                          |\n| `Volcanic soils`                  | Mineral soils  | Soils derived from volcanic ash with allophanic mineralogy.                                                                                     |\n| `Wetland soils`                   | Mineral soils  | Soils with restricted drainage leading to periodic flooding and anaerobic conditions.                                                           |\n\nFor each unique measurement date and depth interval, the model calculates the values of `organicSoils` and `mineralSoils` as follows:\n\n1.  The value for `organicSoils` is the sum of all `soilType` Measurements with an `IPCC_SOIL_CATEGORY` = `Organic soils`\n2.  All remaining soils are assumed to be `mineralSoils`. The value is calculated as `100` - the value of `organicSoils`\n\nIf no `soilType` Measurements are available, the Site is assumed to be 100% `mineralSoils`.\n\n## How the model handles mixed soilType Measurement depths\n\nA Site may have `soilType` Measurements for multiple depth intervals (`depthUpper`, `depthLower`), including Measurements without depth data. To avoid downstream confusion about which values to use, this model will never return `organicSoils` and `mineralSoils` Measurements with a mix of depths and no depths. The model will prioritise input data using the following logic:\n\n1. If `soilType` Measurements are available for standard depths (0 - 30cm, 0 - 50cm) the model will run on these Measurements. All other Measurements are discarded.\n2. Otherwise, if `soilType` Measurements are available for other depth intervals (0 - 30cm, 0 - 50cm) the model will run on these Measurements. All other Measurements are discarded.\n3. Otherwise, the model will run on the `soilType` Measurements without depth data.\n\n## How the model handles mixed soilType Measurement dates\n\nA Site may also have `soilType` Measurements for multiple dates (`dates`), including Measurements without dates data. To avoid downstream confusion about which values to use, this model will never return `organicSoils` and `mineralSoils` Measurements with a mix of dates and no dates. The model will prioritise input data using the following logic:\n\n1. If all `soilType` Measurements have dates, the model will return `organicSoils` and `mineralSoils` values for each unique date in the inputs.\n2. If no `soilType` Measurements have dates, the model will return a single value for `organicSoils` and `mineralSoils` Measurements without dates.\n3. If some `soilType` Measurements have dates and others do not:\n   - If the model can directly calculate a value for `organicSoils` using the dated `soilType` Measurements, then it will return `organicSoils` and `mineralSoils` Measurements for each unique date in the inputs. All `soilType` Measurements without dates will be discarded.\n   - Otherwise, if the model can directly calculate a value for `organicSoils` using the undated `soilType` Measurements, then it will return a single value for `organicSoils` and `mineralSoils` Measurements without dates. All `soilType` Measurements with dates will be discarded.\n   - Otherwise, the model will return `organicSoils` = 0 and `mineralSoils` = 100 Measurements for each unique date in the inputs. All `soilType` Measurements without dates will be discarded.\n\n\n\n\n\n"}
+{"tags":{"author":["Florian Payen"],"group":["Site: Measurements"],"subgroup":["Soil"],"tab":["HESTIA"],"tag":["soc modelling"]},"content":"# Soil Classification\n\nThis model summarises a Site's `soilType`/`usdaSoilType` Measurements. It returns a value for:\n\n1. `organicSoils` -> The total `% area` of the Site with organic soils (_i.e_., soils with an organic carbon content by weight equal to or higher than 20%.)\n2. `mineralSoils` -> The total `% area` of the Site with mineral soils (_i.e._, soils with an organic carbon content by weight lower than 20%.)\n\nThe model will attempt to run for all standard soil measurement depth intervals (0-30cm and 0-50cm) and, where possible, return values for each. The sum of `organicSoils` and `mineralSoils` for each unique depth interval should not exceed 100%.\n\nA Site's soil type can be expressed using World Reference Base (WRB) (`soilType`) or United States Department of Agriculture (USDA) (`usdaSoilType`) terms. If `soilType` measurements are available, the model will run using those and discard any `usdaSoilType` measurements. If only `usdaSoilType` measurements are available the model will run using those instead.\n\n## How the model works\n\nDifferent combinations of organic and mineral `soilType`/`usdaSoilType` Measurements may be present on a Site. All `soilType`/`usdaSoilType` terms are associated with an IPCC Soil Category (`IPCC_SOIL_CATEGORY`). All soils that are **not** `IPCC_SOIL_CATEGORY` = `Organic soils` are mineral soils.\n\n| `IPCC_SOIL_CATEGORY` lookup value | Classification | Description                                                                                                                                     |\n| --------------------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |\n| `Organic soils`                   | Organic soils  | Soils having organic material.                                                                                                                  |\n| `High-activity clay soils`        | Mineral soils  | Soils with high activity clay (HAC) minerals are lightly to moderately weathered soils dominated by 2:1 silicate clay minerals.                 |\n| `Low-activity clay soils`         | Mineral soils  | Soils with low activity clay (LAC) minerals are highly weathered soils, dominated by 1:1 clay minerals and amorphous iron and aluminium oxides. |\n| `Sandy soils`                     | Mineral soils  | Soils (regardless of taxonomic classification) having > 70% sand and < 8% clay.                                                                 |\n| `Spodic soils`                    | Mineral soils  | Soils exhibiting strong podzolization.                                                                                                          |\n| `Volcanic soils`                  | Mineral soils  | Soils derived from volcanic ash with allophanic mineralogy.                                                                                     |\n| `Wetland soils`                   | Mineral soils  | Soils with restricted drainage leading to periodic flooding and anaerobic conditions.                                                           |\n\nFor each unique measurement date and depth interval, the model calculates the values of `organicSoils` and `mineralSoils` as follows:\n\n1.  The value for `organicSoils` is the sum of all `soilType`/`usdaSoilType` Measurements with an `IPCC_SOIL_CATEGORY` = `Organic soils`\n2.  All remaining soils are assumed to be `mineralSoils`. The value is calculated as `100` - the value of `organicSoils`\n\nIf no `soilType`/`usdaSoilType` Measurements are available, the Site is assumed to be 100% `mineralSoils`.\n\n## How the model handles mixed soilType Measurement depths\n\nA Site may have `soilType`/`usdaSoilType` Measurements for multiple depth intervals (`depthUpper`, `depthLower`), including Measurements without depth data. To avoid downstream confusion about which values to use, this model will never return `organicSoils` and `mineralSoils` Measurements with a mix of depths and no depths. The model will prioritise input data using the following logic:\n\n1. If `soilType`/`usdaSoilType` Measurements are available for standard depths (0 - 30cm, 0 - 50cm) the model will run on these Measurements. All other Measurements are discarded.\n2. Otherwise, if `soilType`/`usdaSoilType` Measurements are available for other depth intervals (0 - 30cm, 0 - 50cm) the model will run on these Measurements. All other Measurements are discarded.\n3. Otherwise, the model will run on the `soilType`/`usdaSoilType` Measurements without depth data.\n\n## How the model handles mixed soilType Measurement dates\n\nA Site may also have `soilType`/`usdaSoilType` Measurements for multiple dates (`dates`), including Measurements without dates data. To avoid downstream confusion about which values to use, this model will never return `organicSoils` and `mineralSoils` Measurements with a mix of dates and no dates. The model will prioritise input data using the following logic:\n\n1. If all `soilType`/`usdaSoilType` Measurements have dates, the model will return `organicSoils` and `mineralSoils` values for each unique date in the inputs.\n2. If no `soilType`/`usdaSoilType` Measurements have dates, the model will return a single value for `organicSoils` and `mineralSoils` Measurements without dates.\n3. If some `soilType`/`usdaSoilType` Measurements have dates and others do not:\n   - If the model can directly calculate a value for `organicSoils` using the dated `soilType`/`usdaSoilType` Measurements, then it will return `organicSoils` and `mineralSoils` Measurements for each unique date in the inputs. All `soilType`/`usdaSoilType` Measurements without dates will be discarded.\n   - Otherwise, if the model can directly calculate a value for `organicSoils` using the undated `soilType`/`usdaSoilType` Measurements, then it will return a single value for `organicSoils` and `mineralSoils` Measurements without dates. All `soilType`/`usdaSoilType` Measurements with dates will be discarded.\n   - Otherwise, the model will return `organicSoils` = 0 and `mineralSoils` = 100 Measurements for each unique date in the inputs. All `soilType`/`usdaSoilType` Measurements without dates will be discarded.\n\n\n\n\n\n"}

package/dist/content/models/siteMeasurements/soil/soilClassification/hestia.json

@@ -1 +1 @@
-{"tags":{"author":["Florian Payen"],"group":["Site: Measurements"],"subgroup":["Soil"],"tab":["HESTIA"],"tag":["soc modelling"],"modelId":["organicSoils","mineralSoils"]},"content":"# Soil Classification\n\nThis model summarises a Site's `soilType` Measurements. It returns a value for:\n\n1. `organicSoils` -> The total `% area` of the Site with organic soils (_i.e_., soils with an organic carbon content by weight equal to or higher than 20%.)\n2. `mineralSoils` -> The total `% area` of the Site with mineral soils (_i.e._, soils with an organic carbon content by weight lower than 20%.)\n\nThe model will attempt to run for all standard soil measurement depth intervals (0-30cm and 0-50cm) and, where possible, return values for each. The sum of `organicSoils` and `mineralSoils` for each unique depth interval should not exceed 100%.\n\nA Site's soil type can be expressed using World Reference Base (WRB) (`soilType`) or United States Department of Agriculture (USDA) (`usdaSoilType`) terms. Currently, this model only takes into account WRB data because this is gapfilled by other HESTIA models.\n\n## How the model works\n\nDifferent combinations of organic and mineral `soilType` Measurements may be present on a Site. All `soilType` terms are associated with an IPCC Soil Category (`IPCC_SOIL_CATEGORY`). All soils that are **not** `IPCC_SOIL_CATEGORY` = `Organic soils` are mineral soils.\n\n| `IPCC_SOIL_CATEGORY` lookup value | Classification | Description                                                                                                                                     |\n| --------------------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |\n| `Organic soils`                   | Organic soils  | Soils having organic material.                                                                                                                  |\n| `High-activity clay soils`        | Mineral soils  | Soils with high activity clay (HAC) minerals are lightly to moderately weathered soils dominated by 2:1 silicate clay minerals.                 |\n| `Low-activity clay soils`         | Mineral soils  | Soils with low activity clay (LAC) minerals are highly weathered soils, dominated by 1:1 clay minerals and amorphous iron and aluminium oxides. |\n| `Sandy soils`                     | Mineral soils  | Soils (regardless of taxonomic classification) having > 70% sand and < 8% clay.                                                                 |\n| `Spodic soils`                    | Mineral soils  | Soils exhibiting strong podzolization.                                                                                                          |\n| `Volcanic soils`                  | Mineral soils  | Soils derived from volcanic ash with allophanic mineralogy.                                                                                     |\n| `Wetland soils`                   | Mineral soils  | Soils with restricted drainage leading to periodic flooding and anaerobic conditions.                                                           |\n\nFor each unique measurement date and depth interval, the model calculates the values of `organicSoils` and `mineralSoils` as follows:\n\n1.  The value for `organicSoils` is the sum of all `soilType` Measurements with an `IPCC_SOIL_CATEGORY` = `Organic soils`\n2.  All remaining soils are assumed to be `mineralSoils`. The value is calculated as `100` - the value of `organicSoils`\n\nIf no `soilType` Measurements are available, the Site is assumed to be 100% `mineralSoils`.\n\n## How the model handles mixed soilType Measurement depths\n\nA Site may have `soilType` Measurements for multiple depth intervals (`depthUpper`, `depthLower`), including Measurements without depth data. To avoid downstream confusion about which values to use, this model will never return `organicSoils` and `mineralSoils` Measurements with a mix of depths and no depths. The model will prioritise input data using the following logic:\n\n1. If `soilType` Measurements are available for standard depths (0 - 30cm, 0 - 50cm) the model will run on these Measurements. All other Measurements are discarded.\n2. Otherwise, if `soilType` Measurements are available for other depth intervals (0 - 30cm, 0 - 50cm) the model will run on these Measurements. All other Measurements are discarded.\n3. Otherwise, the model will run on the `soilType` Measurements without depth data.\n\n## How the model handles mixed soilType Measurement dates\n\nA Site may also have `soilType` Measurements for multiple dates (`dates`), including Measurements without dates data. To avoid downstream confusion about which values to use, this model will never return `organicSoils` and `mineralSoils` Measurements with a mix of dates and no dates. The model will prioritise input data using the following logic:\n\n1. If all `soilType` Measurements have dates, the model will return `organicSoils` and `mineralSoils` values for each unique date in the inputs.\n2. If no `soilType` Measurements have dates, the model will return a single value for `organicSoils` and `mineralSoils` Measurements without dates.\n3. If some `soilType` Measurements have dates and others do not:\n   - If the model can directly calculate a value for `organicSoils` using the dated `soilType` Measurements, then it will return `organicSoils` and `mineralSoils` Measurements for each unique date in the inputs. All `soilType` Measurements without dates will be discarded.\n   - Otherwise, if the model can directly calculate a value for `organicSoils` using the undated `soilType` Measurements, then it will return a single value for `organicSoils` and `mineralSoils` Measurements without dates. All `soilType` Measurements with dates will be discarded.\n   - Otherwise, the model will return `organicSoils` = 0 and `mineralSoils` = 100 Measurements for each unique date in the inputs. All `soilType` Measurements without dates will be discarded.\n\n\n\n\n\n\n\n\n\n<div class=\"collapsibles\">\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">\n      <span>Returns</span>\n    </div>\n    <div class=\"collapsible-content\"><ul>\n<li>A list of <a href=\"https://hestia.earth/schema/Measurement\">Measurements</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Measurement#term\">term</a> with <a href=\"https://hestia.earth/term/organicSoils\">organicSoils</a> <strong>or</strong> <a href=\"https://hestia.earth/term/mineralSoils\">mineralSoils</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#method\">method</a> with <a href=\"https://hestia.earth/term/hestia\">hestia</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#value\">value</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#depthUpper\">depthUpper</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#depthLower\">depthLower</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#methodClassification\">methodClassification</a> with <code>modelled using other measurements</code></li>\n</ul>\n</li>\n</ul>\n</div>\n  </div>\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">\n      <span>Requirements</span>\n    </div>\n    <div class=\"collapsible-content\"><ul>\n<li>A <a href=\"https://hestia.earth/schema/Site\">Site</a> with:<ul>\n<li>optional:<ul>\n<li>a list of <a href=\"https://hestia.earth/schema/Site#measurements\">measurements</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Measurement#value\">value</a> and <a href=\"https://hestia.earth/schema/Measurement#depthUpper\">depthUpper</a> and <a href=\"https://hestia.earth/schema/Measurement#depthLower\">depthLower</a> and <a href=\"https://hestia.earth/schema/Measurement#term\">term</a> of <a href=\"https://hestia.earth/schema/Term#termType\">termType</a> = <a href=\"https://hestia.earth/glossary?termType=soilType\">soilType</a> and optional:<ul>\n<li><a href=\"https://hestia.earth/schema/Measurement#dates\">dates</a></li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</div>\n  </div>\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">\n      <span>Lookups used</span>\n    </div>\n    <div class=\"collapsible-content\"><ul>\n<li><a href=\"https://hestia.earth/glossary/lookups/soilType.csv\">soilType.csv</a> -&gt; <code>IPCC_SOIL_CATEGORY</code></li>\n</ul>\n</div>\n  </div>\n  \n</div>"}
+{"tags":{"author":["Florian Payen"],"group":["Site: Measurements"],"subgroup":["Soil"],"tab":["HESTIA"],"tag":["soc modelling"],"modelId":["organicSoils","mineralSoils"]},"content":"# Soil Classification\n\nThis model summarises a Site's `soilType`/`usdaSoilType` Measurements. It returns a value for:\n\n1. `organicSoils` -> The total `% area` of the Site with organic soils (_i.e_., soils with an organic carbon content by weight equal to or higher than 20%.)\n2. `mineralSoils` -> The total `% area` of the Site with mineral soils (_i.e._, soils with an organic carbon content by weight lower than 20%.)\n\nThe model will attempt to run for all standard soil measurement depth intervals (0-30cm and 0-50cm) and, where possible, return values for each. The sum of `organicSoils` and `mineralSoils` for each unique depth interval should not exceed 100%.\n\nA Site's soil type can be expressed using World Reference Base (WRB) (`soilType`) or United States Department of Agriculture (USDA) (`usdaSoilType`) terms. If `soilType` measurements are available, the model will run using those and discard any `usdaSoilType` measurements. If only `usdaSoilType` measurements are available the model will run using those instead.\n\n## How the model works\n\nDifferent combinations of organic and mineral `soilType`/`usdaSoilType` Measurements may be present on a Site. All `soilType`/`usdaSoilType` terms are associated with an IPCC Soil Category (`IPCC_SOIL_CATEGORY`). All soils that are **not** `IPCC_SOIL_CATEGORY` = `Organic soils` are mineral soils.\n\n| `IPCC_SOIL_CATEGORY` lookup value | Classification | Description                                                                                                                                     |\n| --------------------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |\n| `Organic soils`                   | Organic soils  | Soils having organic material.                                                                                                                  |\n| `High-activity clay soils`        | Mineral soils  | Soils with high activity clay (HAC) minerals are lightly to moderately weathered soils dominated by 2:1 silicate clay minerals.                 |\n| `Low-activity clay soils`         | Mineral soils  | Soils with low activity clay (LAC) minerals are highly weathered soils, dominated by 1:1 clay minerals and amorphous iron and aluminium oxides. |\n| `Sandy soils`                     | Mineral soils  | Soils (regardless of taxonomic classification) having > 70% sand and < 8% clay.                                                                 |\n| `Spodic soils`                    | Mineral soils  | Soils exhibiting strong podzolization.                                                                                                          |\n| `Volcanic soils`                  | Mineral soils  | Soils derived from volcanic ash with allophanic mineralogy.                                                                                     |\n| `Wetland soils`                   | Mineral soils  | Soils with restricted drainage leading to periodic flooding and anaerobic conditions.                                                           |\n\nFor each unique measurement date and depth interval, the model calculates the values of `organicSoils` and `mineralSoils` as follows:\n\n1.  The value for `organicSoils` is the sum of all `soilType`/`usdaSoilType` Measurements with an `IPCC_SOIL_CATEGORY` = `Organic soils`\n2.  All remaining soils are assumed to be `mineralSoils`. The value is calculated as `100` - the value of `organicSoils`\n\nIf no `soilType`/`usdaSoilType` Measurements are available, the Site is assumed to be 100% `mineralSoils`.\n\n## How the model handles mixed soilType Measurement depths\n\nA Site may have `soilType`/`usdaSoilType` Measurements for multiple depth intervals (`depthUpper`, `depthLower`), including Measurements without depth data. To avoid downstream confusion about which values to use, this model will never return `organicSoils` and `mineralSoils` Measurements with a mix of depths and no depths. The model will prioritise input data using the following logic:\n\n1. If `soilType`/`usdaSoilType` Measurements are available for standard depths (0 - 30cm, 0 - 50cm) the model will run on these Measurements. All other Measurements are discarded.\n2. Otherwise, if `soilType`/`usdaSoilType` Measurements are available for other depth intervals (0 - 30cm, 0 - 50cm) the model will run on these Measurements. All other Measurements are discarded.\n3. Otherwise, the model will run on the `soilType`/`usdaSoilType` Measurements without depth data.\n\n## How the model handles mixed soilType Measurement dates\n\nA Site may also have `soilType`/`usdaSoilType` Measurements for multiple dates (`dates`), including Measurements without dates data. To avoid downstream confusion about which values to use, this model will never return `organicSoils` and `mineralSoils` Measurements with a mix of dates and no dates. The model will prioritise input data using the following logic:\n\n1. If all `soilType`/`usdaSoilType` Measurements have dates, the model will return `organicSoils` and `mineralSoils` values for each unique date in the inputs.\n2. If no `soilType`/`usdaSoilType` Measurements have dates, the model will return a single value for `organicSoils` and `mineralSoils` Measurements without dates.\n3. If some `soilType`/`usdaSoilType` Measurements have dates and others do not:\n   - If the model can directly calculate a value for `organicSoils` using the dated `soilType`/`usdaSoilType` Measurements, then it will return `organicSoils` and `mineralSoils` Measurements for each unique date in the inputs. All `soilType`/`usdaSoilType` Measurements without dates will be discarded.\n   - Otherwise, if the model can directly calculate a value for `organicSoils` using the undated `soilType`/`usdaSoilType` Measurements, then it will return a single value for `organicSoils` and `mineralSoils` Measurements without dates. All `soilType`/`usdaSoilType` Measurements with dates will be discarded.\n   - Otherwise, the model will return `organicSoils` = 0 and `mineralSoils` = 100 Measurements for each unique date in the inputs. All `soilType`/`usdaSoilType` Measurements without dates will be discarded.\n\n\n\n\n\n\n\n\n\n<div class=\"collapsibles\">\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">\n      <span>Returns</span>\n    </div>\n    <div class=\"collapsible-content\"><ul>\n<li>A list of <a href=\"https://hestia.earth/schema/Measurement\">Measurements</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Measurement#term\">term</a> with <a href=\"https://hestia.earth/term/organicSoils\">organicSoils</a> <strong>or</strong> <a href=\"https://hestia.earth/term/mineralSoils\">mineralSoils</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#method\">method</a> with <a href=\"https://hestia.earth/term/hestia\">hestia</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#value\">value</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#depthUpper\">depthUpper</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#depthLower\">depthLower</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#methodClassification\">methodClassification</a> with <code>modelled using other measurements</code></li>\n</ul>\n</li>\n</ul>\n</div>\n  </div>\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">\n      <span>Requirements</span>\n    </div>\n    <div class=\"collapsible-content\"><ul>\n<li>A <a href=\"https://hestia.earth/schema/Site\">Site</a> with:<ul>\n<li>optional:<ul>\n<li>a list of <a href=\"https://hestia.earth/schema/Site#measurements\">measurements</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Measurement#value\">value</a> and <a href=\"https://hestia.earth/schema/Measurement#depthUpper\">depthUpper</a> and <a href=\"https://hestia.earth/schema/Measurement#depthLower\">depthLower</a> and <a href=\"https://hestia.earth/schema/Measurement#term\">term</a> of <a href=\"https://hestia.earth/schema/Term#termType\">termType</a> = <a href=\"https://hestia.earth/glossary?termType=soilType\">soilType</a> <strong>or</strong> <a href=\"https://hestia.earth/glossary?termType=usdaSoilType\">usdaSoilType</a> and optional:<ul>\n<li><a href=\"https://hestia.earth/schema/Measurement#dates\">dates</a></li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</div>\n  </div>\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">\n      <span>Lookups used</span>\n    </div>\n    <div class=\"collapsible-content\"><ul>\n<li><a href=\"https://hestia.earth/glossary/lookups/soilType.csv\">soilType.csv</a> -&gt; <code>IPCC_SOIL_CATEGORY</code></li>\n<li><a href=\"https://hestia.earth/glossary/lookups/usdaSoilType.csv\">usdaSoilType.csv</a> -&gt; <code>IPCC_SOIL_CATEGORY</code></li>\n</ul>\n</div>\n  </div>\n  \n</div>"}

package/dist/content/models/siteMeasurements/soil/totalPhosphorusPerKgSoil/geospatialDatabase.json

@@ -1 +1 @@
-{"tags":{"author":["Guillaume Royer"],"group":["Site: Measurements"],"subgroup":["Soil"],"tab":["Geospatial Database"],"modelId":["totalPhosphorusPerKgSoil"],"citation":["[Scherer & Pfister (2015) Modelling spatially explicit impacts from phosphorus emissions in agriculture](https://dx.doi.org/10.1007/s11367-015-0880-0)"]},"content":"# Total phosphorus (per kg soil)\n\n\n\n\n\n\n\n<div class=\"collapsibles\">\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">\n      <span>Returns</span>\n    </div>\n    <div class=\"collapsible-content\"><ul>\n<li>A list of <a href=\"https://hestia.earth/schema/Measurement\">Measurements</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Measurement#term\">term</a> with <a href=\"https://hestia.earth/term/totalPhosphorusPerKgSoil\">totalPhosphorusPerKgSoil</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#value\">value</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#depthUpper\">depthUpper</a> with <code>0</code></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#depthLower\">depthLower</a> with <code>50</code></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#methodClassification\">methodClassification</a> with <code>geospatial dataset</code></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#source\">source</a> with <a href=\"https://hestia.earth/source/7uet-cddumlv\">Scherer &amp; Pfister (2015)</a></li>\n</ul>\n</li>\n</ul>\n</div>\n  </div>\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">\n      <span>Requirements</span>\n    </div>\n    <div class=\"collapsible-content\"><ul>\n<li>A <a href=\"https://hestia.earth/schema/Site\">Site</a> with:<ul>\n<li>a <a href=\"https://hestia.earth/schema/Site#siteType\">siteType</a> = <code>forest</code> <strong>or</strong> <code>other natural vegetation</code> <strong>or</strong> <code>cropland</code> <strong>or</strong> <code>glass or high accessible cover</code> <strong>or</strong> <code>permanent pasture</code></li>\n<li>either:<ul>\n<li>the following fields:<ul>\n<li><a href=\"https://hestia.earth/schema/Site#latitude\">latitude</a></li>\n<li><a href=\"https://hestia.earth/schema/Site#longitude\">longitude</a></li>\n</ul>\n</li>\n<li>the following fields:<ul>\n<li>a <a href=\"https://hestia.earth/schema/Site#boundary\">boundary</a></li>\n</ul>\n</li>\n<li>the following fields:<ul>\n<li>a <a href=\"https://hestia.earth/schema/Site#region\">region</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Term#termType\">termType</a> = <a href=\"https://hestia.earth/glossary?termType=region\">region</a></li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</div>\n  </div>\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">\n      <span>Lookups used</span>\n    </div>\n    <div class=\"collapsible-content\"><ul>\n<li><a href=\"https://hestia.earth/glossary/lookups/measurement.csv\">measurement.csv</a> -&gt; <code>siteTypesAllowed</code></li>\n</ul>\n</div>\n  </div>\n  \n</div>"}
+{"tags":{"author":["Guillaume Royer"],"group":["Site: Measurements"],"subgroup":["Soil"],"tab":["Geospatial Database"],"modelId":["totalPhosphorusPerKgSoil"]},"content":"# Total phosphorus (per kg soil)\n\n\n\n\n\n\n\n<div class=\"collapsibles\">\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">\n      <span>Returns</span>\n    </div>\n    <div class=\"collapsible-content\"><ul>\n<li>A list of <a href=\"https://hestia.earth/schema/Measurement\">Measurements</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Measurement#term\">term</a> with <a href=\"https://hestia.earth/term/totalPhosphorusPerKgSoil\">totalPhosphorusPerKgSoil</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#value\">value</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#depthUpper\">depthUpper</a> with <code>0</code></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#depthLower\">depthLower</a> with <code>50</code></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#methodClassification\">methodClassification</a> with <code>geospatial dataset</code></li>\n</ul>\n</li>\n</ul>\n</div>\n  </div>\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">\n      <span>Requirements</span>\n    </div>\n    <div class=\"collapsible-content\"><ul>\n<li>A <a href=\"https://hestia.earth/schema/Site\">Site</a> with:<ul>\n<li>a <a href=\"https://hestia.earth/schema/Site#siteType\">siteType</a> = <code>forest</code> <strong>or</strong> <code>other natural vegetation</code> <strong>or</strong> <code>cropland</code> <strong>or</strong> <code>glass or high accessible cover</code> <strong>or</strong> <code>permanent pasture</code></li>\n<li>either:<ul>\n<li>the following fields:<ul>\n<li><a href=\"https://hestia.earth/schema/Site#latitude\">latitude</a></li>\n<li><a href=\"https://hestia.earth/schema/Site#longitude\">longitude</a></li>\n</ul>\n</li>\n<li>the following fields:<ul>\n<li>a <a href=\"https://hestia.earth/schema/Site#boundary\">boundary</a></li>\n</ul>\n</li>\n<li>the following fields:<ul>\n<li>a <a href=\"https://hestia.earth/schema/Site#region\">region</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Term#termType\">termType</a> = <a href=\"https://hestia.earth/glossary?termType=region\">region</a></li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</div>\n  </div>\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">\n      <span>Lookups used</span>\n    </div>\n    <div class=\"collapsible-content\"><ul>\n<li><a href=\"https://hestia.earth/glossary/lookups/measurement.csv\">measurement.csv</a> -&gt; <code>siteTypesAllowed</code></li>\n</ul>\n</div>\n  </div>\n  \n</div>"}

package/dist/index.d.ts

@@ -16,6 +16,10 @@ export interface IGuideIndexPageContent {
     createdAt: string;
     updatedAt?: string;
     tags?: Record<string, string[]>;
+    /**
+     * Added when listing from index
+     */
+    parentId?: string;
 }
 export interface IGuideIndexPage {
     content?: IGuideIndexPageContent;
@@ -30,6 +34,7 @@ export interface IGuideIndex {
 }
 export declare const loadIndex: () => IGuideIndex;
 export declare const listPages: (key: keyof IGuideIndex) => IGuideIndexPageContent[];
+export declare const indexPages: (index: IGuideIndex) => IGuideIndexPageContent[];
 export declare const findPage: (key: keyof IGuideIndex, id: string) => IGuideIndexPageContent;
 export interface IGuidePageContent {
     content: string;

package/dist/index.js

@@ -1,4 +1,15 @@
 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 var __read = (this && this.__read) || function (o, n) {
     var m = typeof Symbol === "function" && o[Symbol.iterator];
     if (!m) return o;
@@ -25,19 +36,26 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     return to.concat(ar || Array.prototype.slice.call(from));
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadPage = exports.findPage = exports.listPages = exports.loadIndex = void 0;
+exports.loadPage = exports.findPage = exports.indexPages = exports.listPages = exports.loadIndex = void 0;
 var loadIndex = function () { return require("./content/index.json"); };
 exports.loadIndex = loadIndex;
+var flatPages = function (_a, parentId) {
+    var content = _a.content, pages = _a.pages;
+    if (parentId === void 0) { parentId = ""; }
+    return __spreadArray([
+        __assign(__assign({}, content), { parentId: parentId })
+    ], __read(Object.values(pages || {}).flatMap(function (values) {
+        return flatPages(values, content.id);
+    })), false).filter(Boolean);
+};
 var listPages = function (key) {
-    return (0, exports.loadIndex)()[key].flatMap(flatPages);
+    return (0, exports.loadIndex)()[key].flatMap(function (value) { return flatPages(value); });
 };
 exports.listPages = listPages;
-var flatPages = function (_a) {
-    var content = _a.content, pages = _a.pages;
-    return __spreadArray([
-        content
-    ], __read(Object.values(pages || {}).flatMap(function (values) { return flatPages(values); })), false).filter(Boolean);
+var indexPages = function (index) {
+    return Object.keys(index).flatMap(exports.listPages);
 };
+exports.indexPages = indexPages;
 var findPage = function (key, id) {
     return (0, exports.listPages)(key).find(function (page) { return page.id === id; });
 };

package/json_models/agribalyse2016/fuelElectricity.py.json

@@ -0,0 +1,26 @@
+{
+    "REQUIREMENTS": {
+        "Cycle": {
+            "completeness.electricityFuel": "False",
+            "practices": [
+                {
+                    "@type": "Practice",
+                    "term.termType": "operation",
+                    "value": "> 0"
+                }
+            ]
+        }
+    },
+    "LOOKUPS": {
+        "operation": "fuelUse"
+    },
+    "RETURNS": {
+        "Input": [
+            {
+                "term.termType": "fuel",
+                "value": "",
+                "operation": ""
+            }
+        ]
+    }
+}

package/json_models/agribalyse2016/machineryInfrastructureDepreciatedAmountPerCycle.py.json

@@ -0,0 +1,31 @@
+{
+    "REQUIREMENTS": {
+        "Cycle": {
+            "inputs": [
+                {
+                    "@type": "Input",
+                    "term.termType": "fuel",
+                    "value": ""
+                }
+            ],
+            "completeness.material": "False",
+            "site": {
+                "@type": "Site",
+                "country": {
+                    "@type": "Term",
+                    "termType": "region"
+                }
+            }
+        }
+    },
+    "LOOKUPS": {
+        "region": "HDI"
+    },
+    "RETURNS": {
+        "Input": [
+            {
+                "value": ""
+            }
+        ]
+    }
+}

package/json_models/akagiEtAl2011/ch4ToAirCropResidueBurning.py.json

@@ -0,0 +1,35 @@
+{
+    "REQUIREMENTS": {
+        "Cycle": {
+            "or": {
+                "products": [
+                    {
+                        "@type": "Product",
+                        "term.@id": [
+                            "aboveGroundCropResidueBurnt",
+                            "discardedCropBurnt"
+                        ],
+                        "value": ""
+                    }
+                ],
+                "completeness.cropResidue": "True"
+            }
+        }
+    },
+    "RETURNS": {
+        "Emission": [
+            {
+                "value": "",
+                "sd": "",
+                "methodTier": "tier 1",
+                "statsDefinition": "modelled"
+            }
+        ]
+    },
+    "LOOKUPS": {
+        "emission": [
+            "akagiEtAl2011CropResidueBurningFactor",
+            "akagiEtAl2011CropResidueBurningFactor-sd"
+        ]
+    }
+}

package/json_models/akagiEtAl2011/nh3ToAirCropResidueBurning.py.json

@@ -0,0 +1,35 @@
+{
+    "REQUIREMENTS": {
+        "Cycle": {
+            "or": {
+                "products": [
+                    {
+                        "@type": "Product",
+                        "term.@id": [
+                            "aboveGroundCropResidueBurnt",
+                            "discardedCropBurnt"
+                        ],
+                        "value": ""
+                    }
+                ],
+                "completeness.cropResidue": "True"
+            }
+        }
+    },
+    "RETURNS": {
+        "Emission": [
+            {
+                "value": "",
+                "sd": "",
+                "methodTier": "tier 1",
+                "statsDefinition": "modelled"
+            }
+        ]
+    },
+    "LOOKUPS": {
+        "emission": [
+            "akagiEtAl2011CropResidueBurningFactor",
+            "akagiEtAl2011CropResidueBurningFactor-sd"
+        ]
+    }
+}

package/json_models/akagiEtAl2011/noxToAirCropResidueBurning.py.json

@@ -0,0 +1,35 @@
+{
+    "REQUIREMENTS": {
+        "Cycle": {
+            "or": {
+                "products": [
+                    {
+                        "@type": "Product",
+                        "term.@id": [
+                            "aboveGroundCropResidueBurnt",
+                            "discardedCropBurnt"
+                        ],
+                        "value": ""
+                    }
+                ],
+                "completeness.cropResidue": "True"
+            }
+        }
+    },
+    "RETURNS": {
+        "Emission": [
+            {
+                "value": "",
+                "sd": "",
+                "methodTier": "tier 1",
+                "statsDefinition": "modelled"
+            }
+        ]
+    },
+    "LOOKUPS": {
+        "emission": [
+            "akagiEtAl2011CropResidueBurningFactor",
+            "akagiEtAl2011CropResidueBurningFactor-sd"
+        ]
+    }
+}

package/json_models/akagiEtAl2011/pm25ToAirCropResidueBurning.py.json

@@ -0,0 +1,35 @@
+{
+    "REQUIREMENTS": {
+        "Cycle": {
+            "or": {
+                "products": [
+                    {
+                        "@type": "Product",
+                        "term.@id": [
+                            "aboveGroundCropResidueBurnt",
+                            "discardedCropBurnt"
+                        ],
+                        "value": ""
+                    }
+                ],
+                "completeness.cropResidue": "True"
+            }
+        }
+    },
+    "RETURNS": {
+        "Emission": [
+            {
+                "value": "",
+                "sd": "",
+                "methodTier": "tier 1",
+                "statsDefinition": "modelled"
+            }
+        ]
+    },
+    "LOOKUPS": {
+        "emission": [
+            "akagiEtAl2011CropResidueBurningFactor",
+            "akagiEtAl2011CropResidueBurningFactor-sd"
+        ]
+    }
+}

package/json_models/akagiEtAl2011/so2ToAirCropResidueBurning.py.json

@@ -0,0 +1,35 @@
+{
+    "REQUIREMENTS": {
+        "Cycle": {
+            "or": {
+                "products": [
+                    {
+                        "@type": "Product",
+                        "term.@id": [
+                            "aboveGroundCropResidueBurnt",
+                            "discardedCropBurnt"
+                        ],
+                        "value": ""
+                    }
+                ],
+                "completeness.cropResidue": "True"
+            }
+        }
+    },
+    "RETURNS": {
+        "Emission": [
+            {
+                "value": "",
+                "sd": "",
+                "methodTier": "tier 1",
+                "statsDefinition": "modelled"
+            }
+        ]
+    },
+    "LOOKUPS": {
+        "emission": [
+            "akagiEtAl2011CropResidueBurningFactor",
+            "akagiEtAl2011CropResidueBurningFactor-sd"
+        ]
+    }
+}

package/json_models/aware/scarcityWeightedWaterUse.py.json

@@ -0,0 +1,45 @@
+{
+    "REQUIREMENTS": {
+        "ImpactAssessment": {
+            "site": {
+                "@type": "Site",
+                "or": {
+                    "awareWaterBasinId": "",
+                    "country": {
+                        "@type": "Term",
+                        "termType": "region"
+                    }
+                }
+            },
+            "optional": {
+                "emissionsResourceUse": [
+                    {
+                        "@type": "Indicator",
+                        "term.@id": "freshwaterWithdrawalsDuringCycle",
+                        "value": ""
+                    }
+                ]
+            }
+        }
+    },
+    "RETURNS": {
+        "Indicator": [
+            {
+                "value": ""
+            }
+        ]
+    },
+    "LOOKUPS": {
+        "@doc": "Different lookup files are used depending on the situation",
+        "awareWaterBasinId": [
+            "YR_IRRI",
+            "YR_NONIRRI",
+            "YR_TOT"
+        ],
+        "region-aware-factors": [
+            "Agg_CF_irri",
+            "Agg_CF_non_irri",
+            "Agg_CF_unspecified"
+        ]
+    }
+}

package/json_models/aware2_0/scarcityWeightedWaterUse.py.json

@@ -0,0 +1,45 @@
+{
+    "REQUIREMENTS": {
+        "ImpactAssessment": {
+            "site": {
+                "@type": "Site",
+                "or": {
+                    "awareWaterBasinId": "",
+                    "country": {
+                        "@type": "Term",
+                        "termType": "region"
+                    }
+                }
+            },
+            "optional": {
+                "emissionsResourceUse": [
+                    {
+                        "@type": "Indicator",
+                        "term.@id": "freshwaterWithdrawalsDuringCycle",
+                        "value": ""
+                    }
+                ]
+            }
+        }
+    },
+    "RETURNS": {
+        "Indicator": [
+            {
+                "value": ""
+            }
+        ]
+    },
+    "LOOKUPS": {
+        "@doc": "Different lookup files are used depending on the situation",
+        "awareWaterBasinId-2-0": [
+            "CFs_agri",
+            "CFs_nonagri",
+            "CFs_unspecified"
+        ],
+        "region-aware-2-0-factors": [
+            "CFs_agri",
+            "CFs_nonagri",
+            "CFs_unspecified"
+        ]
+    }
+}