@hestia-earth/guide 0.0.18 → 0.0.19

package/json_models/schererPfister2015/nErosionSoilFlux.py.json

@@ -6,7 +6,7 @@
                 "inputs": [
                     {
                         "@type": "Input",
-                        "value": "> 0",
+                        "value": ">= 0",
                         "term.termType": "water"
                     }
                 ],
@@ -15,7 +15,7 @@
                     "measurements": [
                         {
                             "@type": "Measurement",
-                            "value": "> 0",
+                            "value": ">= 0",
                             "term.@id": "precipitationAnnual"
                         }
                     ]
@@ -30,32 +30,32 @@
                 "measurements": [
                     {
                         "@type": "Measurement",
-                        "value": "> 0",
+                        "value": ">= 0",
                         "term.@id": "nutrientLossToAquaticEnvironment"
                     },
                     {
                         "@type": "Measurement",
-                        "value": "> 0",
+                        "value": ">= 0",
                         "term.@id": "heavyWinterPrecipitation"
                     },
                     {
                         "@type": "Measurement",
-                        "value": "> 0",
+                        "value": ">= 0",
                         "term.@id": "totalNitrogenPerKgSoil"
                     },
                     {
                         "@type": "Measurement",
-                        "value": "> 0",
+                        "value": ">= 0",
                         "term.@id": "erodibility"
                     },
                     {
                         "@type": "Measurement",
-                        "value": "> 0",
+                        "value": ">= 0",
                         "term.@id": "slopeLength"
                     },
                     {
                         "@type": "Measurement",
-                        "value": "> 0",
+                        "value": ">= 0",
                         "term.@id": "slope"
                     }
                 ]

package/json_models/schererPfister2015/pErosionSoilFlux.py.json

@@ -6,7 +6,7 @@
                 "inputs": [
                     {
                         "@type": "Input",
-                        "value": "> 0",
+                        "value": ">= 0",
                         "term.termType": "water"
                     }
                 ],
@@ -15,7 +15,7 @@
                     "measurements": [
                         {
                             "@type": "Measurement",
-                            "value": "> 0",
+                            "value": ">= 0",
                             "term.@id": "precipitationAnnual"
                         }
                     ]
@@ -30,32 +30,32 @@
                 "measurements": [
                     {
                         "@type": "Measurement",
-                        "value": "> 0",
+                        "value": ">= 0",
                         "term.@id": "nutrientLossToAquaticEnvironment"
                     },
                     {
                         "@type": "Measurement",
-                        "value": "> 0",
+                        "value": ">= 0",
                         "term.@id": "heavyWinterPrecipitation"
                     },
                     {
                         "@type": "Measurement",
-                        "value": "> 0",
+                        "value": ">= 0",
                         "term.@id": "totalPhosphorusPerKgSoil"
                     },
                     {
                         "@type": "Measurement",
-                        "value": "> 0",
+                        "value": ">= 0",
                         "term.@id": "erodibility"
                     },
                     {
                         "@type": "Measurement",
-                        "value": "> 0",
+                        "value": ">= 0",
                         "term.@id": "slopeLength"
                     },
                     {
                         "@type": "Measurement",
-                        "value": "> 0",
+                        "value": ">= 0",
                         "term.@id": "slope"
                     }
                 ]

package/json_models/worldSteel/cycle.py.json

@@ -0,0 +1,36 @@
+{
+    "REQUIREMENTS": {
+        "Cycle": {
+            "inputs": [
+                {
+                    "@type": "Input",
+                    "value": "> 0",
+                    "none": {
+                        "fromCycle": "True",
+                        "producedInCycle": "True"
+                    },
+                    "term.termType": [
+                        "material"
+                    ]
+                }
+            ]
+        }
+    },
+    "RETURNS": {
+        "Emission": [
+            {
+                "term": "",
+                "value": "",
+                "methodTier": "background",
+                "inputs": "",
+                "operation": "",
+                "animals": ""
+            }
+        ]
+    },
+    "LOOKUPS": {
+        "worldSteel-emission": "emission-",
+        "emission": "inputProductionGroupId",
+        "material": "worldsteelMapping"
+    }
+}

package/json_models/worldSteel/impact_assessment.py.json

