hestia-earth-models 0.64.8__py3-none-any.whl → 0.64.10__py3-none-any.whl

tests/models/environmentalFootprintV3/test_soilQualityIndexLandTransformation.py

@@ -1,6 +1,8 @@
 import json
 from unittest.mock import patch
 
+from pytest import mark
+
 from hestia_earth.models.environmentalFootprintV3.soilQualityIndexLandTransformation import MODEL, TERM_ID, run, \
     _should_run
 from tests.utils import fixtures_path, fake_new_indicator
@@ -15,99 +17,159 @@ def fake_rounded_indicator(value: float):
     return indicator
 
 
-def test_should_run_ocean(*args):
-    """
-    Should not run if a LandCover has no CF (ocean)
-    """
-    with open(f"{fixtures_folder}/bad-sites/site-LandCover-has-no-CF.jsonld", encoding='utf-8') as f:
-        site = json.load(f)
-
-    should_run, *args = _should_run(site)
-    assert should_run is False
-
-
-def test_should_run_no_management_entries(*args):
-    """
-    no management => no run
-    """
-    with open(f"{fixtures_folder}/bad-sites/site-no-management.jsonld", encoding='utf-8') as f:
-        site = json.load(f)
-
-    should_run, *args = _should_run(site)
-    assert should_run is False
-
-
-def test_should_run_no_sites(*args):
-    """
-    impact assessment with no site => no run
-    """
-    with open(f"{fixtures_path}/impact_assessment/emissions/impact-assessment.jsonld", encoding='utf-8') as f:
-        site = json.load(f)
-
-    should_run, *args = _should_run(site)
-    assert should_run is False
-
-
-def test_should_run_no_transformation(*args):
-    """
-    1 management with no transformation => no run
-    """
-    with open(f"{fixtures_folder}/bad-sites/site-no-transformations.jsonld", encoding='utf-8') as f:
-        site = json.load(f)
-
-    should_run, *args = _should_run(site)
-    assert should_run is False
-
-
-@patch(f"{class_path}._indicator", side_effect=fake_rounded_indicator)
-def test_run_in_cycle(*args):
-    with open(f"{fixtures_folder}/Italy/site-italy-inside-cycle.jsonld", encoding='utf-8') as f:
-        site = json.load(f)
-
-    with open(f"{fixtures_folder}/Italy/result.jsonld", encoding='utf-8') as f:
+crop_land = {"@id": "cropland", "termType": "landCover"}
+sea_land_cover = {"@id": "seaOrOcean", "termType": "landCover"}
+forest = {"@id": "forest", "termType": "landCover"}
+
+wrong_indicator = {"term": {"@id": "NOT_VALID_INDICATOR_ID", "termType": "resourceUse", "units": "m2 / year"},
+                   "value": 0.5, "landCover": crop_land}
+
+indicator_no_land_cover = {
+    "term": {"@id": "landTransformationFromForest20YearAverageInputsProduction", "termType": "resourceUse",
+             "units": "m2 / year"},
+    "value": 0.5}
+
+indicator_no_unit = {
+    "term": {"@id": "landTransformationFromForest20YearAverageInputsProduction", "termType": "resourceUse"},
+    "value": 0.5, "landCover": crop_land}
+
+indicator_wrong_unit = {
+    "term": {"@id": "landTransformationFromForest20YearAverageInputsProduction", "termType": "resourceUse",
+             "units": "ha*day"}, "value": 0.5,
+    "landCover": crop_land}
+
+indicator_bad_area_value = {
+    "term": {"@id": "landTransformationFromForest20YearAverageInputsProduction", "termType": "resourceUse",
+             "units": "m2 / year"}, "value": -10,
+    "landCover": crop_land}
+
+inputs_production_indicator_from_forest_to_no_cf = {
+    "term": {"@id": "landTransformationFromForest20YearAverageInputsProduction", "termType": "resourceUse",
+             "units": "m2 / year"}, "value": 0.5,
+    "landCover": sea_land_cover}
+
+good_inputs_production_indicator_from_forest_to_cropland = {
+    "term": {"@id": "landTransformationFromForest20YearAverageInputsProduction", "termType": "resourceUse",
+             "units": "m2 / year"}, "value": 0.5,
+    "landCover": crop_land}
+
+good_inputs_production_indicator_from_forest_to_forest = {
+    "term": {"@id": "landTransformationFromForest20YearAverageInputsProduction", "termType": "resourceUse",
+             "units": "m2 / year"}, "value": 0.5,
+    "landCover": forest}
+
+good_during_cycle_indicator_from_forest_to_cropland = {
+    "term": {"@id": "landTransformationFromForest20YearAverageDuringCycle", "termType": "resourceUse",
+             "units": "m2 / year"}, "value": 0.5,
+    "landCover": crop_land}
+
+good_during_cycle_indicator_from_forest_to_forest = {
+    "term": {"@id": "landTransformationFromForest20YearAverageDuringCycle", "termType": "resourceUse",
+             "units": "m2 / year"}, "value": 0.5,
+    "landCover": forest}
+
+
+@mark.parametrize(
+    "resources, expected, num_inputs",
+    [
+        ([], True, 0),
+        ([wrong_indicator], True, 0),
+        ([indicator_no_land_cover], False, 0),
+        ([indicator_no_unit], False, 0),
+        ([indicator_wrong_unit], False, 0),
+        ([indicator_bad_area_value], False, 0),
+        ([good_during_cycle_indicator_from_forest_to_cropland], True, 1),
+        ([good_during_cycle_indicator_from_forest_to_forest], True, 1),
+        ([good_inputs_production_indicator_from_forest_to_cropland], True, 1),
+        ([good_inputs_production_indicator_from_forest_to_forest], True, 1),
+        ([inputs_production_indicator_from_forest_to_no_cf], True, 0),  # todo check
+        ([good_inputs_production_indicator_from_forest_to_cropland,
+          good_during_cycle_indicator_from_forest_to_cropland], True, 2)
+    ],
+    ids=["No emissionsResourceUse => run, 0 dict",
+         "Wrong indicator termid => run, 0 dict",
+         "Indicator no landcover terms => no run",
+         "Missing unit => no run",
+         "Wrong unit => no run",
+         "Bad m2 / year value => no run",
+         "One good during cycle transformation => run, 1 dict",
+         "One 0 during cycle transformation => run, 1 dict",
+         "One good inputs production transformation => run, 1 dict",
+         "One 0 inputs production transformation => run, 1 dict",
+         "One good from transformation and One with no CF (ocean) => run, 2 dict",  # todo
+         "Multiple good indicators => run, 2 dict",
+         ]
+)
+@patch(f"{class_path}.get_land_cover_terms", return_value=['cropland', 'seaOrOcean', 'forest'])
+def test_should_run(mock_download, resources, expected, num_inputs):
+    with open(f"{fixtures_folder}/multipleTransformations/impact-assessment.jsonld", encoding='utf-8') as f:
+        impact = json.load(f)
+
+    impact['emissionsResourceUse'] = resources
+
+    should_run, resources_with_cf = _should_run(impact)
+    assert should_run is expected
+    assert len(resources_with_cf) == num_inputs
+
+
+@patch(f"{class_path}._new_indicator", side_effect=fake_new_indicator)
+def test_run(*args):
+    with open(f"{fixtures_folder}/multipleTransformations/impact-assessment.jsonld", encoding='utf-8') as f:
+        impact = json.load(f)
+
+    with open(f"{fixtures_folder}/multipleTransformations/result.jsonld", encoding='utf-8') as f:
         expected = json.load(f)
 
