edges 1.0.2__py3-none-any.whl → 1.0.3__py3-none-any.whl

edges/uncertainty.py

@@ -1,5 +1,6 @@
 """
-This module contains the Uncertainty class, which is responsible for handling
+Utilities for uncertainty handling: RNG derivation, cache keys, canonicalization,
+and sampling of characterization-factor (CF) uncertainty distributions.
 """
 
 import numpy as np
@@ -17,6 +18,13 @@ logger.addHandler(logging.NullHandler())
 
 
 def get_rng_for_key(key: str, base_seed: int) -> np.random.Generator:
+    """
+    Derive a reproducible RNG from a base seed and a string key.
+
+    :param key: Arbitrary identifier (e.g., CF uncertainty fingerprint).
+    :param base_seed: Base integer seed.
+    :return: Numpy random.Generator instance initialized from derived seed.
+    """
     key_digest = int(hashlib.sha256(key.encode()).hexdigest(), 16) % (2**32)
     seed = base_seed + key_digest
     logger.debug("Creating RNG with derived seed %d for key %s", seed, key)
@@ -24,7 +32,12 @@ def get_rng_for_key(key: str, base_seed: int) -> np.random.Generator:
 
 
 def make_distribution_key(cf):
-    """Generate a hashable cache key for CF uncertainty sampling."""
+    """
+    Generate a stable, hashable cache key for a CF's uncertainty block.
+
+    :param cf: CF dictionary potentially containing an 'uncertainty' entry.
+    :return: JSON string key without 'negative' flag, or None if no uncertainty.
+    """
     unc = cf.get("uncertainty")
     if unc:
         unc_copy = dict(unc)  # shallow copy
@@ -38,10 +51,14 @@ def make_distribution_key(cf):
 
 def _canon_atom(item):
     """
-    Return (canonical_object, fingerprint_string) for a mixture atom.
-    - If item is a nested distribution dict, remove 'negative', and for
-      discrete_empirical recursively canonicalize and sort by fingerprint.
-    - If item is a scalar or expression string, return as-is with a const fingerprint.
+    Canonicalize a mixture atom and return its fingerprint.
+
+    - If ``item`` is a distribution dict, remove 'negative'; for
+      ``discrete_empirical`` recursively canonicalize children and merge duplicates.
+    - If scalar or expression string, return as-is.
+
+    :param item: Scalar, expression string, or distribution dict.
+    :return: Tuple (canonical_object, fingerprint_string).
     """
     if isinstance(item, dict) and "distribution" in item:
         clean = deepcopy(item)
@@ -92,8 +109,20 @@ def sample_cf_distribution(
     SAFE_GLOBALS: dict = None,
 ) -> np.ndarray:
     """
-    Generate n random CF values from the distribution info in the 'uncertainty' key.
-    Falls back to a constant value if no uncertainty. If 'negative' == 1, samples are negated.
+    Draw samples from the CF's uncertainty distribution (or constant fallback).
+
+    If no uncertainty or distributions are disabled, returns a length-``n`` array
+    filled with the (possibly evaluated) deterministic CF value.
+
+    :param cf: CF dictionary with 'value' and optional 'uncertainty' specification.
+    :param n: Number of samples to generate.
+    :param parameters: Parameter dict for evaluating expression atoms.
+    :param random_state: RNG to use for sampling.
+    :param use_distributions: If False, bypass uncertainty and return constants.
+    :param SAFE_GLOBALS: Safe globals for expression evaluation.
+    :return: NumPy array of shape (n,) with sampled CF values.
+
+    :raises ValueError: If sampling fails due to invalid distribution parameters.
     """
     if not use_distributions or cf.get("uncertainty") is None:
         # If value is a string (expression), evaluate once

