hestia-earth-models 0.62.0__py3-none-any.whl → 0.62.2__py3-none-any.whl

hestia_earth/models/ipcc2019/pastureGrass_utils.py

@@ -32,15 +32,11 @@ def _get_activityCoefficient(cycle: dict, animal: dict, system: dict) -> float:
     lookup = download_lookup('system-liveAnimal-activityCoefficient-ipcc2019.csv')
     activityCoefficient = safe_parse_float(get_table_value(lookup, 'termid', system_id, column_name(term_id)), 0)
 
-    debugValues(cycle, model=MODEL, term=term_id, model_key=MODEL_KEY,
-                activityCoefficient=activityCoefficient)
-
     return activityCoefficient
 
 
 def _calculate_NEm(cycle: dict, animal: dict) -> float:
     term = animal.get('term', {})
-    term_id = term.get('@id')
 
     mjDayKgCfiNetEnergyMaintenance = safe_parse_float(
         get_lookup_value(term, 'mjDayKgCfiNetEnergyMaintenanceIpcc2019', model=MODEL, model_key=MODEL_KEY), 0
@@ -50,32 +46,18 @@ def _calculate_NEm(cycle: dict, animal: dict) -> float:
     cycleDuration = cycle.get('cycleDuration', 365)
     NEm = mjDayKgCfiNetEnergyMaintenance * pow(liveweightPerHead, 0.75) * animal_value * cycleDuration
 
-    debugValues(cycle, model=MODEL, term=term_id, model_key=MODEL_KEY,
-                mjDayKgCfiNetEnergyMaintenance=mjDayKgCfiNetEnergyMaintenance,
-                liveweightPerHead=liveweightPerHead,
-                NEm=NEm)
-
     return NEm
 
 
 def _calculate_NEa_cattleAndBuffalo(cycle: dict, animal: dict, system: dict, NEm: float) -> float:
-    term = animal.get('term', {})
-    term_id = term.get('@id')
-
     activityCoefficient = _get_activityCoefficient(cycle, animal, system)
 
     NEa = activityCoefficient * NEm
 
-    debugValues(cycle, model=MODEL, term=term_id, model_key=MODEL_KEY,
-                NEa=NEa)
-
     return NEa
 
 
 def _calculate_NEa_sheepAndGoat(cycle: dict, animal: dict, system: dict, _NEm: float) -> float:
-    term = animal.get('term', {})
-    term_id = term.get('@id')
-
     activityCoefficient = _get_activityCoefficient(cycle, animal, system)
 
     liveweightPerHead = get_node_property(animal, 'liveweightPerHead', False).get('value', 0)
@@ -83,10 +65,6 @@ def _calculate_NEa_sheepAndGoat(cycle: dict, animal: dict, system: dict, _NEm: f
     cycleDuration = cycle.get('cycleDuration', 365)
     NEa = activityCoefficient * liveweightPerHead * animal_value * cycleDuration
 
-    debugValues(cycle, model=MODEL, term=term_id, model_key=MODEL_KEY,
-                liveweightPerHead=liveweightPerHead,
-                NEa=NEa)
-
     return NEa
 
 
@@ -102,9 +80,6 @@ def _calculate_NEa(cycle: dict, animal: dict, system: dict, NEm: float) -> float
 
 
 def _calculate_NEl_cattleAndBuffalo(cycle: dict, animal: dict) -> float:
-    term = animal.get('term', {})
-    term_id = term.get('@id')
-
     milkYieldPractice = get_milkYield_practice(animal)
     milkYield = list_sum(milkYieldPractice.get('value', []))
     fatContent = get_node_property(milkYieldPractice, 'fatContent').get('value', 0)
@@ -112,18 +87,10 @@ def _calculate_NEl_cattleAndBuffalo(cycle: dict, animal: dict) -> float:
     cycleDuration = cycle.get('cycleDuration', 365)
     NEl = milkYield * (1.47 + (0.4 * fatContent)) * animal_value * cycleDuration
 
-    debugValues(cycle, model=MODEL, term=term_id, model_key=MODEL_KEY,
-                milkYield=milkYield,
-                fatContent=fatContent,
-                NEl=NEl)
-
     return NEl
 
 
 def _calculate_NEl_sheepAndGoat(cycle: dict, animal: dict) -> float:
-    term = animal.get('term', {})
-    term_id = term.get('@id')
-
     milkYieldPractice = get_milkYield_practice(animal)
     milkYield = list_sum(milkYieldPractice.get('value', []))
     EV_milk = safe_parse_float(
@@ -131,8 +98,9 @@ def _calculate_NEl_sheepAndGoat(cycle: dict, animal: dict) -> float:
         0
     )
     default_fatContent = safe_parse_float(
-        get_lookup_value(milkYieldPractice.get('term', {}),
-                         'defaultFatContentEvMilkIpcc2019', model=MODEL, model_key=MODEL_KEY),
+        get_lookup_value(
+            milkYieldPractice.get('term', {}), 'defaultFatContentEvMilkIpcc2019', model=MODEL, model_key=MODEL_KEY
+        ),
         7
     )
     fatContent = get_node_property(milkYieldPractice, 'fatContent').get('value', 0)
@@ -140,11 +108,6 @@ def _calculate_NEl_sheepAndGoat(cycle: dict, animal: dict) -> float:
     cycleDuration = cycle.get('cycleDuration', 365)
     NEl = milkYield * (EV_milk * fatContent/default_fatContent) * animal_value * cycleDuration
 
-    debugValues(cycle, model=MODEL, term=term_id, model_key=MODEL_KEY,
-                milkYield=milkYield,
-                EV_milk=EV_milk,
-                NEl=NEl)
-
     return NEl
 
 
@@ -160,16 +123,9 @@ def _calculate_NEl(cycle: dict, animal: dict) -> float:
 
 
 def _calculate_NEwork(cycle: dict, animal: dict, NEm: float) -> float:
-    term = animal.get('term', {})
-    term_id = term.get('@id')
-
     hoursWorkedPerDay = get_node_property(animal, 'hoursWorkedPerDay').get('value', 0)
     NEwork = 0.1 * NEm * hoursWorkedPerDay
 
-    debugValues(cycle, model=MODEL, term=term_id, model_key=MODEL_KEY,
-                hoursWorkedPerDay=hoursWorkedPerDay,
-                NEwork=NEwork)
-
     return NEwork
 
 
@@ -194,24 +150,15 @@ def _get_pregnancy_ratio(animal: dict) -> float:
 
 
 def _calculate_NEp(cycle: dict, animal: dict, NEm: float) -> float:
-    term = animal.get('term', {})
-    term_id = term.get('@id')
-
     ratioCPregnancyNetEnergyPregnancy = _get_pregnancy_ratio(animal)
     pregnancyRateTotal = get_node_property(animal, 'pregnancyRateTotal').get('value', 0)
     NEp = ratioCPregnancyNetEnergyPregnancy * pregnancyRateTotal/100 * NEm
 
-    debugValues(cycle, model=MODEL, term=term_id, model_key=MODEL_KEY,
-                ratioCPregnancyNetEnergyPregnancy=ratioCPregnancyNetEnergyPregnancy,
-                pregnancyRateTotal=pregnancyRateTotal,
-                NEp=NEp)
-
     return NEp
 
 
 def _calculate_NEg_cattleAndBuffalo(cycle: dict, animal: dict) -> float:
     term = animal.get('term', {})
-    term_id = term.get('@id')
 
     ratioCNetEnergyGrowthCattleBuffalo = safe_parse_float(
         get_lookup_value(term, 'ratioCNetEnergyGrowthCattleBuffaloIpcc2019', model=MODEL, model_key=MODEL_KEY), 0
@@ -228,22 +175,14 @@ def _calculate_NEg_cattleAndBuffalo(cycle: dict, animal: dict) -> float:
             ratioCNetEnergyGrowthCattleBuffalo * weightAtMaturity > 0
         ]) else 0
 
-    debugValues(cycle, model=MODEL, term=term_id, model_key=MODEL_KEY,
-                ratioCNetEnergyGrowthCattleBuffalo=ratioCNetEnergyGrowthCattleBuffalo,
-                liveweightPerHead=liveweightPerHead,
-                weightAtMaturity=weightAtMaturity,
-                liveweightGain=liveweightGain,
-                NEg=NEg)
-
     return NEg
 
 
 def _calculate_NEg_sheepAndGoat(cycle: dict, animal: dict) -> float:
     term = animal.get('term', {})
-    term_id = term.get('@id')
 
     MjKgABNetEnergyGrowthSheepGoats = get_lookup_value(
-        term, 'MjKgABNetEnergyGrowthSheepGoatsIpcc2019', model=MODEL, model_key=MODEL_KEY)
+        term, 'mjKgABNetEnergyGrowthSheepGoatsIpcc2019', model=MODEL, model_key=MODEL_KEY)
     MjKg_a = safe_parse_float(extract_grouped_data(MjKgABNetEnergyGrowthSheepGoats, 'a'), 0)
     MjKg_b = safe_parse_float(extract_grouped_data(MjKgABNetEnergyGrowthSheepGoats, 'b'), 0)
     BWi = get_node_property(animal, 'weightAtWeaning').get('value', 0)