-    value = run(site)
+    value = run(impact)
     assert value == expected
 
 
-@patch(f"{class_path}._indicator", side_effect=fake_rounded_indicator)
-def test_run_other_sites(*args):
-    with open(f"{fixtures_folder}/Italy/site-italy-otherSites.jsonld", encoding='utf-8') as f:
-        site = json.load(f)
+@patch(f"{class_path}._new_indicator", side_effect=fake_new_indicator)
+def test_run_italy(*args):
+    with open(f"{fixtures_folder}/Italy/impact-assessment.jsonld", encoding='utf-8') as f:
+        impact = json.load(f)
 
-    with open(f"{fixtures_folder}/Italy/result-otherSites.jsonld", encoding='utf-8') as f:
+    with open(f"{fixtures_folder}/Italy/result.jsonld", encoding='utf-8') as f:
         expected = json.load(f)
 
-    value = run(site)
+    value = run(impact)
     assert value == expected
 
 
+@mark.parametrize(
+    "added_data",
+    [
+        {"country": {}},
+        {"country": {"@id": "region-europe", "@type": "Term", "name": "Europe"}},
+    ],
+    ids=["No country/region => default to region world",
+         "region-europe not in the lookup file => default to region world"]
+)
 @patch(f"{class_path}._indicator", side_effect=fake_rounded_indicator)
