@hestia-earth/glossary 0.4.2 → 0.5.0

package/CHANGELOG.md

@@ -2,6 +2,80 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [0.5.0](https://gitlab.com/hestia-earth/hestia-glossary/compare/v0.4.2...v0.5.0) (2022-07-12)
+
+
+### ⚠ BREAKING CHANGES
+
+* **measurement:** renamed
+`availableNitrogenPerKgSoil` to `plantAvailableNitrogenPerKgSoil`
+`availablePhosphorusPerKgSoil` to `plantAvailablePhosphorusPerKgSoil`
+`availableNitrogenPerM3Soil` to `plantAvailableNitrogenPerM3Soil`
+`availablePhosphorusPerM3Soil` to `plantAvailablePhosphorusPerM3Soil`
+* **measurement:** `phosphorusPerKgSoil` renamed to `totalPhosphorusPerKgSoil`,
+`phosphorusPerM3Soil` renamed to `totalPhosphorusPerM3Soil`
+* **measurement:** `phosphatePerM3Soil` and `phosphatePerKgSoil` have been removed
+
+### Features
+
+* add `siteTypesAllowed` to remaining practice terms ([7871b5a](https://gitlab.com/hestia-earth/hestia-glossary/commit/7871b5a2ca9c94d071fd7eaab822554790995d56)), closes [#409](https://gitlab.com/hestia-earth/hestia-glossary/issues/409)
+* add `Tjurin method` ([d857008](https://gitlab.com/hestia-earth/hestia-glossary/commit/d8570085a61d7241cb8e529d15c6d006b0c92afd))
+* add ecoregion/region-siteType lookups for land stress LC-Impact ([fe38abf](https://gitlab.com/hestia-earth/hestia-glossary/commit/fe38abf3e55d98aed8c107380bcf9609812e35d5))
+* **characterisedIndicator:** add LC-impact climate change indicators ([73b8098](https://gitlab.com/hestia-earth/hestia-glossary/commit/73b80980af444f831c35869fdb6a0e4c2cf2b9fb)), closes [#400](https://gitlab.com/hestia-earth/hestia-glossary/issues/400)
+* **characterisedIndicator:** add LC-Impact Eutrophication indicators ([7fa08f6](https://gitlab.com/hestia-earth/hestia-glossary/commit/7fa08f6fb7b34aa17617155f2d579463fe15dd78)), closes [#418](https://gitlab.com/hestia-earth/hestia-glossary/issues/418) [#420](https://gitlab.com/hestia-earth/hestia-glossary/issues/420)
+* **characterisedIndicator:** add LC-impact ozone depletion indicators ([5968afd](https://gitlab.com/hestia-earth/hestia-glossary/commit/5968afd21a0829d7483d16bc717ab11f963767c4)), closes [#411](https://gitlab.com/hestia-earth/hestia-glossary/issues/411)
+* **characterisedIndicator:** add LC-Impact Ozone Formation CFs ([07c5df4](https://gitlab.com/hestia-earth/hestia-glossary/commit/07c5df48a88327dada8e0e28a30721cd9c06aa3e))
+* **characterisedIndicator:** add LC-Impact PM formation and acidification indicators ([065ea1a](https://gitlab.com/hestia-earth/hestia-glossary/commit/065ea1a554b034b1db701fdc69c56ec2c6f8c402)), closes [#416](https://gitlab.com/hestia-earth/hestia-glossary/issues/416) [#417](https://gitlab.com/hestia-earth/hestia-glossary/issues/417)
+* **characterisedIndicator:** add LC-Impact toxicity indicators ([f67fb15](https://gitlab.com/hestia-earth/hestia-glossary/commit/f67fb154d75ba43f48c18c0db52f92182de226d0)), closes [#421](https://gitlab.com/hestia-earth/hestia-glossary/issues/421) [#426](https://gitlab.com/hestia-earth/hestia-glossary/issues/426)
+* **crop:** add `Pea, plants` ([506171b](https://gitlab.com/hestia-earth/hestia-glossary/commit/506171b48ac7ffad2bcfa789d94e5878f4049d6b))
+* **crop:** add `possibleCoverCrop` lookup ([6bc27d4](https://gitlab.com/hestia-earth/hestia-glossary/commit/6bc27d4544ed4f3b127df5933e02ca77afd44eae))
+* **crop:** add `teff, hay` and `teff, straw` and rename `teff` ([f7e635d](https://gitlab.com/hestia-earth/hestia-glossary/commit/f7e635dfc3d1c67909804f2bfdeae5e9e31432f3)), closes [#202](https://gitlab.com/hestia-earth/hestia-glossary/issues/202)
+* **crop:** add sudangrass and sisal terms ([cc7af9e](https://gitlab.com/hestia-earth/hestia-glossary/commit/cc7af9e029a07f96d4cfa34533fdd935ac04cf5b))
+* **cropResidue:** add `possibleCoverCrop` lookup ([3a5865e](https://gitlab.com/hestia-earth/hestia-glossary/commit/3a5865ef39ec9a3b6fb73ae3949da635e5326ee4))
+* **cropResidue:** add `siteTypesAllowed` ([4e14215](https://gitlab.com/hestia-earth/hestia-glossary/commit/4e142150782b58bf369032b1ffebff71b444d613))
+* **emission:** add LC-Impact Climate Change CFs ([2d4d5fe](https://gitlab.com/hestia-earth/hestia-glossary/commit/2d4d5fec91a992a4de65a227076994a41d565c49)), closes [#400](https://gitlab.com/hestia-earth/hestia-glossary/issues/400)
+* **emission:** add LC-Impact Ozone Depletion CFs ([0b6bfbb](https://gitlab.com/hestia-earth/hestia-glossary/commit/0b6bfbba4b1a769764f13a5716388de75252c842)), closes [#411](https://gitlab.com/hestia-earth/hestia-glossary/issues/411)
+* **emission:** make `productTermTypesAllowed` less restrictive ([1ad9ac5](https://gitlab.com/hestia-earth/hestia-glossary/commit/1ad9ac51d320e4357ef04023a853c39d54b687f7))
+* **endpointIndicator:** add LC-Impact endpoints ([9fa6fa5](https://gitlab.com/hestia-earth/hestia-glossary/commit/9fa6fa5913701725bb681617f9460e22be54fb1f)), closes [#407](https://gitlab.com/hestia-earth/hestia-glossary/issues/407)
+* **endpointIndicator:** rename ReCiPe endpoints ([dc3604b](https://gitlab.com/hestia-earth/hestia-glossary/commit/dc3604beba8fa1c0fa4dea138faac4d83e83a459))
+* **excreta:** add lookup colour coding and `dataState` ([5a715ae](https://gitlab.com/hestia-earth/hestia-glossary/commit/5a715ae7c17f1a55726ca1bbb939455bfe1d0e27)), closes [#344](https://gitlab.com/hestia-earth/hestia-glossary/issues/344)
+* **fuel:** change unit from `m3` to `kg` for `Liquefied petroleum gases (LPG)` ([3398c26](https://gitlab.com/hestia-earth/hestia-glossary/commit/3398c267080bcb872ad5372f2d75324758c5e479)), closes [#363](https://gitlab.com/hestia-earth/hestia-glossary/issues/363)
+* **grass:** add property lookup ([a629df0](https://gitlab.com/hestia-earth/hestia-glossary/commit/a629df0387fa1e65d94c0ed3ed59c99338cfb46f))
+* **grass:** create grass glossary ([2050c75](https://gitlab.com/hestia-earth/hestia-glossary/commit/2050c75dc2d24362cda4c0b35cd42324510768a4)), closes [#399](https://gitlab.com/hestia-earth/hestia-glossary/issues/399)
+* **landUseManagement:** add `number of hives` from biodiversity glossary ([b1fe245](https://gitlab.com/hestia-earth/hestia-glossary/commit/b1fe2459f161cedf97f0a07323fc25ebce292315))
+* **landUseManagement:** add term `Cover crop` ([2f334bb](https://gitlab.com/hestia-earth/hestia-glossary/commit/2f334bb17b477a1f7acd059919cea021f4fb250d))
+* **liveAnimal:** add lookup colour coding and `dataState` ([f85929c](https://gitlab.com/hestia-earth/hestia-glossary/commit/f85929c4298797f2c9c87e9098a9fe9bde0bd8bf)), closes [#344](https://gitlab.com/hestia-earth/hestia-glossary/issues/344)
+* **measurement:** add `soil solution P` as synonym for `Available phosphorus` ([61903dd](https://gitlab.com/hestia-earth/hestia-glossary/commit/61903ddb08e75390ebe524ac9f160e47dcd15efe)), closes [#428](https://gitlab.com/hestia-earth/hestia-glossary/issues/428)
+* **measurement:** add `subClassOf` to soil measurements ([a3a8c95](https://gitlab.com/hestia-earth/hestia-glossary/commit/a3a8c9553221acca016a11a42d7e3155a5246255))
+* **measurement:** add additional soil phosphorus terms and create hierarchy ([c49fcaa](https://gitlab.com/hestia-earth/hestia-glossary/commit/c49fcaae333aad7e33171ecca1c6d00fe1b61f6a)), closes [#428](https://gitlab.com/hestia-earth/hestia-glossary/issues/428)
+* **measurement:** delete soil phosphate terms ([fe4634e](https://gitlab.com/hestia-earth/hestia-glossary/commit/fe4634e2c7667a703d7617a9688ff67088c5d579)), closes [#428](https://gitlab.com/hestia-earth/hestia-glossary/issues/428)
+* **measurement:** improve definition of `Available phosphorus...` terms ([a8a86b3](https://gitlab.com/hestia-earth/hestia-glossary/commit/a8a86b3eb250236cb0b680464d487ad352f0f581)), closes [#428](https://gitlab.com/hestia-earth/hestia-glossary/issues/428)
+* **measurement:** rename `Phosphorus (per...` to `Total phosphorus (per...` ([83c17f8](https://gitlab.com/hestia-earth/hestia-glossary/commit/83c17f8edb337f8c81d8c97b2d61af0b562b0e68)), closes [#428](https://gitlab.com/hestia-earth/hestia-glossary/issues/428)
+* **measurement:** rename all `Available...` terms to `Plant available...` ([c9802c6](https://gitlab.com/hestia-earth/hestia-glossary/commit/c9802c6c78810a374b6f61565ef501ebe3c63693))
+* **methodMeasurement:** add `Tinsley method` and improve synonyms for related terms ([145d77b](https://gitlab.com/hestia-earth/hestia-glossary/commit/145d77b1f034837c5427eb2d6d77f232dad7032f))
+* **methodMeasurement:** add Egner-Riehm method ([18fec26](https://gitlab.com/hestia-earth/hestia-glossary/commit/18fec260054603517861bc20db74e80697c85131))
+* **model:** add LC-Impact models ([2127bed](https://gitlab.com/hestia-earth/hestia-glossary/commit/2127bed50f94ab5bc3c5a4e5a202867e25073584)), closes [#405](https://gitlab.com/hestia-earth/hestia-glossary/issues/405)
+* **model:** delete `LC-Impact` ([c7ecd23](https://gitlab.com/hestia-earth/hestia-glossary/commit/c7ecd23f2f4ca31979bd92c35d847b1e356ec82a))
+* **model:** delete `Other background database` add `Linked Impact Assessment` ([3ee1534](https://gitlab.com/hestia-earth/hestia-glossary/commit/3ee1534f292e3e04066370184462f7cce9cec8d6)), closes [#402](https://gitlab.com/hestia-earth/hestia-glossary/issues/402)
+* **operation:** add `watering animals` and `cleaning animal housing` ([a6141eb](https://gitlab.com/hestia-earth/hestia-glossary/commit/a6141eb0f7ba45558c4dcadfb24b1c1fce1136c7)), closes [#415](https://gitlab.com/hestia-earth/hestia-glossary/issues/415)
+* **operation:** add `watering animals` and `cleaning animal housing` ([c036ed8](https://gitlab.com/hestia-earth/hestia-glossary/commit/c036ed862b52cc44bd87f7f1f422d5559edf92c0)), closes [#415](https://gitlab.com/hestia-earth/hestia-glossary/issues/415)
+* **region:** add  region-MarineEutrophicationLCImpactCF lookup ([9a826df](https://gitlab.com/hestia-earth/hestia-glossary/commit/9a826df6aa01e1470cbff388ff019004fafc02f5)), closes [#418](https://gitlab.com/hestia-earth/hestia-glossary/issues/418)
+* **region:** add LC-Impact water stress CFs to awareWaterBasinId lookup ([7424cd3](https://gitlab.com/hestia-earth/hestia-glossary/commit/7424cd380ea503f2ced212f65a26954cdd3a8933))
+* **region:** add region-FreshwaterEutrophicationLCImpactCF lookup ([c4cb983](https://gitlab.com/hestia-earth/hestia-glossary/commit/c4cb983e9c4819e675430e3c1f0558a2992491f6)), closes [#420](https://gitlab.com/hestia-earth/hestia-glossary/issues/420)
+* **region:** add region-OzoneFormationLCImpactCF lookups ([b0684bf](https://gitlab.com/hestia-earth/hestia-glossary/commit/b0684bf0c2841768bb02a7411076c250471b53bf))
+* **region:** add region-ParticulateMatterFormationLCImpactCF lookup ([2b7d652](https://gitlab.com/hestia-earth/hestia-glossary/commit/2b7d652f4f406b7c23195782480e56e2cc218586)), closes [#416](https://gitlab.com/hestia-earth/hestia-glossary/issues/416)
+* **region:** add region-resourceUse lookups for LC-Impact water stress CFs ([ac9260f](https://gitlab.com/hestia-earth/hestia-glossary/commit/ac9260f387c78402485cff801ee4944560be2d27))
+* **region:** add region-TerrestrialAcidificationLCImpactCF lookup ([b7cd669](https://gitlab.com/hestia-earth/hestia-glossary/commit/b7cd669185f682c0c925bfc92b36ec43114ad443)), closes [#417](https://gitlab.com/hestia-earth/hestia-glossary/issues/417)
+
+
+### Bug Fixes
+
+* **characterisedIndicator:** fix mapping to model `linkedImpactAssessment` ([812683f](https://gitlab.com/hestia-earth/hestia-glossary/commit/812683fa36302baf734d8851ce0623b4bd27415a))
+* **characterisedIndicator:** rename LC-Impact indicators to remove model from name ([51cb68f](https://gitlab.com/hestia-earth/hestia-glossary/commit/51cb68f18d9537f7546c172d4f3388c07fd907a4))
+* **endpointIndicator:** rename ReCiPe and LC-Impact indicators and fix units ([70e09e6](https://gitlab.com/hestia-earth/hestia-glossary/commit/70e09e6c88edb3bb056954271fc2bc702e65d63f))
+* **inorganicFertilizer:** add space in `Calcium metaphosphate (kg P2O5)` term name ([e3c6afb](https://gitlab.com/hestia-earth/hestia-glossary/commit/e3c6afb8409ef3aa049ae6d23bbb42c914f78cd9))
+* **measurement:** set minimum humidity lookup to `0.1` ([7005a27](https://gitlab.com/hestia-earth/hestia-glossary/commit/7005a273d2edda75cbd3284a70df952061b9545e))
+
 ### [0.4.2](https://gitlab.com/hestia-earth/hestia-glossary/compare/v0.4.1...v0.4.2) (2022-06-21)
 
 

package/README.md

@@ -4,7 +4,7 @@ Describing data consistently with the same terms makes data exchange possible. H
 
 Terms are created or amended as follows:
 
-1) Glossaries for each termType are initially created in Excel files. Each column header must either be a field in the schema for Term, or a Property from the Glossary of Terms.
+1) Glossaries for each termType are initially created in Excel files. Each column header must either be a field in the schema for Term, a Property from the Glossary of Terms, or a lookup.
 
 2) To update or change an Excel file, carefully follow the [contribution guidelines](/CONTRIBUTING.md). The Hestia team will review your updates and approve them.
 
@@ -12,6 +12,24 @@ Terms are created or amended as follows:
 
 4) The terms are then indexed, assigned `@id` fields, and are available for use when uploading new data or performing calculations on existing data.
 
+# Properties versus lookups
+
+Properties are data items that describe a Term in more depth or differentiate a Term from another Term. For example, the dry matter of a crop defines the nature of the crop (e.g. whether it is pre-drying, dried, or expressed in dry matter equivalents). Properties can be overridden by the user.
+
+Lookups provide additional information about each Term for use in environmental models. Lookups cannot be overridden by the user.
+
+# Property and lookup colour coding
+
+The data in Properties and lookups can be of variable quality and might be missing. For lookups we indicate this with `dataState`. For both Properties and lookups we also use the following colour coding.
+
+| `dataState`           | Colour      | Definition                                                                  |
+|-----------------------|-------------|-----------------------------------------------------------------------------|
+| `complete`            | Dark green  | The data are complete with no validation issues identified.                 |
+| `not required`        | Dark green  | The data are not required or relevant.                                      |
+| `requires validation` | Light Green | The data require validation due to possible or known errors.                |
+| `missing`             | Pink        | The data are missing and need to be added to run models based on this Term. |
+| `unassigned`          | White       | A data state has not been assigned.                                         |
+
 # Contributing
 
 Please read the [contribution guidelines](/CONTRIBUTING.md) before making contributions to the Glossary of Terms.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hestia-earth/glossary",
-  "version": "0.4.2",
+  "version": "0.5.0",
   "description": "Hestia Earth Glossary library",
   "main": "index.js",
   "scripts": {

package/resources/arrayTreatment.json

@@ -185,12 +185,15 @@
   "dissolvedOrganicNitrogenPerKgSoil": "mean",
   "inorganicNitrogenPerKgSoil": "mean",
   "mineralNitrogenPerKgSoil": "mean",
-  "availableNitrogenPerKgSoil": "mean",
+  "plantAvailableNitrogenPerKgSoil": "mean",
   "nitratePerKgSoil": "mean",
   "ammoniumPerKgSoil": "mean",
-  "phosphorusPerKgSoil": "mean",
-  "phosphatePerKgSoil": "mean",
-  "availablePhosphorusPerKgSoil": "mean",
+  "totalPhosphorusPerKgSoil": "mean",
+  "organicPhosphorusPerKgSoil": "mean",
+  "inorganicPhosphorusPerKgSoil": "mean",
+  "plantAvailablePhosphorusPerKgSoil": "mean",
+  "sorbedPhosphorusPerKgSoil": "mean",
+  "mineralPhosphorusPerKgSoil": "mean",
   "potassiumPerKgSoil": "mean",
   "exchangeablePotassiumPerKgSoil": "mean",
   "calciumPerKgSoil": "mean",
@@ -217,12 +220,15 @@
   "dissolvedOrganicNitrogenPerM3Soil": "mean",
   "inorganicNitrogenPerM3Soil": "mean",
   "mineralNitrogenPerM3Soil": "mean",
-  "availableNitrogenPerM3Soil": "mean",
+  "plantAvailableNitrogenPerM3Soil": "mean",
   "nitratePerM3Soil": "mean",
   "ammoniumPerM3Soil": "mean",
-  "phosphorusPerM3Soil": "mean",
-  "phosphatePerM3Soil": "mean",
-  "availablePhosphorusPerM3Soil": "mean",
+  "totalPhosphorusPerM3Soil": "mean",
+  "organicPhosphorusPerM3Soil": "mean",
+  "inorganicPhosphorusPerM3Soil": "mean",
+  "plantAvailablePhosphorusPerM3Soil": "mean",
+  "sorbedPhosphorusPerM3Soil": "mean",
+  "mineralPhosphorusPerM3Soil": "mean",
   "potassiumPerM3Soil": "mean",
   "exchangeablePotassiumPerM3Soil": "mean",
   "calciumPerM3Soil": "mean",

package/resources/defaultModelId.json

@@ -21,5 +21,24 @@
   "humanCarcinogenicToxicity": "",
   "humanNonCarcinogenicToxicity": "",
   "agriculturalLandOccupationPotential": "",
-  "fineParticulateMatterFormation": ""
+  "fineParticulateMatterFormation": "",
+  "damageToHumanHealthClimateChange": "",
+  "damageToTerrestrialEcosystemsClimateChange": "",
+  "damageToFreshwaterEcosystemsClimateChange": "",
+  "damageToHumanHealthStratosphericOzoneDepletion": "",
+  "damageToHumanHealthPhotochemicalOzoneFormation": "",
+  "damageToTerrestrialEcosystemsPhotochemicalOzoneFormation": "",
+  "damageToHumanHealthParticulateMatterFormation": "",
+  "damageToTerrestrialEcosystemsTerrestrialAcidification": "",
+  "damageToFreshwaterEcosystemsFreshwaterEutrophication": "",
+  "damageToMarineEcosystemsMarineEutrophication": "",
+  "damageToTerrestrialEcosystemsTerrestrialEcotoxicity": "",
+  "damageToFreshwaterEcosystemsFreshwaterEcotoxicity": "",
+  "damageToMarineEcosystemsMarineEcotoxicity": "",
+  "damageToHumanHealthHumanToxicityCancerogenic": "",
+  "damageToHumanHealthHumanToxicityNonCancerogenic": "",
+  "damageToTerrestrialEcosystemsLandOccupation": "",
+  "damageToTerrestrialEcosystemsLandTransformation": "",
+  "damageToHumanHealthWaterStress": "",
+  "damageToFreshwaterEcosystemsWaterStress": ""
 }

package/resources/impactAssessment.json

@@ -49,6 +49,7 @@
     "oatsPlants",
     "oilPalmTrees",
     "ornamentalPlants",
+    "peaPlants",
     "plantain",
     "poroTrees",
     "sweetPotatoPlants",
@@ -61,8 +62,10 @@
     "rubberTrees",
     "ryePlants",
     "sesbanTrees",
+    "sisalPlants",
     "sorghumPlants",
     "soybeanPlants",
+    "sudanGrassPlants",
     "sugarcanePlants",
     "sunflowerPlants",
     "tagasasteTrees",