@hestia-earth/engine-models 0.82.1 → 0.82.2

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/cjs/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const ENGINE_VERSION = "0.82.1";
1
+ export declare const ENGINE_VERSION = "0.82.2";
package/cjs/version.js CHANGED
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.ENGINE_VERSION = void 0;
4
- exports.ENGINE_VERSION = '0.82.1';
4
+ exports.ENGINE_VERSION = '0.82.2';
package/esm/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const ENGINE_VERSION = "0.82.1";
1
+ export declare const ENGINE_VERSION = "0.82.2";
package/esm/version.js CHANGED
@@ -1 +1 @@
1
- export const ENGINE_VERSION = '0.82.1';
1
+ export const ENGINE_VERSION = '0.82.2';
@@ -177,6 +177,12 @@ Where:
177
177
  - Tag a **named** constant with `` `[const:<value>]` `` (e.g. `ER` → `` `[const:2]` ``):
178
178
  it substitutes to the literal value (rather than rendering as-is) without being
179
179
  logged, and is excluded from coverage.
180
+ - Tag a **documentation-only** symbol with `` `[display]` `` when it genuinely
181
+ can't be substituted and is *not* a constant — e.g. a per-event Monte-Carlo term
182
+ that never reduces to a single logged value. It renders symbolically and is
183
+ excluded from coverage. **Do not** use `` `[const]` `` for a real variable to
184
+ reach coverage: `validate-formula-bindings.js` errors on an empty `` `[const]` ``
185
+ whose symbol isn't a numeric literal.
180
186
 
181
187
  For a `\sum` over inputs, bind each summand symbol to a **table column** with
182
188
  `` `[<table key>:<column>]` `` — the log key of the packed `log_as_table` value
@@ -1882,8 +1882,7 @@
1882
1882
  {
1883
1883
  "symbol": "\\Delta C",
1884
1884
  "description": "the change in carbon stock over year $y$, i.e. $C_y - C_{y-1}$, the difference between the carbon stocks at the end of years $y$ and $y-1$ (kg C ha<sup>-1</sup>).",
1885
- "key": "carbon_stock_inventory",
1886
- "column": "carbon-stock-change"
1885
+ "key": "carbon_stock_change"
1887
1886
  },