-def test_run_with_region(*args):
+def test_run_with_country_fallback(mocked_indicator, added_data):
     """
-    When given valid sub-region or country not in the lookup file should default to 'region-world'
+    When given valid sub-region or country not in the lookup file, default to country 'region-world' with value 574.56
     """
-    with open(f"{fixtures_folder}/region-world/region-europe.jsonld", encoding='utf-8') as f:
-        site = json.load(f)
 
-    with open(f"{fixtures_folder}/region-world/result-default-region-world.jsonld", encoding='utf-8') as f:
-        expected = json.load(f)
+    with open(f"{fixtures_folder}/multipleTransformations/impact-assessment.jsonld", encoding='utf-8') as f:
+        impact = json.load(f)
 
-    value = run(site)
-    assert value == expected
+    impact = impact | added_data
 
+    value = run(impact)
+    assert value['value'] == 574.56
 
-@patch(f"{class_path}._indicator", side_effect=fake_rounded_indicator)
-def test_run_with_no_region(*args):
+
+@patch(f"{class_path}._new_indicator", side_effect=fake_new_indicator)
+def test_run_no_transformation(*args):
     """
-    When no location is specified, defaults to region world.
+    Impact assessment with no transformations should return a indicator of 0
     """
-    with open(f"{fixtures_folder}/region-world/no-region.jsonld", encoding='utf-8') as f:
-        site = json.load(f)
+    with open(f"{fixtures_folder}/multipleTransformations/impact-assessment.jsonld", encoding='utf-8') as f:
+        impact = json.load(f)
 
-    with open(f"{fixtures_folder}/region-world/result-default-region-world.jsonld", encoding='utf-8') as f:
-        expected = json.load(f)
+    impact['emissionsResourceUse'] = []
 
-    value = run(site)
-    assert value == expected
+    value = run(impact)
+
+    assert value['value'] == 0

tests/models/environmentalFootprintV3/test_soilQualityIndexTotalLandUseEffects.py

