hestia-earth-models 0.64.13__py3-none-any.whl → 0.64.14__py3-none-any.whl

hestia_earth/models/preload_requests.py

@@ -3,13 +3,31 @@ Preload all search requests to avoid making the same searches many times while r
 """
 import json
 import os
+from hestia_earth.utils.storage import _load_from_storage
 
 from .log import logger
 from .mocking.build_mock_search import create_search_results
 from .mocking import RESULTS_PATH, enable_mock as _mock
 
 
-def enable_preload(filepath: str = RESULTS_PATH, node: dict = None, overwrite_existing: bool = True):
+def _write_results(filepath: str, data: dict):
+    with open(filepath, 'w') as f:
+        f.write(json.dumps(data, indent=2, ensure_ascii=False))
+
+
+def _load_data_from_glossary():
+    try:
+        return json.loads(_load_from_storage(os.path.join('glossary', 'models-search-results.json'), glossary=True))
+    except Exception:
+        return None
+
+
+def enable_preload(
+    filepath: str = RESULTS_PATH,
+    node: dict = None,
+    overwrite_existing: bool = True,
+    use_glossary: bool = False
+):
     """
     Prefetch calls to HESTIA API in a local file.
 
@@ -22,6 +40,9 @@ def enable_preload(filepath: str = RESULTS_PATH, node: dict = None, overwrite_ex
     overwrite_existing : bool
         Optional - If the file already exists, the file can be used instead of generating it again.
         Will overwrite by default.
+    use_glossary : bool
+        Optional - Try to fetch search results from the glossary.
+        Only available with access to HESTIA infrastructure.
     """
     should_generate = overwrite_existing or not os.path.exists(filepath)
 
@@ -29,11 +50,10 @@ def enable_preload(filepath: str = RESULTS_PATH, node: dict = None, overwrite_ex
         logger.debug('Preloading search results and storing in %s', filepath)
 
         # build the search results
-        data = create_search_results()
+        data = (_load_data_from_glossary() if use_glossary else None) or create_search_results()
 
         # store in file
-        with open(filepath, 'w') as f:
-            f.write(json.dumps(data, indent=2, ensure_ascii=False))
+        _write_results(filepath, data)
 
     # enable mock search results from file
     _mock(filepath=filepath, node=node)

hestia_earth/models/utils/constant.py

@@ -2,6 +2,9 @@ from enum import Enum
 
 from hestia_earth.utils.tools import list_sum
 
+DAYS_IN_YEAR = 365.25
+DAYS_PER_MONTH = DAYS_IN_YEAR/12
+
 
 class Units(Enum):
     BOOLEAN = 'boolean'

hestia_earth/models/version.py

@@ -1 +1 @@
-VERSION = '0.64.13'
+VERSION = '0.64.14'

{hestia_earth_models-0.64.13.dist-info → hestia_earth_models-0.64.14.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hestia-earth-models
-Version: 0.64.13
+Version: 0.64.14
 Summary: HESTIA's set of modules for filling gaps in the activity data using external datasets (e.g. populating soil properties with a geospatial dataset using provided coordinates) and internal lookups (e.g. populating machinery use from fuel use). Includes rules for when gaps should be filled versus not (e.g. never gap fill yield, gap fill crop residue if yield provided etc.).
 Home-page: https://gitlab.com/hestia-earth/hestia-engine-models
 Author: HESTIA Team

{hestia_earth_models-0.64.13.dist-info → hestia_earth_models-0.64.14.dist-info}/RECORD

@@ -2,9 +2,9 @@ hestia_earth/__init__.py,sha256=G-d438vPx7m_ks5e9XTtM3u7LDRO5dSSukibukWmyPM,56
 hestia_earth/models/__init__.py,sha256=qEFeq3yuf3lQKVseALmL8aPM8fpCS54B_5pry00M3hk,76
 hestia_earth/models/cache_sites.py,sha256=KQp9cUKE-aIcYJoMWEtKFYS8gBFfsx5LKQhqoWpUSoM,6065
 hestia_earth/models/log.py,sha256=_zAfyOkL_VknEnMFvcpvenSMghadlDfZhiSx28545Gk,3558
-hestia_earth/models/preload_requests.py,sha256=Ds7eJqKfbiiaKqpRr69Z_GKUpYtP1j7XZKZX4Y9z7lE,1348
+hestia_earth/models/preload_requests.py,sha256=vK_G1UzhNMhYy7ymnCtHUz_vv3cfApCSKqv29VREEBQ,1943
 hestia_earth/models/requirements.py,sha256=eU4yT443fx7BnaokhrLB_PCizJI7Y6m4auyo8vQauNg,17363
-hestia_earth/models/version.py,sha256=O2ng3Prt7p6CASwtmwhPIY3YJRrj7f-b7V85PeEx470,20
+hestia_earth/models/version.py,sha256=4fHJn2y0KMV79wSdP8-3psf2aitG-bUGkvk9GQIo5qM,20
 hestia_earth/models/agribalyse2016/__init__.py,sha256=WvK0qCQbnYtg9oZxrACd1wGormZyXibPtpCnIQeDqbw,415
 hestia_earth/models/agribalyse2016/fuelElectricity.py,sha256=tnGxBmJdPfPFfehLUQcefEqy1lHvzsSpx_s7O8nf3Zs,4412
 hestia_earth/models/agribalyse2016/machineryInfrastructureDepreciatedAmountPerCycle.py,sha256=BPjnWmg73i_OxM2ouCdMTWZtPIqyoUAXrvutntyteE0,3390
@@ -52,6 +52,7 @@ hestia_earth/models/cycle/inorganicFertiliser.py,sha256=Yt5NcP9FQEzWwlritrPGbhh2
 hestia_earth/models/cycle/irrigatedTypeUnspecified.py,sha256=KlIa5eDvT47Twz6Q1kpw0rMlRjCK25CExaW58DEvc9w,2125
 hestia_earth/models/cycle/liveAnimal.py,sha256=5dlvuVAu24hLLOVXsozcVzWyDVzddzoungUBwrBDS-g,3986
 hestia_earth/models/cycle/longFallowRatio.py,sha256=_h0kub99sACO87IfjMeiu8IgdK2jaeBlgGA9A9-ViZA,1683
+hestia_earth/models/cycle/materialAndSubstrate.py,sha256=PaTnS3QVxGEMLMn4nuWHYp8npiZjDaDijRJHoUoRV40,5184
 hestia_earth/models/cycle/milkYield.py,sha256=JUwKK9gwXZiir7YK7_tOuV3B4Aml0LnJszfCA3Ygh3o,5816
 hestia_earth/models/cycle/otherSitesArea.py,sha256=Xhi6C1K1v4VXv1Mhkg-b9JCAG-DfTQoEi9ICs71418w,1650
 hestia_earth/models/cycle/otherSitesUnusedDuration.py,sha256=ZqQaI9FvNVpONmsIiRo1BqSJJKC5Mgi-W6lt18sxTiA,2985
@@ -252,8 +253,8 @@ hestia_earth/models/ipcc2019/belowGroundCropResidue.py,sha256=7AFU2Q0qPAvv6uEKWB
 hestia_earth/models/ipcc2019/biomass_utils.py,sha256=aMdAO-Ssfy1DKaNg19G9ea3z18MbfV6coqQjPu6Tu90,15584
 hestia_earth/models/ipcc2019/carbonContent.py,sha256=tlQvu4Auhpjmaz7XrZz86xwxVrJhsYYf8DFA_aQeev4,7255
 hestia_earth/models/ipcc2019/ch4ToAirAquacultureSystems.py,sha256=q6yyEiYQhHJ2VyQy2Fa84cuTl1D8bjBXOK3UpaRuo20,3196
-hestia_earth/models/ipcc2019/ch4ToAirEntericFermentation.py,sha256=3dRK2VaBqpaFbHYSUG_vmvS6nRGNCV5PycPva2-Dovc,11631
-hestia_earth/models/ipcc2019/ch4ToAirExcreta.py,sha256=eY_yb7ncTb_2HoUUgXZnnRHiybTXYj_DTe3CmDzD3fY,6717
+hestia_earth/models/ipcc2019/ch4ToAirEntericFermentation.py,sha256=JmvKP9n3IPO4RkGQ8o7aJ4axuJV_WKDRCFNR_AOmdyM,11685
+hestia_earth/models/ipcc2019/ch4ToAirExcreta.py,sha256=WnKmSQSqr1Jv7_95DLgtufPYGN5TeV3eDcFV3btDoq8,6706
 hestia_earth/models/ipcc2019/ch4ToAirFloodedRice.py,sha256=TJ4J7VA5n4RPrJYZQeR3lc3ZoCw7T1E5Cb1XJewr834,7331
 hestia_earth/models/ipcc2019/co2ToAirAboveGroundBiomassStockChange.py,sha256=fefPcxy7TTG-33dgZecDppMroUAmKoluhomyLuRqQiU,6545
 hestia_earth/models/ipcc2019/co2ToAirBelowGroundBiomassStockChange.py,sha256=l5Mrb8non9JjQhpWMzqHHK7FAjYPuWUzIwa08zdBUpo,6595
@@ -407,10 +408,10 @@ hestia_earth/models/linkedImpactAssessment/landTransformationFromOtherNaturalVeg
 hestia_earth/models/linkedImpactAssessment/landTransformationFromPermanentPasture100YearAverageInputsProduction.py,sha256=7btlXl5PL47qIjfs-w_xLZY_nsRnJAwTREtt8LpY6UI,1052
 hestia_earth/models/linkedImpactAssessment/landTransformationFromPermanentPasture20YearAverageInputsProduction.py,sha256=pdluhfRQuJK0EHq-L0s0TOf37tvOQYB-M-wZiuSbarw,1050
 hestia_earth/models/linkedImpactAssessment/utils.py,sha256=dGwGc2d-8_WQElTpfyPmz5vQtL-LHQRmiZnCTuPXMDs,1876
-hestia_earth/models/mocking/__init__.py,sha256=n3Fkkrvh8zHNWiJZmnfQ7WZ91JRzAO9P6pSG1JpwtXo,687
+hestia_earth/models/mocking/__init__.py,sha256=9VX50c-grz-snfd-7MBS0KfF7AadtbKuj7kK6PqtsgE,687
 hestia_earth/models/mocking/build_mock_search.py,sha256=p15ccEUmkmLp1RiGNznxMz3OFHbI8P1-29ExuohiQN8,1355
 hestia_earth/models/mocking/mock_search.py,sha256=ccFe_WrI73JElFmxp4hPNLCX7eeU--lBC1JFR901KJY,1069
-hestia_earth/models/mocking/search-results.json,sha256=zLe8af2LuObBNp2pcIIbIuHaaDhERHdSOFli7rBVHFs,101697
+hestia_earth/models/mocking/search-results.json,sha256=Ed4ijfv2ta8OS8JLWAIGp7Wj6RBZGDjymyTHt1EUGYQ,101690
 hestia_earth/models/pooreNemecek2018/__init__.py,sha256=nPboL7ULJzL5nJD5q7q9VOZt_fxbKVm8fmn1Az5YkVY,417
 hestia_earth/models/pooreNemecek2018/aboveGroundCropResidueTotal.py,sha256=Qt-mel4dkhK6N5uUOutNOinCTFjbjtGzITaaI0LvYc4,2396
 hestia_earth/models/pooreNemecek2018/belowGroundCropResidue.py,sha256=JT0RybbvWVlo01FO8K0Yj41HrEaJT3Kj1xfayr2X-xw,2315
@@ -577,7 +578,7 @@ hestia_earth/models/utils/aquacultureManagement.py,sha256=dxrbC1Xf140cohxTbSw6Tx
 hestia_earth/models/utils/array_builders.py,sha256=QEkM7e75Y9aq5yEPEk3R8md36IuvCDkpekdGm3uA0uk,19397
 hestia_earth/models/utils/blank_node.py,sha256=jLUWV0BZVX7NZ4Eo8pP5avV3QqI1HvvoHOAzNtfRe_E,50618
 hestia_earth/models/utils/completeness.py,sha256=2-GusD9UycobDZq8y5jar0ZcOjyqnSbzPRT_5XMc4YA,1259
-hestia_earth/models/utils/constant.py,sha256=AkZth53LHCdOPKfHzAnb18IYDualye7LkIX5ctBnNXg,3355
+hestia_earth/models/utils/constant.py,sha256=6wLx8xb2R8HtpEpVy5e-PbioOo7QCu2n-W72fs6OvgE,3411
 hestia_earth/models/utils/crop.py,sha256=5KigEHd15nT8O9_1woxKJF5rEWiSkIkJqDAXet8BB9g,2383
 hestia_earth/models/utils/cropResidue.py,sha256=_0Q35CrliJeo31xGHsPWe8A2oHxijdIsOrf3gBEqhlA,612
 hestia_earth/models/utils/cropResidueManagement.py,sha256=nIDFjf39rDD10UHSVudfDyu-EiL261g8jyrgS-2aDKw,347
@@ -667,6 +668,7 @@ tests/models/cycle/test_inorganicFertiliser.py,sha256=c-JDYC0qDK4JWlYDaGX53AcKfe
 tests/models/cycle/test_irrigatedTypeUnspecified.py,sha256=9YGwpDO_RHMaldvjJZ0xdrdfUzYDnLPt6nMJ2eRXSTI,2151
 tests/models/cycle/test_liveAnimal.py,sha256=rKcd4GKl9kKlp4bft3HEr58Btv-cPQq94XdAL9O1ky8,2138
 tests/models/cycle/test_longFallowRatio.py,sha256=sztr1pysldwedTC78JWUHAVWl2oL0jTIQ13c6Nxzlso,1512
+tests/models/cycle/test_materialsAndSubstrate.py,sha256=pYaNZiLVmmogAebUZjOri41pa7k78gjy7OOD8OXm4bk,1429
 tests/models/cycle/test_milkYield.py,sha256=gl0e9O0idVT6ld9mGc--EYWTJo452C2HOzGzHKrsq_g,1777
 tests/models/cycle/test_otherSitesArea.py,sha256=Mop7guZXEyX4ZFOBpqzsbu-cuaBFAqfIRZhe-WEvVwc,2131
 tests/models/cycle/test_otherSitesUnusedDuration.py,sha256=zQejrYNwq14Pwe3d0zmfhxjdif5s_udbdVCiZcTuC8w,1635
@@ -1181,8 +1183,8 @@ tests/models/utils/test_term.py,sha256=M5Sa26v2gzQYbZ4H_fo7DspnaCx__-WtL-MULGapC
 tests/models/utils/test_time_series.py,sha256=LMhRPf8rp3nAriKAC-2K3FDkrMWntRTUUCERw7Lt68g,2686
 tests/models/webbEtAl2012AndSintermannEtAl2012/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/models/webbEtAl2012AndSintermannEtAl2012/test_nh3ToAirOrganicFertiliser.py,sha256=qi2FNXS5Af2WDtm7nq_FsprH3BfCF0XxnE0XHmC4aIY,2244
-hestia_earth_models-0.64.13.dist-info/LICENSE,sha256=AC7h7GAgCZGJK_Tzh6LUCrML9gQEfowWwecEw2w54QM,1154
-hestia_earth_models-0.64.13.dist-info/METADATA,sha256=-tsPy413szeE61Dd1h2judZ_9NToonyRp08fvj4BpFQ,3345
-hestia_earth_models-0.64.13.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-hestia_earth_models-0.64.13.dist-info/top_level.txt,sha256=1dqA9TqpOLTEgpqa-YBsmbCmmNU1y56AtfFGEceZ2A0,19
-hestia_earth_models-0.64.13.dist-info/RECORD,,
+hestia_earth_models-0.64.14.dist-info/LICENSE,sha256=AC7h7GAgCZGJK_Tzh6LUCrML9gQEfowWwecEw2w54QM,1154
+hestia_earth_models-0.64.14.dist-info/METADATA,sha256=1pXWSGo_8_6-tjNKemoxLZb9wQa56Mbsu30jzIt84v8,3345
+hestia_earth_models-0.64.14.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+hestia_earth_models-0.64.14.dist-info/top_level.txt,sha256=1dqA9TqpOLTEgpqa-YBsmbCmmNU1y56AtfFGEceZ2A0,19
+hestia_earth_models-0.64.14.dist-info/RECORD,,

tests/models/cycle/test_materialsAndSubstrate.py

@@ -0,0 +1,49 @@
+from unittest.mock import patch
+import json
+import pytest
+from hestia_earth.utils.tools import to_precision
+
+from tests.utils import fixtures_path, fake_new_input
+from hestia_earth.models.cycle.materialAndSubstrate import MODEL, MODEL_KEY, run, calculate_value
+
+class_path = f"hestia_earth.models.{MODEL}.{MODEL_KEY}"
+fixtures_folder = f"{fixtures_path}/{MODEL}/{MODEL_KEY}"
+
+
+@pytest.mark.parametrize(
+    "input_node,cycle_duration,expected_result,test_name",
+    [
+        (
+            {"lifespan": 3, "value": [150]},
+            200,
+            27.4,
+            "lifespan, value and duration"
+        ),
+        (
+            {"lifespan": 5},
+            200,
+            None,
+            "missing value"
+        ),
+    ]
+)
+def test_calculate_value(input_node, cycle_duration, expected_result, test_name):
+    result = calculate_value(
+        input_node=input_node,
+        field_name="value",
+        cycle_duration=cycle_duration
+    )
+    rounded_result = to_precision(result, 3) if result is not None else None
+    assert rounded_result == expected_result, test_name
+
+
+@patch(f"{class_path}._new_input", side_effect=fake_new_input)
+def test_run(*args):
+    with open(f"{fixtures_folder}/cycle.jsonld", encoding='utf-8') as f:
+        site = json.load(f)
+
+    with open(f"{fixtures_folder}/result.jsonld", encoding='utf-8') as f:
+        expected = json.load(f)
+
+    result = run(site)
+    assert result == expected