@@ -0,0 +1,38 @@
+{
+    "REQUIREMENTS": {
+        "ImpactAssessment": {
+            "cycle": {
+                "@type": "Cycle",
+                "inputs": [
+                    {
+                        "@type": "Input",
+                        "value": "> 0",
+                        "none": {
+                            "fromCycle": "True",
+                            "producedInCycle": "True"
+                        },
+                        "term.termType": [
+                            "material"
+                        ]
+                    }
+                ]
+            }
+        }
+    },
+    "RETURNS": {
+        "Indicator": [
+            {
+                "term": "",
+                "value": "",
+                "methodTier": "background",
+                "inputs": "",
+                "operation": ""
+            }
+        ]
+    },
+    "LOOKUPS": {
+        "worldSteel-resourceUse": "resourceUse-",
+        "emission": "inputProductionGroupId",
+        "material": "worldsteelMapping"
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hestia-earth/guide",
-  "version": "0.0.18",
+  "version": "0.0.19",
   "description": "Hestia Guide pages",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",

package/dist/content/guide/applying-models/content.json

@@ -1 +0,0 @@
-{"tags":{},"content":"# Applying Models\n\nLearn how to implement and run various data models for advanced analysis."}

package/dist/content/guide/applying-models/faq.json

@@ -1 +0,0 @@
-{"tags":{},"content":"# FAQs\n\n<div class=\"collapsibles is-medium\">\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">\n      <span>Why does HESTIA have multiple models for each emissions and resource use?</span>\n    </div>\n    <div class=\"collapsible-content\">\n      <p>Different models have different data requirements. In general, more accurate models require more data such as Site Measurements or data on the Practices used. We have generally coded up multiple models at different tiers for the same emission or resource use (see the definitions of tiers in the <a href=\"https://hestia.earth/schema/Emission#methodTier\">schema</a>). We try to run the highest tier model first, and if that fails, try a lower tier model next. This approach means we run an accurate model if possible, but if not, run a less accurate model to calculate as many emissions and resource uses as possible.</p>\n      <p>For example, if a model fails for a Tier 2 emission, we might still be able to calculate the emission using a lesser tier, like Tier 1.</p>\n    </div>\n  </div>\n\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">\n      <span>My Impact Assessment finished recalculating, but there are no emissions or resource use visible. Why?</span>\n    </div>\n    <div class=\"collapsible-content\">\n      <p>If the product of the Impact Assessment has no economic value share, or no value, and HESTIA was not able to gap-fill it, the emissions or resource use will not be calculated.</p>\n      <p>In this case, please look at the Recalculation logs of the products in \"Cycle: Inputs & Products\" section to determine why HESTIA was not able to gap-fill the product fields.</p>\n    </div>\n  </div>\n\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">\n      <span>One of the emission on my Cycle failed to calculate. Why? How can I resolve this?</span>\n    </div>\n    <div class=\"collapsible-content\">\n      <p>Each model has a different set of requirements, which can be viewed in the <a href=\"https://hestia.earth/guide/models\">models documentation</a> for each model. If a requirement is not met, then the model will fail. Sometimes, when some data is missing, we are not able to get a specific lookup used by the model, which means the model will fail.</p>\n      <p>Some steps you can take to understand or fix it:</p>\n      <ul>\n        <li>Make sure all requirements of the model are met in your data. Some of these requirements can be gap-filled, so you can look at those requirements first. We often have models to gap fill these, such as geospatial models to gap fill Site Measurements, so check the results of these gap-fills first.</li>\n        <li>Check the lookups used by the model. Some of these lookups can be missing for the data you are using, in which case they would need to be added to <a href=\"https://gitlab.com/hestia-earth/hestia-glossary/-/issues\">our glossary</a> first.</li>\n        <li>Check the logs of the model, by clicking on the model name in the \"Recalculation logs\" tab. If you see any line that says \"None\" or \"False\", it could indicate something is missing or incorrect.</li>\n        <li>If you are still unable to determine the source of the problem, please log an issue <a href=\"https://gitlab.com/hestia-earth/hestia-engine-models/-/issues\">here</a> for us to rewiew.</li>\n      </ul>\n    </div>\n  </div>\n\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">\n      <span>I have uploaded several cycles on the platform, covering different countries and crops. How do I see which cycle has possible failing emission models?</span>\n    </div>\n    <div class=\"collapsible-content\">\n      <p>Unfortunately at the moment, we do not have any report on failed models at the Cycle or File level, so you will need to review the Cycles one by one to find potential issues.</p>\n    </div>\n  </div>\n</div>"}

package/dist/content/guide/applying-models/file-validation.json

@@ -1 +0,0 @@
-{"tags":{},"content":"# Validate CSV/JSON files\n\nHESTIA provides some functions to validate a CSV / JSON / JSON-LD files formatted following the [HESTIA format](/upload#excelCsv).\n\n## Validating a CSV file\n\nTo validate a CSV file, you will first need to convert it to JSON.\nThis can be done using the HESTIA's `utils` package:\n\n1. Install `NodeJS` version `12` minimum\n2. Install the utils library globally: `npm install --global @hestia-earth/schema-convert`\n3. Drop your CSV files into a specific `folder` then run:\n```bash\nhestia-convert-to-json folder\n```\n\nYou will find in the `folder` the list of CSV files converted to JSON with the `.json` extension.\nThese files can be then used for validation described below.\n\n## Validating the Terms\n\nWhen uploading data on the HESTIA platform, you will need to use our [Glossary of Terms](/glossary).\nYou can follow these steps to install a package to validate the terms:\n\n1. Install `NodeJS` version `12` minimum\n2. Install the utils library globally: `npm install --global @hestia-earth/utils`\n3. Drop your JSON / JSON-LD files into a specific `folder` then run:\n```bash\nhestia-validate-terms folder\n```\n\nErrors will appear in the console if any have been found.\n\n## Validating the Schema\n\nWhen uploading data on the HESTIA platform, you will need to follow our [Schema](/schema).\nYou can follow these steps to install a package to validate the schema:\n\n1. Install `NodeJS` version `12` minimum\n2. Install the schema validation library globally: `npm install --global @hestia-earth/schema-validation`\n3. Drop your JSON / JSON-LD files into a specific `folder` then run:\n```bash\nhestia-validate-jsonld folder\n```\n\nErrors will appear in the console if any have been found.\n\n## Validating the Data\n\nOne important step when uploading data on the HESTIA platform is making sure the data is consistent using the [Data Validation package](https://gitlab.com/hestia-earth/hestia-data-validation).\nYou can follow these steps to install a package to validate the data:\n\n1. Install `Python` version `3` minimum\n2. Install the data validation library: `pip install hestia_earth.validation`\n3. Drop your JSON / JSON-LD files into a specific `folder` then run:\n```bash\nVALIDATE_SPATIAL=false VALIDATE_EXISTING_NODES=true hestia-validate-data folder\n```\n\nErrors will appear in the console if any have been found."}

package/dist/content/guide/applying-models/introduction.json

@@ -1 +0,0 @@
-{"tags":{},"content":"# Introduction\n\nHESTIA provides a set of models for running calculations or retrieving data using external datasets and internal lookups. These models can:\n- Gap fill climate and soil data (e.g., using satellite data).\n- Gap fill farm activity data (e.g., the quantity of crop residue produced).\n- Quantify land use change, on-farm resource use, and on-farm emissions.\n- Quantify the life cycle impacts of products from input production to the farm or processor gate.\n- Quantify indicators like greenhouse gas emissions, eutrophication, and biodiversity impact.\n\n## How to use the models\n\nHESTIA will automatically run all relevant models available, for every data uploaded on the [platform](https://hestia.earth).\n\nIf you would like to find other ways to run the models, outside of the platform, please [click here](https://hestia.earth/calculation/lca-models) to find out more.\n\n## Orchestration\n\nThe models in HESTIA are run using what we call the \"orchestrator\". It is responsible for:\n- Defining the order in which the models are run: to run some emissions, we need to make sure some products are present. Some models, that would gap-fill those products, would need to run before the emission model.\n- Defining the criteria for running the model: some emission and resource use models will not run if the user has added data at a higher tier to the model we have (e.g., measured data, tier 3 modelled data).\n- Defining the criteria for updating the data, based on the result of the model: in some cases, a model can run, but the result will not be used, because an existing value is already present. The orchestrator will therefore \"skip\" the result of the model.\n- Defining the order in which we run the different nodes: the calculations happen in multiple stages, accross the Site, Cycle and ImpactAssessment that are linked together. The order is as follows:\n    1. Run the Site models set for stage 1 calculations;\n    2. Run the Cycle models set for stage 1 calculations;\n    3. Run the Site models set for stage 2 calculations;\n    4. Run the Cycle models set for stage 2 calculations;\n    5. Run the Impact Assessment models set for stage 1 calculations;\n\nThe complete configuration of the models, and how to run them, is defined in the files [here](https://gitlab.com/hestia-earth/hestia-engine-models/-/tree/develop/config)."}

package/dist/content/guide/applying-models/utils.json

@@ -1 +0,0 @@
-{"tags":{},"content":"# HESTIA Utils\n\nThe utils library contains useful functions to work with HESTIA data.\n\n## Pivoting Headers by Terms\n\nAfter downloading data as CSV from the HESTIA platform, the format will look like this:\n\n| site.@id | site.measurements.0.term.@id | site.measurements.0.value | site.measurements.1.term.@id | site.measurements.1.value | site.measurements.2.term.@id | site.measurements.2.value | site.dataPrivate |\n|-----|-----|-----|-----|-----|-----|-----| -----|\n| xvflr | sandContent | 90 | siltContent | 6 | clayContent | 4 | false |\n| gght | sandContent | 90 | siltContent | 6 | clayContent | 4 | false |\n\nIt is possible to pivot some data based on the `term.@id` and move them as columns, such as:\n\n| site.@id | site.measurements.sandContent.value | site.measurements.siltContent.value | site.measurements.clayContent.value | site.dataPrivate |\n| ----- |-----|-----|------| -----|\n| xvflr | 90 | 6 | 4 | false |\n| gght | 90 | 6 | 4 | false |\n\n### Usage\n\n1. Install `Python` version `3` minimum\n2. Install the data validation library: `pip install hestia_earth.utils`\n3. Run:\n```bash\nhestia-pivot-csv source.csv dest.csv\n```\n\nThe `dest.csv` file will be pivoted."}

package/dist/content/models/cycleEmissions/other/co2ToAirLimeHydrolysis/ipcc2019.json

@@ -1 +0,0 @@
-{"tags":{"author":["Guillaume Royer"],"contributor":["Joseph Poore"],"group":["Cycle: Emissions"],"subgroup":["Other"],"tab":["IPCC (2019)"],"modelId":["co2ToAirLimeHydrolysis"],"modelRequires":["soilAmendment"]},"content":"# CO2, to air, lime hydrolysis\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/Emission\">Emissions</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Emission#term\">term</a> with <a href=\"https://hestia.earth/term/co2ToAirLimeHydrolysis\">co2ToAirLimeHydrolysis</a></li>\n<li><a href=\"https://hestia.earth/schema/Emission#methodModel\">methodModel</a> with <a href=\"https://hestia.earth/term/ipcc2019\">ipcc2019</a></li>\n<li><a href=\"https://hestia.earth/schema/Emission#value\">value</a></li>\n<li><a href=\"https://hestia.earth/schema/Emission#methodTier\">methodTier</a> with <code>tier 1</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/Cycle\">Cycle</a> with:<ul>\n<li>a <a href=\"https://hestia.earth/schema/Cycle#site\">site</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Site#siteType\">siteType</a> with <code>cropland</code> <strong>or</strong> <code>glass or high accessible cover</code> <strong>or</strong> <code>permanent pasture</code></li>\n</ul>\n</li>\n<li>Data completeness assessment for soilAmendment: <a href=\"https://hestia.earth/schema/Completeness#soilAmendment\">completeness.soilAmendment</a></li>\n<li>a list of <a href=\"https://hestia.earth/schema/Cycle#inputs\">inputs</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Input#value\">value</a> and <a href=\"https://hestia.earth/schema/Input#term\">term</a> of <a href=\"https://hestia.earth/schema/Term#termType\">termType</a> = <a href=\"https://hestia.earth/glossary?termType=soilAmendment\">soilAmendment</a> and <a href=\"https://hestia.earth/schema/Input#term\">term</a> of <a href=\"https://hestia.earth/schema/Term#units\">units</a> = <code>kg CaCO3</code> <strong>or</strong> <code>kg CaMg(CO3)2</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/emission.csv\">emission.csv</a> -&gt; <code>siteTypesAllowed</code>; <code>typesAllowed</code></li>\n</ul>\n</div>\n  </div>\n  \n</div>"}