@@ -253,13 +192,6 @@ def _calculate_NEg_sheepAndGoat(cycle: dict, animal: dict) -> float:
     cycleDuration = cycle.get('cycleDuration', 365)
     NEg = (BWf - BWi) * (MjKg_a + 0.5 * MjKg_b * (BWi + BWf)) / 365 * animal_value * cycleDuration
 
-    debugValues(cycle, model=MODEL, term=term_id, model_key=MODEL_KEY,
-                MjKg_a=MjKg_a,
-                MjKg_b=MjKg_b,
-                BWi=BWi,
-                BWf=BWf,
-                NEg=NEg)
-
     return NEg
 
 
@@ -271,16 +203,17 @@ _NEg_BY_GROUPING = {
 
 def _calculate_NEg(cycle: dict, animal: dict) -> float:
     grouping = _get_grouping(animal)
-    return _NEg_BY_GROUPING.get(grouping, lambda *args: None)(cycle, animal)
+    return _NEg_BY_GROUPING.get(grouping, lambda *args: 0)(cycle, animal)
 
 
-def _pastureGrass_key_property_value(practice: dict, column: dict):
-    term_id = practice_input_id(practice)
-    term = download_hestia(term_id)
-    term_type = term.get('termType')
-    value = list_sum(practice.get('value', [0]))
-    lookup_value = node_property_lookup_value(MODEL, {'@id': term_id, 'termType': term_type}, column, default=0)
-    return (lookup_value, value)
+def _pastureGrass_key_property_value(column: dict, **log_args):
+    def get_value(practice: dict):
+        term_id = practice_input_id(practice)
+        term = download_hestia(term_id)
+        value = list_sum(practice.get('value', [0]))
+        lookup_value = node_property_lookup_value(MODEL, term, column, default=0, **log_args)
+        return (lookup_value, value)
+    return get_value
 
 
 def calculate_REM(energy: float = 0) -> float:
@@ -291,14 +224,14 @@ def calculate_REG(energy: float = 0) -> float:
     return 1.164 - (5.16/1000 * energy) + (1.308/100000 * pow(energy, 2)) - (37.4/energy) if energy > 0 else 0
 
 
-def _calculate_feed_meanDE(node: dict, input: dict) -> float:
+def _calculate_feed_meanDE(log_node: dict, input: dict) -> float:
     term_id = input.get('term', {}).get('@id')
 
     energyContent = get_node_property_value(MODEL, input, 'energyContentHigherHeatingValue')
     energyDigestibility = get_node_property_value(MODEL, input, 'energyDigestibilityRuminants')
     meanDE = energyContent * energyDigestibility if all([energyContent, energyDigestibility]) else 0
 
-    debugValues(node, model=MODEL, term=term_id, model_key=MODEL_KEY,
+    debugValues(log_node, model=MODEL, term=term_id, model_key=MODEL_KEY,
                 energyContent=energyContent,
                 energyDigestibility=energyDigestibility,
                 meanDE=meanDE)
@@ -306,26 +239,26 @@ def _calculate_feed_meanDE(node: dict, input: dict) -> float:
     return meanDE
 
 
-def _calculate_NEfeed_m(node: dict, input: dict, meanDE: float) -> float:
+def _calculate_NEfeed_m(log_node: dict, input: dict, meanDE: float) -> float:
     term_id = input.get('term', {}).get('@id')
 
     energyDigestibility = get_node_property_value(MODEL, input, 'energyDigestibilityRuminants', default=0)
     REm = calculate_REM(energyDigestibility * 100)
 
-    debugValues(node, model=MODEL, term=term_id, model_key=MODEL_KEY,
+    debugValues(log_node, model=MODEL, term=term_id, model_key=MODEL_KEY,
                 REm=REm)
 
     input_value = list_sum(input.get('value'))
     return meanDE * REm * input_value
 
 
-def _calculate_NEfeed_g(node: dict, input: dict, meanDE: float) -> float:
+def _calculate_NEfeed_g(log_node: dict, input: dict, meanDE: float) -> float:
     term_id = input.get('term', {}).get('@id')
 
     energyDigestibility = get_node_property_value(MODEL, input, 'energyDigestibilityRuminants', default=0)
     REg = calculate_REG(energyDigestibility * 100)
 
-    debugValues(node, model=MODEL, term=term_id, model_key=MODEL_KEY,
+    debugValues(log_node, model=MODEL, term=term_id, model_key=MODEL_KEY,
                 REg=REg)
 
     input_value = list_sum(input.get('value'))
@@ -346,7 +279,7 @@ def calculate_NEfeed(node: dict) -> tuple:
     return (NEfeed_m, NEfeed_g)
 
 
-def get_animal_values(cycle: dict, animal: dict, system: dict):
+def get_animal_values(cycle: dict, animal: dict, system: dict) -> dict:
     NEm = _calculate_NEm(cycle, animal)
     NEa = _calculate_NEa(cycle, animal, system, NEm)
     NEl = _calculate_NEl(cycle, animal)
@@ -354,19 +287,40 @@ def get_animal_values(cycle: dict, animal: dict, system: dict):
     NEp = _calculate_NEp(cycle, animal, NEm)
     NEg = _calculate_NEg(cycle, animal)
 
-    return (NEm, NEa, NEl, NEwork, NEp, NEg)
+    return {
+        'NEm': NEm,
+        'NEa': NEa,
+        'NEl': NEl,
+        'NEwork': NEwork,
+        'NEp': NEp,
+        'NEg': NEg
+    }
+
+
+def _sum_values(values: list, key: str): return list_sum([v.get(key) for v in values])
+
+
+def calculate_GE(values: list, REM: float, REG: float, NEwool: float, NEm_feed: float, NEg_feed: float) -> float:
+    NEm = _sum_values(values, 'NEm')
+    NEa = _sum_values(values, 'NEa')
+    NEl = _sum_values(values, 'NEl')
+    NEwork = _sum_values(values, 'NEwork')
+    NEp = _sum_values(values, 'NEp')
+    NEg = _sum_values(values, 'NEg')
+
+    return ((NEm + NEa + NEl + NEwork + NEp - NEm_feed)/REM + (NEg + NEwool - NEg_feed)/REG) if all([REM, REG]) else 0
 
 
-def calculate_meanECHHV(practices: list) -> float:
-    values = list(map(lambda p: _pastureGrass_key_property_value(p, 'energyContentHigherHeatingValue'), practices))
+def calculate_meanECHHV(practices: list, **log_args) -> float:
+    values = list(map(_pastureGrass_key_property_value('energyContentHigherHeatingValue', **log_args), practices))
     total_weight = sum([weight/100 for _value, weight in values])
     return sum([
         (value * weight/100 if all([value, weight]) else 0) for value, weight in values
     ]) / total_weight if total_weight > 0 else 0
 
 
-def calculate_meanDE(practices: list) -> float:
-    values = list(map(lambda p: _pastureGrass_key_property_value(p, 'energyDigestibilityRuminants'), practices))
+def calculate_meanDE(practices: list, **log_args) -> float:
+    values = list(map(_pastureGrass_key_property_value('energyDigestibilityRuminants', **log_args), practices))
     total_weight = sum([weight/100 for _value, weight in values])
     meanDE = sum([
         (value * weight/100 if all([value, weight]) else 0) for value, weight in values