@hestia-earth/aggregation-engine 0.22.2 → 0.22.3

package/cjs/formulas.d.ts

@@ -49,6 +49,16 @@ export interface IFormula {
      * The KaTeX source (without the `$$` delimiters).
      */
     formula: string;
+    /**
+     * The heading the formula is documented under, e.g. `Completeness`. Names what the formula
+     * is for, so several formulas shown together can be told apart.
+     */
+    section?: string;
+    /**
+     * The sentence that introduces the formula in the documentation. Shown above it, so a reader
+     * who never opens the guide still knows what it calculates and how it relates to the others.
+     */
+    context?: string;
     /**
      * The symbols in the formula, in "Where:" list order.
      */

package/esm/formulas.d.ts

@@ -49,6 +49,16 @@ export interface IFormula {
      * The KaTeX source (without the `$$` delimiters).
      */
     formula: string;
+    /**
+     * The heading the formula is documented under, e.g. `Completeness`. Names what the formula
+     * is for, so several formulas shown together can be told apart.
+     */
+    section?: string;
+    /**
+     * The sentence that introduces the formula in the documentation. Shown above it, so a reader
+     * who never opens the guide still knows what it calculates and how it relates to the others.
+     */
+    context?: string;
     /**
      * The symbols in the formula, in "Where:" list order.
      */

package/formulas/index.json

@@ -2,6 +2,8 @@
   "hestia_earth/aggregation/docs/crop.md": [
     {
       "formula": "w_s = O \\times I",
+      "section": "Aggregation stages",
+      "context": "Each sub-aggregation's weight is the product of its organic share and its irrigation share.",
       "bindings": [
         {
           "symbol": "w_s",
@@ -22,6 +24,8 @@
     },
     {
       "formula": "p_{org} = \\min\\left(1, \\frac{V_{org}}{100}\\right)",
+      "section": "Aggregation stages",
+      "context": "The organic share comes from the region-standardsLabels-isOrganic lookup (FiBL), averaged over the aggregation period.",
       "bindings": [
         {
           "symbol": "p_{org}",
@@ -37,6 +41,8 @@
     },
     {
       "formula": "p_{irr} = \\frac{A_{irr}}{A_{total}}",
+      "section": "Aggregation stages",
+      "context": "The irrigation share comes from the region-irrigated lookup (AQUASTAT).",
       "bindings": [
         {
           "symbol": "p_{irr}",
@@ -57,6 +63,8 @@
     },
     {
       "formula": "w_p = \\begin{cases} \\frac{L - N}{L} & \\text{productive phase} \\\\ \\frac{365}{L} & \\text{preparation phase} \\\\ \\frac{N - 365}{L} & \\text{non-productive phase} \\end{cases}",
+      "section": "Plantation weighting",
+      "context": "The weight for each category is then calculated from the default glossary values for plantation_lifespan and plantation_non_productive_lifespan.",
       "bindings": [
         {
           "symbol": "w_p",
@@ -82,6 +90,8 @@
     },
     {
       "formula": "w_c = \\min\\left(1, \\frac{P_c}{P_{world}}\\right)",
+      "section": "World aggregations",
+      "context": "World aggregations are created by combining verified country aggregations.",
       "bindings": [
         {
           "symbol": "w_c",
@@ -104,6 +114,8 @@
   "hestia_earth/aggregation/docs/general-process.md": [
     {
       "formula": "\\bar{v} = \\sum_i v_i \\times \\frac{w_i}{W_T}",
+      "section": "Number values",
+      "context": "The simple mean is the case of the weighted mean where every weight is equal, so both are calculated the same way.",
       "bindings": [
         {
           "symbol": "\\bar{v}",
@@ -131,6 +143,8 @@
     },
     {
       "formula": "\\hat{w}_i = \\frac{w_i}{n_{k(i)} \\times W_T}",
+      "section": "Number values",
+      "context": "When several Cycles share the same weight, that weight is divided between them, so a group represented by many Cycles does not count more than a group represented by few: a group's share of the result is its intended weight, not its number of uploads.",
       "bindings": [
         {
           "symbol": "\\hat{w}_i",
@@ -156,6 +170,8 @@
     },
     {
       "formula": "\\bar{v} = \\sum_i v_i \\times \\frac{w_i}{W_R + W_Z}",
+      "section": "Completeness",
+      "context": "This zero-filling is what allows a term reported by only part of the population to be averaged over the whole population rather than only where it occurs.",
       "bindings": [
         {
           "symbol": "\\bar{v}",
@@ -188,6 +204,8 @@
     },
     {
       "formula": "EVS = \\overline{evs} \\times \\frac{W_P}{W_T}",
+      "section": "Primary Product",
+      "context": "Because economicValueShare is a share of the Cycle's total revenue rather than a physical quantity, it also has to account for how prevalent the product is across the population.",
       "bindings": [
         {
           "symbol": "EVS",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hestia-earth/aggregation-engine",
-  "version": "0.22.2",
+  "version": "0.22.3",
   "description": "HESTIA Aggregation Engine",
   "main": "cjs/index.js",
   "directories": {