@@ -17,25 +17,30 @@ bad_value_indicator = {'term': {'@id': 'soilQualityIndexLandOccupation'}, 'value
 
 
 @mark.parametrize(
-    "emissions_resource_use, expected",
+    "emissions_resource_use, expected, num_expected",
     [
-        ([], False),
-        ([transform_indicator], False),
-        ([transform_indicator, transform_indicator], False),
-        ([transform_indicator, missing_value_indicator], False),
-        ([transform_indicator, bad_value_indicator], False),
-        ([transform_indicator, occupation_indicator], True),
+        ([], False, 0),
+        ([transform_indicator], False, 1),
+        ([transform_indicator, transform_indicator], False, 2),
+        ([transform_indicator, missing_value_indicator], False, 2),
+        ([transform_indicator, bad_value_indicator], False, 2),
+        ([transform_indicator, occupation_indicator], True, 2),
+        ([occupation_indicator], False, 1),
+        ([occupation_indicator, occupation_indicator, occupation_indicator,
+          transform_indicator, transform_indicator], True, 5),
     ],
-    ids=["Empty", "missing entry", "duplicate entry", "no value in entry", "bad value in entry", "correct assessment"]
+    ids=["Empty", "missing obligatory occupation", "duplicate entry", "no value in entry", "bad value in entry",
+         "correct assessment", "just occupation", "multiple occupations and transformations"]
 )
-def test_should_run(emissions_resource_use, expected):
+def test_should_run(emissions_resource_use, expected, num_expected):
     with open(f"{fixtures_folder}/impactassessment.jsonld", encoding='utf-8') as f:
         impactassessment = json.load(f)
 
     impactassessment['emissionsResourceUse'] = emissions_resource_use
 
-    should_run, *args = _should_run(impactassessment)
+    should_run, indicators = _should_run(impactassessment)
     assert should_run is expected
+    assert len(indicators) is num_expected
 
 
 @patch(f"{class_path}._new_indicator", side_effect=fake_new_indicator)

tests/models/frischknechtEtAl2000/test_ionisingRadiationKbqU235Eq.py

@@ -8,54 +8,77 @@ from hestia_earth.models.frischknechtEtAl2000.ionisingRadiationKbqU235Eq import
 class_path = f"hestia_earth.models.{MODEL}.{TERM_ID}"
 fixtures_folder = f"{fixtures_path}/{MODEL}/{TERM_ID}"
 
+hydrogen3_input = {"@id": "hydrogen3", "termType": "waste", "units": "kg"}
+cesium134_input = {"@id": "cesium134", "termType": "waste", "units": "kg"}
+cesium137_input = {"@id": "cesium137", "termType": "waste", "units": "kg"}
+uranium234_input = {"@id": "uranium234", "termType": "waste", "units": "kg"}
+iodine129_input = {"@id": "iodine129", "termType": "waste", "units": "kg"}
+no_cf_input = {"@id": "oilPalmMillEffluentWaste", "termType": "waste", "units": "kg"}
+
+wrong_indicator = {"term": {"@id": "co2ToAirSoilOrganicCarbonStockChangeManagementChange", "termType": "emission"},
+                   "value": 3, "inputs": [hydrogen3_input]}
+
+indicator_no_inputs = {"term": {"@id": "ionisingCompoundsToAirInputsProduction", "termType": "emission"},
+                       "value": 3, "inputs": []}
+
+indicator_2_inputs = {"term": {"@id": "ionisingCompoundsToWaterInputsProduction", "termType": "emission"},
+                      "value": 3, "inputs": [cesium134_input, cesium137_input]}
+
+indicator_no_unit = {"term": {"@id": "ionisingCompoundsToAirInputsProduction", "termType": "emission"},
+                     "value": 3, "inputs": [{"@id": "hydrogen3", "termType": "waste"}]}
+
+indicator_wrong_unit = {"term": {"@id": "ionisingCompoundsToAirInputsProduction", "termType": "emission"},
+                        "value": 3, "inputs": [{"@id": "hydrogen3", "termType": "waste", "units": "not_a_unit"}]}
+
+indicator_no_cf_input = {"term": {"@id": "ionisingCompoundsToAirInputsProduction", "termType": "emission"},
+                         "value": 3, "inputs": [no_cf_input]}
+
+indicator_hydrogen3_input = {"term": {"@id": "ionisingCompoundsToAirInputsProduction", "termType": "emission"},
+                             "value": 3, "inputs": [hydrogen3_input]}
+
+indicator_cesium137_input = {"term": {"@id": "ionisingCompoundsToWaterInputsProduction", "termType": "emission"},
+                             "value": 3, "inputs": [cesium137_input]}
+
+indicator_uranium234_input = {"term": {"@id": "ionisingCompoundsToSaltwaterInputsProduction", "termType": "emission"},
+                              "value": 3, "inputs": [uranium234_input]}
+
 
 @pytest.mark.parametrize(
-    'test_name,impact,expected_should_run',
+    "resources, expected, num_inputs",
     [
-        (
-            'no emissionsResourceUse => no run',
-            {},
-            False
-        ),
-        (
-            'no emissions in the lookups list => no run',
-            {
-                'emissionsResourceUse': [
-                    {
-                        'term': {'@id': 'co2ToAirInputsProduction'}
-                    }
-                ]
-            },
-            False
-        ),
-        (
-            'with emissions in the lookup list but no waste inputs => no run',
-            {
-                'emissionsResourceUse': [
-                    {
-                        'term': {'@id': 'ionisingCompoundsToAirInputsProduction'}
-                    }
-                ]
-            },
-            False
-        ),
-        (
-            'with emissions in the lookup list and waste inputs => run',
-            {
-                'emissionsResourceUse': [
-                    {
-                        'term': {'@id': 'ionisingCompoundsToAirInputsProduction'},
-                        'inputs': [{'termType': 'waste'}]
-                    }
-                ]
-            },
-            True
-        )
-    ]
+        ([], True, 0),
+        ([wrong_indicator], True, 0),
+        ([indicator_no_inputs], False, 0),
+        ([indicator_2_inputs], False, 0),
+        ([indicator_no_unit], False, 0),
+        ([indicator_wrong_unit], False, 0),
+        ([indicator_no_cf_input], True, 0),
+        ([indicator_hydrogen3_input], True, 1),
+        ([indicator_cesium137_input], True, 1),
+        ([indicator_uranium234_input], True, 1),
+        ([indicator_cesium137_input, indicator_no_cf_input], True, 1),
+    ],
+    ids=["No emissionsResourceUse => run, empty input",
+         "Wrong indicator termid => run, empty input",
+         "Indicator no inputs => no run",
+         "Indicator 2 inputs => no run",
+         "Missing unit => no run",
+         "Wrong unit => no run",
+         "Input with no cf => run, empty input",
+         "Good input ionisingCompoundsToAirInputsProduction => run, 1 input",
+         "Good input ionisingCompoundsToWaterInputsProduction => run, 1 input",
+         "Good input ionisingCompoundsToSaltwaterInputsProduction => run, 1 input",
+         "One good input => run, 1 input"]
 )
