@hestia-earth/glossary 0.53.0 → 0.54.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -2,6 +2,59 @@
2
2
 
3
3
  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.
4
4
 
5
+ ## [0.54.0](https://gitlab.com/hestia-earth/hestia-glossary/compare/v0.53.1...v0.54.0) (2024-09-03)
6
+
7
+
8
+ ### ⚠ BREAKING CHANGES
9
+
10
+ * **landUseManagement:** Renames `Short fallow period` to
11
+ `Short fallow duration` for consistency with other terms in the glossary.
12
+ * **landUseManagement:** Renames `Long fallow period` to
13
+ `Long fallow duration` for consistency with other terms in the glossary.
14
+ * **landUseManagement:** Deletes term `Previous product`. Information
15
+ describing the previous product should be added to Site Management.
16
+
17
+ ### Features
18
+
19
+ * **characterisedIndicator:** add `Soil quality index` for PEF and LANCA ([d4af722](https://gitlab.com/hestia-earth/hestia-glossary/commit/d4af7229a191453a8ca6d77eb9a1b5a474fa579d))
20
+ * **crop:** upate property lookup ([cc56429](https://gitlab.com/hestia-earth/hestia-glossary/commit/cc56429068760abee6e754b665b6e2815ee01052))
21
+ * **crop:** update properties for `grassCloverMixtureHay` and `grassCloverMixtureSilage` ([19e7435](https://gitlab.com/hestia-earth/hestia-glossary/commit/19e7435f39b83a6f3bca4b0b159e5732d845e1d2))
22
+ * **emission:** ozoneDepletionPotential lookup ([937c5ae](https://gitlab.com/hestia-earth/hestia-glossary/commit/937c5aebec760998e1481971aa504dd61961cf4f)), closes [#1459](https://gitlab.com/hestia-earth/hestia-glossary/issues/1459)
23
+ * **fertiliserBrandName:** add 48 new terms from FCC ([c491907](https://gitlab.com/hestia-earth/hestia-glossary/commit/c491907985181c7cff161de5834e0d94ff9d03d1))
24
+ * **landCover:** add missing `siteTypesAllowed` ([dc0db8c](https://gitlab.com/hestia-earth/hestia-glossary/commit/dc0db8c19df096a24a1671ed2566ffd790665a2e)), closes [#1456](https://gitlab.com/hestia-earth/hestia-glossary/issues/1456)
25
+ * **landCover:** add new lookup `BIOMASS_CATEGORY` for biomass carbon stock modelling ([2c0ba61](https://gitlab.com/hestia-earth/hestia-glossary/commit/2c0ba61ffc82c64b02b0e45dd75f39619f2ba5e7))
26
+ * **landUseManagement:** delete `Crop rotation` and `Aquaculture rotation` ([fb21675](https://gitlab.com/hestia-earth/hestia-glossary/commit/fb216752748afb94caafd4805e41dec3cba40879))
27
+ * **landUseManagement:** delete `Previous product` ([41bf2b3](https://gitlab.com/hestia-earth/hestia-glossary/commit/41bf2b36cdb4b56753f98a57beb5ca4773ccccd5))
28
+ * **model:** add `Fantke et al (2016)` ([8657b5e](https://gitlab.com/hestia-earth/hestia-glossary/commit/8657b5e3b7e5af222d87e6ba62602819ada3571b))
29
+ * **operation:** add `Moving temporary fencing` ([21cb9d2](https://gitlab.com/hestia-earth/hestia-glossary/commit/21cb9d2435c420e01685943c6ed8d6537723728c)), closes [#1467](https://gitlab.com/hestia-earth/hestia-glossary/issues/1467)
30
+ * **operation:** add coffee processing terms ([4205307](https://gitlab.com/hestia-earth/hestia-glossary/commit/4205307ad6d6d0fb08405f67580979f933c4abb9)), closes [#1473](https://gitlab.com/hestia-earth/hestia-glossary/issues/1473)
31
+ * **region:** add `crop-cropGroupingFaostatProduction-areaHarvested` lookup ([8c1be16](https://gitlab.com/hestia-earth/hestia-glossary/commit/8c1be167c6439b7407c60b2dc65920db38787de8))
32
+ * **region:** rename `faostatCroplandArea` lookup to `faostatArea` and add more items ([cd553f5](https://gitlab.com/hestia-earth/hestia-glossary/commit/cd553f5edaa1013db3829b0a7439e28fb7cb1e97))
33
+ * **region:** update FAOSTAT lookups ([7a18d1f](https://gitlab.com/hestia-earth/hestia-glossary/commit/7a18d1fd5d3d56a50582102c8e82a0b58217e7b0))
34
+
35
+
36
+ ### Bug Fixes
37
+
38
+ * **landCover:** errors in `siteTypesAllowed` and `subClassOf` ([30af231](https://gitlab.com/hestia-earth/hestia-glossary/commit/30af231a78114cced0e86a67910035fec9e44727)), closes [#1456](https://gitlab.com/hestia-earth/hestia-glossary/issues/1456)
39
+ * **landUseManagement:** rename `Long fallow period` to `Long fallow duration` ([b0badda](https://gitlab.com/hestia-earth/hestia-glossary/commit/b0badda2972f5f26a83fe267849eb8dde371dc5b))
40
+ * **landUseManagement:** rename `Short fallow period` to `Short fallow duration` ([2553ada](https://gitlab.com/hestia-earth/hestia-glossary/commit/2553ada43d3a7176b2ca008716353cd52ba7da95))
41
+
42
+ ### [0.53.1](https://gitlab.com/hestia-earth/hestia-glossary/compare/v0.53.0...v0.53.1) (2024-08-19)
43
+
44
+
45
+ ### Features
46
+
47
+ * **landUseManagement:** change `arrayTreatment` on `Pasture grass` to `sum` ([ca45a2e](https://gitlab.com/hestia-earth/hestia-glossary/commit/ca45a2e4e9fe174fed65795a7a5239a053a9b87c)), closes [#1431](https://gitlab.com/hestia-earth/hestia-glossary/issues/1431)
48
+ * **liveAnimal:** add PM and TSP lookups ([73155c1](https://gitlab.com/hestia-earth/hestia-glossary/commit/73155c1247569ec87dc0325be1733fdd3f8c941e))
49
+ * **measurement:** add new term `belowGroundBiomass` to glossary ([6b23802](https://gitlab.com/hestia-earth/hestia-glossary/commit/6b238028b55dcebf455c88eefeb50bfe8b6b1c4d))
50
+
51
+
52
+ ### Bug Fixes
53
+
54
+ * **inorganicFertiliser:** error in `Nitrogen content` of `Nitric acid` ([1593bb9](https://gitlab.com/hestia-earth/hestia-glossary/commit/1593bb9dcde97ff69f151cda9e2349f91e6a3ea4)), closes [#1444](https://gitlab.com/hestia-earth/hestia-glossary/issues/1444)
55
+ * **region:** change `Laos` `subClassOf` to `region-south-eastern-asia` ([38fdefd](https://gitlab.com/hestia-earth/hestia-glossary/commit/38fdefd12ceb08bd44fee89ec3ef77a7bb1cd16d)), closes [#1454](https://gitlab.com/hestia-earth/hestia-glossary/issues/1454)
56
+ * **region:** update `area` for level 0 regions ([e9882c5](https://gitlab.com/hestia-earth/hestia-glossary/commit/e9882c5fb7f1f3ef735ac416042e0da2b66ac4e0))
57
+
5
58
  ## [0.53.0](https://gitlab.com/hestia-earth/hestia-glossary/compare/v0.52.0...v0.53.0) (2024-08-06)
6
59
 
7
60
 
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
- # Hestia Glossary
1
+ # HESTIA Glossary
2
2
 
3
- Describing data consistently with the same terms makes data exchange possible. Hestia maintains a [Glossary of Terms](https://hestia.earth/glossary) to describe the agri-food system. Only these Terms can be used to describe data.
3
+ Describing data consistently with the same terms makes data exchange possible. HESTIA maintains a [Glossary of Terms](https://hestia.earth/glossary) to describe the agri-food system. Only these Terms can be used to describe data.
4
4
 
5
5
  Terms are created or amended as follows:
6
6
 
7
7
  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.
8
8
 
9
- 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.
9
+ 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.
10
10
 
11
11
  3) Each row of the Excel file is converted into a JSON-LD file following the schema for the Term.
12
12
 
package/index.js CHANGED
@@ -10,25 +10,25 @@ const loadResource = filename => require(`./resources/${filename}`);
10
10
  const loadResourceKey = (filename, key) => loadResource(filename)[key];
11
11
 
12
12
  /**
13
- * Converts the iso31662 code to the [term.name](https://hestia.earth/schema/Term#name) from the Hestia Glossary.
13
+ * Converts the iso31662 code to the [term.name](https://hestia.earth/schema/Term#name) from the HESTIA Glossary.
14
14
  *
15
15
  * @param {string} code The [iso31662 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
16
- * @returns {string} The Hestia country [name](https://hestia.earth/schema/Term#name).
16
+ * @returns {string} The HESTIA country [name](https://hestia.earth/schema/Term#name).
17
17
  */
18
18
  const iso31662ToName = (code = '') => loadResourceKey('iso3166-2-to-name.json', code.toUpperCase());
19
19
 
20
20
  /**
21
- * Converts the iso31662 code to the [term.id](https://hestia.earth/schema/Term#id) from the Hestia Glossary.
21
+ * Converts the iso31662 code to the [term.id](https://hestia.earth/schema/Term#id) from the HESTIA Glossary.
22
22
  *
23
23
  * @param {string} code The [iso31662 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
24
- * @returns {string} The Hestia country [id](https://hestia.earth/schema/Term#id).
24
+ * @returns {string} The HESTIA country [id](https://hestia.earth/schema/Term#id).
25
25
  */
26
26
  const iso31662ToId = (code = '') => loadResourceKey('iso3166-2-to-id.json', code.toUpperCase());
27
27
 
28
28
  /**
29
- * Converts the [term.id](https://hestia.earth/schema/Term#id) from the Hestia Glossary to a iso31662 code.
29
+ * Converts the [term.id](https://hestia.earth/schema/Term#id) from the HESTIA Glossary to a iso31662 code.
30
30
  *
31
- * @param {string} id The Hestia country [id](https://hestia.earth/schema/Term#id).
31
+ * @param {string} id The HESTIA country [id](https://hestia.earth/schema/Term#id).
32
32
  * @returns {string} The [iso31662 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
33
33
  */
34
34
  const idToIso31662 = (id = '') => loadResourceKey('id-to-iso3166-2.json', id.toUpperCase());
@@ -36,7 +36,7 @@ const idToIso31662 = (id = '') => loadResourceKey('id-to-iso3166-2.json', id.toU
36
36
  /**
37
37
  * Determines how an array of values should be handled (if summed up, or averaged, etc.).
38
38
  *
39
- * @param {string} id The Hestia term [id](https://hestia.earth/schema/Term#id).
39
+ * @param {string} id The HESTIA term [id](https://hestia.earth/schema/Term#id).
40
40
  * @returns {string} Possible values are: `mean`, `mode` and `sum`.
41
41
  */
42
42
  const getArrayTreatment = (id) => loadResourceKey('arrayTreatment.json', id) || 'sum';
@@ -44,7 +44,7 @@ const getArrayTreatment = (id) => loadResourceKey('arrayTreatment.json', id) ||
44
44
  /**
45
45
  * Returns the `@id` of the default model that should be used for display of this Term.
46
46
  *
47
- * @param {string} id The Hestia term [id](https://hestia.earth/schema/Term#id).
47
+ * @param {string} id The HESTIA term [id](https://hestia.earth/schema/Term#id).
48
48
  * @returns {string} The `@id` of the model if set.
49
49
  */
50
50
  const getDefaultModelId = (id) => loadResourceKey('defaultModelId.json', id);
@@ -52,7 +52,7 @@ const getDefaultModelId = (id) => loadResourceKey('defaultModelId.json', id);
52
52
  /**
53
53
  * Returns the list of `@id` of the default models that should be used for display.
54
54
  *
55
- * @param {string} id The Hestia term [id](https://hestia.earth/schema/Term#id).
55
+ * @param {string} id The HESTIA term [id](https://hestia.earth/schema/Term#id).
56
56
  * @returns {string[]} The list of default `@id`.
57
57
  */
58
58
  const getDefaultModels = () => Object.entries(loadResource('defaultModelId.json')).filter(([key, value]) => !!value).map(([key]) => key);
@@ -60,7 +60,7 @@ const getDefaultModels = () => Object.entries(loadResource('defaultModelId.json'
60
60
  /**
61
61
  * Returns the list of restrictions of the Term.
62
62
  *
63
- * @param {string} id The Hestia term [id](https://hestia.earth/schema/Term#id).
63
+ * @param {string} id The HESTIA term [id](https://hestia.earth/schema/Term#id).
64
64
  * @returns A list of restrictions as an object.
65
65
  */
66
66
  const getTermRestrictions = (id) => loadResourceKey('term-restrictions.json', id);
@@ -68,20 +68,20 @@ const getTermRestrictions = (id) => loadResourceKey('term-restrictions.json', id
68
68
  /**
69
69
  * Returns the list of restrictions of the Term/Model mapping.
70
70
  *
71
- * @param {string} id The Hestia term [id](https://hestia.earth/schema/Term#id).
72
- * @param {string} modelId The Hestia term [id](https://hestia.earth/schema/Term#id).
71
+ * @param {string} id The HESTIA term [id](https://hestia.earth/schema/Term#id).
72
+ * @param {string} modelId The HESTIA term [id](https://hestia.earth/schema/Term#id).
73
73
  * @returns A list of restrictions as an object.
74
74
  */
75
75
  const getTermModelRestrictions = (id, modelId) => (loadResourceKey('term-restrictions.json', id) || {})[modelId];
76
76
 
77
77
  /**
78
- * Checks whether the emission is in the Hestia System Boundary.
78
+ * Checks whether the emission is in the HESTIA System Boundary.
79
79
  *
80
- * @param {string} id The Hestia term [id](https://hestia.earth/schema/Term#id).
80
+ * @param {string} id The HESTIA term [id](https://hestia.earth/schema/Term#id).
81
81
  * @returns {boolean} True if the Term is included.
82
82
  */
83
83
  const isInSystemBoundary = (id) => {
84
- const value = loadResourceKey('inHestiaDefaultSystemBoundary.json', id);
84
+ const value = loadResourceKey('inHESTIADefaultSystemBoundary.json', id);
85
85
  return !value || value === 'true';
86
86
  };
87
87
 
package/lookups/README.md CHANGED
Binary file
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@hestia-earth/glossary",
3
- "version": "0.53.0",
4
- "description": "Hestia Earth Glossary library",
3
+ "version": "0.54.0",
4
+ "description": "HESTIA Earth Glossary library",
5
5
  "main": "index.js",
6
6
  "scripts": {
7
7
  "test": "echo \"Error: no test specified\" && exit 1",
@@ -620,21 +620,17 @@
620
620
  "woollyFingerGrassPlant": "mean",
621
621
  "yellowThatchingGrassPlant": "mean",
622
622
  "chineseRyeGrassPlant": "mean",
623
+ "nurseryDuration": "mean",
624
+ "nurseryDensity": "mean",
625
+ "croppingDuration": "mean",
626
+ "shortFallowDuration": "mean",
627
+ "rotationDuration": "mean",
628
+ "longFallowRatio": "mean",
629
+ "longFallowDuration": "mean",
623
630
  "croppingIntensity": "mean",
624
- "practiceFactor": "mean",
625
631
  "multiCropped": "mean",
626
632
  "doubleCropped": "mean",
627
633
  "tripleCropped": "mean",
628
- "croppingDuration": "mean",
629
- "shortFallowPeriod": "mean",
630
- "longFallowRatio": "mean",
631
- "longFallowPeriod": "mean",
632
- "nurseryDuration": "mean",
633
- "nurseryDensity": "mean",
634
- "cropRotation": "mode",
635
- "aquacultureRotation": "mode",
636
- "previousProduct": "mode",
637
- "rotationDuration": "mean",
638
634
  "intercropping": "mean",
639
635
  "mixedIntercropping": "mean",
640
636
  "rowCropping": "mean",
@@ -656,7 +652,7 @@
656
652
  "canopyCoverShadeTrees": "mean",
657
653
  "shadeTreeSpecies": "mode",
658
654
  "shadeTreeSpacing": "mean",
659
- "pastureGrass": "mean",
655
+ "pastureGrass": "sum",
660
656
  "continuousGrazing": "mean",
661
657
  "rotationalGrazing": "mean",
662
658
  "canopyCoverPasture": "mean",
@@ -688,6 +684,7 @@
688
684
  "floodedPreSeasonMoreThan30Days": "mean",
689
685
  "nonFloodedPreSeasonMoreThan365Days": "mean",
690
686
  "unknownPreSeasonWaterRegime": "mean",
687
+ "practiceFactor": "mean",
691
688
  "altitude": "arrayNotAllowed",
692
689
  "slopeLength": "arrayNotAllowed",
693
690
  "slope": "arrayNotAllowed",
@@ -1030,6 +1027,7 @@
1030
1027
  "soilSaturatedHydraulicConductivity": "mean",
1031
1028
  "rootBiomass": "mean",
1032
1029
  "aboveGroundBiomass": "mean",
1030
+ "belowGroundBiomass": "mean",
1033
1031
  "leafLitterBiomass": "mean",
1034
1032
  "waterDepth": "mean",
1035
1033
  "slowFlowingWater": "arrayNotAllowed",
@@ -13,6 +13,9 @@
13
13
  "biodiversityLossTotalLandUseEffects": "chaudharyBrooks2018",
14
14
  "biodiversityLossLandOccupation": "chaudharyBrooks2018",
15
15
  "biodiversityLossLandTransformation": "chaudharyBrooks2018",
16
+ "soilQualityIndexTotalLandUseEffects": "lanca",
17
+ "soilQualityIndexLandOccupation": "lanca",
18
+ "soilQualityIndexLandTransformation": "lanca",
16
19
  "bioticProductionTotalLandUseEffects": "lanca",
17
20
  "bioticProductionLandOccupation": "lanca",
18
21
  "bioticProductionLandTransformation": "lanca",
@@ -507,6 +507,54 @@
507
507
  "greenBee",
508
508
  "granulockZ",
509
509
  "granulockSs",
510
+ "yarabelaAxan",
511
+ "yaramila151515",
512
+ "bunn33N33So3",
513
+ "origin33N30So3",
514
+ "origin38N19So3",
515
+ "origin40N14So3",
516
+ "yaravera",
517
+ "yarauan",
518
+ "cfDoubletop",
519
+ "cfNkSulphur",
520
+ "cfKaynitroSulphur",
521
+ "cfHeartlandSulphur",
522
+ "cfSwardsman",
523
+ "cf201010",
524
+ "originCan",
525
+ "origin1414217So3002B",
526
+ "origin1616167So3002B",
527
+ "origin1010207So3002B",
528
+ "bunn10182410So3",
529
+ "bunn1313218So3",
530
+ "bunn209975So3",
531
+ "bunn2401475So3",
532
+ "bunn27N30So3",
533
+ "bunn38N19So3",
534
+ "bunn825255So3",
535
+ "bunnKan",
536
+ "bunnKanPlus29017195So3",
537
+ "bunnKanPlus31N195So3",
538
+ "bunnKanPlus33N30So3",
539
+ "bunnKanPlus38N19So3",
540
+ "cfCutGraze",
541
+ "cfEarlybite",
542
+ "cfNumberFour",
543
+ "cfNumberSeven",
544
+ "cfSulphurGold",
545
+ "cropkare",
546
+ "crystalGreen",
547
+ "fibrophos",
548
+ "iclPhosphateplus",
549
+ "iclPotashplus",
550
+ "kornKali",
551
+ "mzExceleratorGt",
552
+ "originAsn26",
553
+ "originMaxiMaize",
554
+ "originOsn17",
555
+ "originOsn35",
556
+ "pGrow",
557
+ "primaryP",
510
558
  "anthracite",
511
559
  "cokingCoal",
512
560
  "otherBituminousCoal",