1888
1887
  {
1889
1888
  "symbol": "\\frac{44.01}{12.012}",
@@ -1905,8 +1904,7 @@
1905
1904
  {
1906
1905
  "symbol": "\\Delta C",
1907
1906
  "description": "the change in carbon stock over year $y$, i.e. $C_y - C_{y-1}$, the difference between the carbon stocks at the end of years $y$ and $y-1$ (kg C ha<sup>-1</sup>).",
1908
- "key": "carbon_stock_inventory",
1909
- "column": "carbon-stock-change"
1907
+ "key": "carbon_stock_change"
1910
1908
  },
1911
1909
  {
1912
1910
  "symbol": "\\frac{44.01}{12.012}",
@@ -1928,8 +1926,7 @@
1928
1926
  {
1929
1927
  "symbol": "\\Delta C",
1930
1928
  "description": "the change in carbon stock over year $y$, i.e. $C_y - C_{y-1}$, the difference between the carbon stocks at the end of years $y$ and $y-1$ (kg C ha<sup>-1</sup>).",
1931
- "key": "carbon_stock_inventory",
1932
- "column": "carbon-stock-change"
1929
+ "key": "carbon_stock_change"
1933
1930
  },
1934
1931
  {
1935
1932
  "symbol": "\\frac{44.01}{12.012}",
@@ -1941,7 +1938,7 @@
1941
1938
  ],
1942
1939
  "hestia_earth/models/ipcc2019/co2ToAirLimeNeutralisation.md": [
1943
1940
  {
1944
- "formula": "CO_2 = \\sum_{i=1}^{n_{CaCO_3}} M_{CaCO_3,i} \\times EF_{CaCO_3} + \\sum_{j=1}^{n_{dolomite}} M_{dolomite,j} \\times EF_{dolomite}",
1941
+ "formula": "CO_2 = (C_{CaCO_3} + C_{dolomite}) \\times \\frac{44.01}{12.012}",
1945
1942
  "bindings": [
1946
1943
  {
1947
1944
  "symbol": "CO_2",
@@ -1949,34 +1946,19 @@
1949
1946
  "key": "value"
1950
1947
  },
1951
1948
  {
1952
- "symbol": "n_{CaCO_3}",
1953
- "description": "number of limestone (CaCO<sub>3</sub>) inputs",
1954
- "key": "CaCO3_values"
1949
+ "symbol": "C_{CaCO_3}",
1950
+ "description": "total carbon from limestone (CaCO<sub>3</sub>) inputs (kg C), i.e. $\\sum_i M_{CaCO_3,i} \\times 0.12$",
1951
+ "key": "CaCO3_carbon"
1955
1952
  },
1956
1953
  {
1957
- "symbol": "M_{CaCO_3,i}",
1958
- "description": "mass of each limestone input (kg)",
1959
- "constant": ""
1960
- },
1961
- {
1962
- "symbol": "EF_{CaCO_3}",
1963
- "description": "limestone emission factor (kg CO<sub>2</sub> per kg CaCO<sub>3</sub>)",
1964
- "constant": "0.44"
1954
+ "symbol": "C_{dolomite}",
1955
+ "description": "total carbon from dolomite (CaMg(CO<sub>3</sub>)<sub>2</sub>) inputs (kg C), i.e. $\\sum_j M_{dolomite,j} \\times 0.13$",
1956
+ "key": "MgCO3_carbon"
1965
1957
  },
1966
1958
  {
1967
- "symbol": "n_{dolomite}",
1968
- "description": "number of dolomite (CaMg(CO<sub>3</sub>)<sub>2</sub>) inputs",
1969
- "key": "MgCO3_values"
1970
- },
1971
- {
1972
- "symbol": "M_{dolomite,j}",
1973
- "description": "mass of each dolomite input (kg)",
1959
+ "symbol": "\\frac{44.01}{12.012}",
1960
+ "description": "ratio of the atomic mass of CO<sub>2</sub> to C",
1974
1961
  "constant": ""
1975
- },
1976
- {
1977
- "symbol": "EF_{dolomite}",
1978
- "description": "dolomite emission factor (kg CO<sub>2</sub> per kg dolomite)",
1979
- "constant": "0.477"
1980
1962
  }
1981
1963
  ]
1982
1964
  }
@@ -2035,8 +2017,7 @@
2035
2017
  {
2036
2018
  "symbol": "\\Delta C",
2037
2019
  "description": "the change in carbon stock over year $y$, i.e. $C_y - C_{y-1}$, the difference between the carbon stocks at the end of years $y$ and $y-1$ (kg C ha<sup>-1</sup>).",
2038
- "key": "carbon_stock_inventory",
2039
- "column": "carbon-stock-change"
2020
+ "key": "carbon_stock_change"
2040
2021
  },
2041
2022
  {
2042
2023
  "symbol": "\\frac{44.01}{12.012}",
@@ -2077,12 +2058,12 @@
2077
2058
  {
2078
2059
  "symbol": "M",
2079
2060
  "description": "mass of fuel biomass combusted during land conversion event (tonnes dry matter, >= 0)",
2080
- "constant": ""
2061
+ "display": true
2081
2062
  },
2082
2063
  {
2083
2064
  "symbol": "A",
2084
2065
  "description": "area lost (ha)",
2085
- "constant": ""
2066
+ "display": true
2086
2067
  },
2087
2068
  {
2088
2069
  "symbol": "B_{region}",
@@ -2092,13 +2073,12 @@
2092
2073
  {
2093
2074
  "symbol": "F_{fuel}",
2094
2075
  "description": "fuel factor, mass of fuel biomass per hectare for fuel category (tonnes dry matter ha<sup>-1</sup>)",
2095
- "constant": ""
2076
+ "display": true
2096
2077
  },
2097
2078
  {
2098
2079
  "symbol": "F_{org}",
2099
2080
  "description": "organic soil factor, % area of the Site with organic soils (decimal percentage, 0 - 1)",
2100
- "key": "inventory",
2101
- "column": "percent-organic-soils"
2081
+ "display": true
2102
2082
  }
2103
2083
  ]
2104
2084
  },
@@ -2113,12 +2093,12 @@
2113
2093
  {
2114
2094
  "symbol": "M",
2115
2095
  "description": "mass of fuel available for combustion (tonnes dry matter, >= 0)",
2116
- "constant": ""
2096
+ "display": true
2117
2097
  },
2118
2098
  {
2119
2099
  "symbol": "G_{emission, fuel}",
2120
2100
  "description": "emission factor (g kg<sup>-1</sup> dry matter burnt)",
2121
- "constant": ""
2101
+ "display": true
2122
2102
  }
2123
2103
  ]
2124
2104
  }
@@ -3000,12 +2980,12 @@
3000
2980
  {
3001
2981
  "symbol": "M",
3002
2982
  "description": "mass of fuel biomass combusted during land conversion event (tonnes dry matter, >= 0)",
3003
- "constant": ""
2983
+ "display": true
3004
2984
  },
3005
2985
  {
3006
2986
  "symbol": "A",
3007
2987
  "description": "area lost (ha)",
3008
- "constant": ""
2988
+ "display": true
3009
2989
  },
3010
2990
  {
3011
2991
  "symbol": "B_{region}",
@@ -3015,7 +2995,7 @@
3015
2995
  {
3016
2996
  "symbol": "F_{fuel}",
3017
2997
  "description": "fuel factor, mass of fuel biomass per hectare for fuel category (tonnes dry matter ha<sup>-1</sup>)",
3018
- "constant": ""
2998
+ "display": true
3019
2999
  }
3020
3000
  ]
3021
3001
  },