-def test_should_run(test_name, impact, expected_should_run):
-    should_run, *args = _should_run(impact)
-    assert should_run == expected_should_run, test_name
+def test_should_run(resources, expected, num_inputs):
+    with open(f"{fixtures_folder}/impact-assessment.jsonld", encoding='utf-8') as f:
+        impactassessment = json.load(f)
+
+    impactassessment['emissionsResourceUse'] = resources
+
+    should_run, resources_with_cf = _should_run(impactassessment)
+    assert should_run is expected
+    assert len(resources_with_cf) == num_inputs
 
 
 @patch(f"{class_path}._new_indicator", side_effect=fake_new_indicator)

tests/models/impact_assessment/test_emissions.py

@@ -28,4 +28,5 @@ def test_run(*args):
         expected = json.load(f)
 
     value = run(impact)
+    print(json.dumps(value))
     assert value == expected

tests/models/ipcc2019/animal/test_fatContent.py

@@ -0,0 +1,22 @@
+from unittest.mock import patch
+import json
+from tests.utils import fixtures_path, fake_new_property
+
+from hestia_earth.models.ipcc2019 import MODEL
+from hestia_earth.models.ipcc2019.animal.fatContent import TERM_ID, run
+
+utils_path = '.'.join(['hestia_earth', 'models', MODEL, 'animal', 'utils'])
+class_path = f"hestia_earth.models.{MODEL}.animal.{TERM_ID}"
+fixtures_folder = f"{fixtures_path}/{MODEL}/animal/{TERM_ID}"
+
+
+@patch(f"{utils_path}._new_property", side_effect=fake_new_property)
+def test_run(*args):
+    with open(f"{fixtures_folder}/cycle.jsonld", encoding='utf-8') as f:
+        cycle = json.load(f)
+
+    with open(f"{fixtures_folder}/result.jsonld", encoding='utf-8') as f:
+        expected = json.load(f)
+
+    value = run(cycle)
+    assert value == expected

tests/models/ipcc2019/animal/test_liveweightGain.py

@@ -2,13 +2,15 @@ from unittest.mock import patch
 import json
 from tests.utils import fixtures_path, fake_new_property
 
-from hestia_earth.models.ipcc2019.animal.liveweightGain import MODEL, TERM_ID, run
+from hestia_earth.models.ipcc2019 import MODEL
+from hestia_earth.models.ipcc2019.animal.liveweightGain import TERM_ID, run
 
+utils_path = '.'.join(['hestia_earth', 'models', MODEL, 'animal', 'utils'])
 class_path = f"hestia_earth.models.{MODEL}.animal.{TERM_ID}"
 fixtures_folder = f"{fixtures_path}/{MODEL}/animal/{TERM_ID}"
 
 