{edges-1.0.2.dist-info → edges-1.0.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: edges
-Version: 1.0.2
+Version: 1.0.3
 Summary: Country-specific characterization factors for the Brightway LCA framework
 Author-email: Romain Sacchi <romain.sacchi@psi.ch>, Alvaro Hahn Menacho <alvaro.hahn-menacho@psi.ch>
 Maintainer-email: Romain Sacchi <romain.sacchi@psi.ch>
@@ -23,10 +23,13 @@ Requires-Dist: bw2calc
 Requires-Dist: bw2data
 Requires-Dist: bw2io
 Requires-Dist: bw2analyzer
-Requires-Dist: constructive_geometries
+Requires-Dist: country_converter>=1.3.1
+Requires-Dist: constructive_geometries>=1.0.0
 Requires-Dist: prettytable
 Requires-Dist: sparse>=0.13.0
 Requires-Dist: highspy
+Requires-Dist: plotly
+Requires-Dist: ecoinvent_interface
 Provides-Extra: testing
 Requires-Dist: setuptools; extra == "testing"
 Requires-Dist: pytest; extra == "testing"

edges-1.0.3.dist-info/RECORD

@@ -0,0 +1,57 @@
+edges/__init__.py,sha256=2TkmZVz-J7rouzuC4OY8pyh3W8u_B3f4wyUqBaWlyso,499
+edges/analysis.py,sha256=FkJzqFkormYOzhEP5p7YGsmxwN66JdMfktokGRUKjKI,7388
+edges/costs.py,sha256=OV46FS627fw6BikbRvtWWdXRvt4oRl8zsA9-Z8bdOkU,23399
+edges/edgelcia.py,sha256=qay_QO7plyxk14zzwUAj45WMCC4SFdqtmwUr3QUBMeU,162598
+edges/filesystem_constants.py,sha256=FSH8hW84V1MCMvo8UOeZKM5Up26ls6bLbTRvfMl2tAg,207
+edges/flow_matching.py,sha256=_dBQ9X4D1u_x1KttXmZkK8pXOlicmUMyDAoOOt6G7tw,35858
+edges/georesolver.py,sha256=fe_8hNgUsUfBgUP2SCfUPrRifhCJ4Vyth1K8gWFSI1Q,5770
+edges/logging_config.py,sha256=zZLxKsh7on0v9HaGBp45ynqTrEuDa3wPgMvTognoum0,1231
+edges/matrix_builders.py,sha256=vXl80pKfIeXWkYkTJsD4c8aVrFexWncqwl1saA0gRCM,1800
+edges/supply_chain.py,sha256=uzcPg0Oo0DxgIphTQAsOOVUTNwTsHIqTFjjPGDLxlmY,71690
+edges/uncertainty.py,sha256=mAYu4Jxxp1wQ2SRTav3_PTb-Z0yxXUYi5XagTCJfw1k,8882
+edges/utils.py,sha256=boVrCOeq4RZjbQ8u-xPMPdiE3uYwXBVfLqRO6NuYkBI,14868
+edges/data/AWARE 2.0_Country_all_yearly.json,sha256=GUk5iuqTey6ldT4dsaeQxxrmPKf3y9wA78e4cvRedsQ,13187711
+edges/data/AWARE 2.0_Country_irri_yearly.json,sha256=nyphUBxJwokmD1KIEHwCun29pAMFiMDXbuAKxmnvcNE,3068388
+edges/data/AWARE 2.0_Country_non_irri_yearly.json,sha256=aObCM8De_XKYB4V_vD3VMSbZuiX29t3QFWCFXq4LGFs,4503080
+edges/data/AWARE 2.0_Country_unspecified_yearly.json,sha256=MniR1UWaiFTpR8u7zeKimCdpLvAUGB0iclICSsg0BGA,3806405
+edges/data/GeoPolRisk_paired_2024.json,sha256=MQbN4gr--LBNc30gjAltl3ybKodUZgVKauhP2j6ELws,21543080
+edges/data/ImpactWorld+ 2.1_Freshwater acidification_damage.json,sha256=Ywvgmadc2jnFOEc4BrI9R-PTRcaJbelb0r2q2qjQR5c,7347676
+edges/data/ImpactWorld+ 2.1_Freshwater acidification_midpoint.json,sha256=YmAdsMst0ewBCEgJlfz-Ruue3Zf06AZCl0o4MbG-Fxc,7363074
+"edges/data/ImpactWorld+ 2.1_Freshwater ecotoxicity, long term_damage.json",sha256=PmOJacNlhO6P_5YxukIBRqMFQIRtI0nNxWZDjN4BBco,76643
+"edges/data/ImpactWorld+ 2.1_Freshwater ecotoxicity, short term_damage.json",sha256=qg3K1q6QCbvOfwWrPCHV4NfxaXPTHZzQoXpVrxBVQAI,779650
+edges/data/ImpactWorld+ 2.1_Freshwater ecotoxicity_midpoint.json,sha256=jyBBLCRQiNRRhKiGozrqdmm8nBK81axfcBim3uK4u9Q,815678
+edges/data/ImpactWorld+ 2.1_Freshwater eutrophication_damage.json,sha256=fFEFoJyRVFRWH0NmZJEfgIi26oVomzMKzieUkVFspkc,1064016
+edges/data/ImpactWorld+ 2.1_Freshwater eutrophication_midpoint.json,sha256=Hs9S5AoAiyzaHiTa9iPNZxlmjQGooJaILsrlqjVt9Cg,1065652
+"edges/data/ImpactWorld+ 2.1_Land occupation, biodiversity_damage.json",sha256=zDhegsaCbMN7lyrNf1FHnKXhxro6zXfMNtNMZxuHmwc,3495866
+"edges/data/ImpactWorld+ 2.1_Land occupation, biodiversity_midpoint.json",sha256=e_5s265gxPHXhYV9HE0oiTZSRwhIJ5pnPSg203spjuU,3532271
+"edges/data/ImpactWorld+ 2.1_Land transformation, biodiversity_damage.json",sha256=Ldezmpp15IL9G0gS1dTE6E-tTRmMgUbzaTfSFp-0xSE,7396774
+"edges/data/ImpactWorld+ 2.1_Land transformation, biodiversity_midpoint.json",sha256=TTHFupTp9j6X5tVrbb7HbOLncFeWF8w27FE2gbGlMCE,7398060
+"edges/data/ImpactWorld+ 2.1_Marine ecotoxicity, long term_damage.json",sha256=0vxy2w7qU2oYHxJU2hAzo6NTeFAaUC_hL6gBghyndRk,77107
+"edges/data/ImpactWorld+ 2.1_Marine ecotoxicity, short term_damage.json",sha256=U3yJNzZXWT5dS5MOc5okU7BtV_gdfb9eJjABEDgRoSE,503498
+edges/data/ImpactWorld+ 2.1_Marine eutrophication_damage.json,sha256=ZL5mnqT735QYU9gr_iPv1NYWYflhEEBw8HsfS0bDNbs,3239319
+edges/data/ImpactWorld+ 2.1_Marine eutrophication_midpoint.json,sha256=7YnEvbrGNdoErKsZlmhOn2d1fn-Rtk1eKpe8gmMMons,3255717
+edges/data/ImpactWorld+ 2.1_Particulate matter formation_damage.json,sha256=7RsI7WAn3KA7lAzE9loRt4ccYmAJdEZ9y1d8xbp5cvE,4789093
+edges/data/ImpactWorld+ 2.1_Particulate matter formation_midpoint.json,sha256=gOfwulmqGohE-hdHtc9liNBLoHbO8qeShSD-MnqndgA,4751910
+"edges/data/ImpactWorld+ 2.1_Photochemical ozone formation, ecosystem quality_damage.json",sha256=rVyntaoX_YWrAqBBceCfGR5tPslTFeaTgHiC8miCnjY,1605778
+"edges/data/ImpactWorld+ 2.1_Photochemical ozone formation, human health_damage.json",sha256=SzYS0IKPbu1_-Qi5PwQqqicAjICF7f1Z_ii0om-_oVU,1561128
+edges/data/ImpactWorld+ 2.1_Photochemical ozone formation_midpoint.json,sha256=XmdKthzjkzhX5LzhKKywOXCE-7opXR8LR7dyNFT32C0,1536243
+edges/data/ImpactWorld+ 2.1_Terrestrial acidification_damage.json,sha256=34WlRAprwyh-6_zA6k5f1SCjufvhzclggoaeNQsta4E,6915100
+edges/data/ImpactWorld+ 2.1_Terrestrial acidification_midpoint.json,sha256=pogNwb8AxKA6kU0UMRqX501bBaUmn3k0sioUTV5TTNc,6934476
+"edges/data/ImpactWorld+ 2.1_Terrestrial ecotoxicity, long term_damage.json",sha256=u91iUVoTR_ZImVU9xfP7OzDaW6S4CS1A1NfYDH9FX1E,76176
+"edges/data/ImpactWorld+ 2.1_Terrestrial ecotoxicity, short term_damage.json",sha256=PHFAAxli_Y6SoiIsqHScg3W-s4L-ymZLDrK9vUXRwGc,499759
+edges/data/ImpactWorld+ 2.1_Thermally polluted water_damage.json,sha256=pBxi8kyEhtbW_ix33VYTpUbQR8KY8FIwbkV3ot1axy0,751297
+"edges/data/ImpactWorld+ 2.1_Water availability, freshwater ecosystem_damage.json",sha256=yzHInvXwP5BzPX3vt1WJ8oOTU7-zLbBrpVRKFnU_Z5c,2583169
+"edges/data/ImpactWorld+ 2.1_Water availability, human health_damage.json",sha256=2iEoZox2T39P7V03VWUK8Si_CEswktxxK-IOxttKCVE,1614840
+"edges/data/ImpactWorld+ 2.1_Water availability, terrestrial ecosystem_damage.json",sha256=ckzYIQDlw75ncdxE9gPulSjas_GprADYCTjfztKoyBo,349788
+edges/data/ImpactWorld+ 2.1_Water scarcity_midpoint.json,sha256=MT4emQvNct1H3siThXPaQJD5NPOl5WPFOaFQLATmAPQ,2541699
+edges/data/LCC 1.0_2023.json,sha256=WzifNW7ZKvDOK7Q0zkkfpyw-j_sefvAuSNHTnLe1GGk,3124883
+edges/data/RELICS_copper_primary.json,sha256=6CgXD18X0V77jtC3DvDFZuvKDO1_Wh6hAMoUe6KEtBE,880
+edges/data/RELICS_copper_secondary.json,sha256=1an5CynzT8paqoV0ugVDJotv4PhkOh-_h8ZWJCUiCEA,860
+edges/data/SCP_1.0.json,sha256=OCZK7W9OFciWIyXTi8i1oUD1WBvuxN4Btw9eFLjy_cQ,60137
+edges/data/metadata/gdp.yaml,sha256=_I13ZlffUigydP74iGA6eTTNmZdup70KP1GiFQkxRDQ,5509
+edges/data/metadata/missing_geographies.yaml,sha256=eTzO-I642ecG49_nn03fGPgWl-60VCYstWLjGk4h0i8,33
+edges/data/metadata/population.yaml,sha256=BnNaYnx2SrfJLf1lf1-fKfG9JIilC95StgJiCu2so3I,4769
+edges-1.0.3.dist-info/METADATA,sha256=fPSU1MiCHhmRZgwjtMiOURNokqojsKi17quNooaE3fk,10078
+edges-1.0.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+edges-1.0.3.dist-info/top_level.txt,sha256=85BmdR7cFR5dfKfZ4mdJ4omGk9t4C89GE6N0RS3CCGA,6
+edges-1.0.3.dist-info/RECORD,,