@@ -3030,12 +3010,12 @@
3030
3010
  {
3031
3011
  "symbol": "M",
3032
3012
  "description": "mass of fuel available for combustion (tonnes dry matter, >= 0)",
3033
- "constant": ""
3013
+ "display": true
3034
3014
  },
3035
3015
  {
3036
3016
  "symbol": "G_{emission, fuel}",
3037
3017
  "description": "emission factor (g kg<sup>-1</sup> dry matter burnt)",
3038
- "constant": ""
3018
+ "display": true
3039
3019
  }
3040
3020
  ]
3041
3021
  }
@@ -3902,8 +3882,8 @@
3902
3882
  },
3903
3883
  {
3904
3884
  "symbol": "FF",
3905
- "description": "fate factor, fraction of the applied mass reaching air",
3906
- "constant": "0.09"
3885
+ "description": "fate factor, fraction of the applied mass reaching air (from the `pefcr2017PesticideFateFactor` lookup, ~0.09)",
3886
+ "key": "emission_factor"
3907
3887
  }
3908
3888
  ]
3909
3889
  }
@@ -3924,8 +3904,8 @@
3924
3904
  },
3925
3905
  {
3926
3906
  "symbol": "FF",
3927
- "description": "fate factor, fraction of the applied mass reaching agricultural soil",
3928
- "constant": "0.9"
3907
+ "description": "fate factor, fraction of the applied mass reaching agricultural soil (from the `pefcr2017PesticideFateFactor` lookup, ~0.9)",
3908
+ "key": "emission_factor"
3929
3909
  }
3930
3910
  ]
3931
3911
  }
@@ -3946,8 +3926,8 @@
3946
3926
  },
3947
3927
  {
3948
3928
  "symbol": "FF",
3949
- "description": "fate factor, fraction of the applied mass reaching water",
3950
- "constant": "0.01"
3929
+ "description": "fate factor, fraction of the applied mass reaching water (from the `pefcr2017PesticideFateFactor` lookup, ~0.01)",
3930
+ "key": "emission_factor"
3951
3931
  }
3952
3932
  ]
3953
3933
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hestia-earth/engine-models",
3
- "version": "0.82.1",
3
+ "version": "0.82.2",
4
4
  "description": "HESTIA Engine Models",
5
5
  "main": "cjs/index.js",
6
6
  "module": "esm/index.js",