-@patch(f"{class_path}._new_property", side_effect=fake_new_property)
+@patch(f"{utils_path}._new_property", side_effect=fake_new_property)
 def test_run(*args):
     with open(f"{fixtures_folder}/cycle.jsonld", encoding='utf-8') as f:
         cycle = json.load(f)

tests/models/ipcc2019/animal/test_liveweightPerHead.py

@@ -2,13 +2,15 @@ from unittest.mock import patch
 import json
 from tests.utils import fixtures_path, fake_new_property
 
-from hestia_earth.models.ipcc2019.animal.liveweightPerHead import MODEL, TERM_ID, run
+from hestia_earth.models.ipcc2019 import MODEL
+from hestia_earth.models.ipcc2019.animal.liveweightPerHead import TERM_ID, run
 
+utils_path = '.'.join(['hestia_earth', 'models', MODEL, 'animal', 'utils'])
 class_path = f"hestia_earth.models.{MODEL}.animal.{TERM_ID}"
 fixtures_folder = f"{fixtures_path}/{MODEL}/animal/{TERM_ID}"
 
 
-@patch(f"{class_path}._new_property", side_effect=fake_new_property)
+@patch(f"{utils_path}._new_property", side_effect=fake_new_property)
 def test_run(*args):
     with open(f"{fixtures_folder}/cycle.jsonld", encoding='utf-8') as f:
         cycle = json.load(f)

tests/models/ipcc2019/animal/test_pregnancyRateTotal.py

@@ -0,0 +1,22 @@
+from unittest.mock import patch
+import json
+from tests.utils import fixtures_path, fake_new_property
+
+from hestia_earth.models.ipcc2019 import MODEL
+from hestia_earth.models.ipcc2019.animal.pregnancyRateTotal import TERM_ID, run
+
+utils_path = '.'.join(['hestia_earth', 'models', MODEL, 'animal', 'utils'])
+class_path = f"hestia_earth.models.{MODEL}.animal.{TERM_ID}"
+fixtures_folder = f"{fixtures_path}/{MODEL}/animal/{TERM_ID}"
+
+
+@patch(f"{utils_path}._new_property", side_effect=fake_new_property)
+def test_run(*args):
+    with open(f"{fixtures_folder}/cycle.jsonld", encoding='utf-8') as f:
+        cycle = json.load(f)
+
+    with open(f"{fixtures_folder}/result.jsonld", encoding='utf-8') as f:
+        expected = json.load(f)
+
+    value = run(cycle)
+    assert value == expected

tests/models/ipcc2019/animal/test_trueProteinContent.py

@@ -0,0 +1,22 @@
+from unittest.mock import patch
+import json
+from tests.utils import fixtures_path, fake_new_property
+
+from hestia_earth.models.ipcc2019 import MODEL
+from hestia_earth.models.ipcc2019.animal.trueProteinContent import TERM_ID, run
+
+utils_path = '.'.join(['hestia_earth', 'models', MODEL, 'animal', 'utils'])
+class_path = f"hestia_earth.models.{MODEL}.animal.{TERM_ID}"
+fixtures_folder = f"{fixtures_path}/{MODEL}/animal/{TERM_ID}"
+
+
+@patch(f"{utils_path}._new_property", side_effect=fake_new_property)
+def test_run(*args):
+    with open(f"{fixtures_folder}/cycle.jsonld", encoding='utf-8') as f:
+        cycle = json.load(f)
+
+    with open(f"{fixtures_folder}/result.jsonld", encoding='utf-8') as f:
+        expected = json.load(f)
+
+    value = run(cycle)
+    assert value == expected

tests/models/ipcc2019/animal/test_weightAtMaturity.py

@@ -2,7 +2,8 @@ from unittest.mock import patch
 import json
 from tests.utils import fixtures_path, fake_new_property
 
-from hestia_earth.models.ipcc2019.animal.weightAtMaturity import MODEL, TERM_ID, run
+from hestia_earth.models.ipcc2019 import MODEL
+from hestia_earth.models.ipcc2019.animal.weightAtMaturity import TERM_ID, run
 
 class_path = f"hestia_earth.models.{MODEL}.animal.{TERM_ID}"
 fixtures_folder = f"{fixtures_path}/{MODEL}/animal/{TERM_ID}"