lca-algebraic 1.4.1.dev3__tar.gz → 1.4.1.dev6__tar.gz

{lca_algebraic-1.4.1.dev3 → lca_algebraic-1.4.1.dev6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lca_algebraic
-Version: 1.4.1.dev3
+Version: 1.4.1.dev6
 Summary: This library provides a layer above Brightway for defining parametric models and running super fast LCA for monte carlo analysis.
 Author-email: OIE - Mines ParisTech <raphael.jolivet@mines-paristech.fr>
 License: BSD
@@ -41,6 +41,7 @@ Requires-Dist: pre-commit; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: nbmake; extra == "dev"
 Requires-Dist: build; extra == "dev"
+Requires-Dist: twine>=6.1; extra == "dev"
 Dynamic: license-file
 
 

{lca_algebraic-1.4.1.dev3 → lca_algebraic-1.4.1.dev6}/lca_algebraic/activity.py

@@ -13,12 +13,14 @@ from lca_algebraic.bw_wrapper import (
     Activity,
     Exchange,
     ExchangeDataset,
+    activity_not_found,
     copy_activity_skip_keys,
     dict_as_exchangedataset,
     exchange_type_for_sub_act,
     get_activity,
     process_node_default,
     production_edge_default,
+    purge_activity_content,
 )
 from lca_algebraic.database import (
     _find_biosphere_db,
@@ -29,6 +31,7 @@ from lca_algebraic.database import (
 )
 from lca_algebraic.params import (
     STORE_FORMULA_KEY,
+    STORE_FORMULA_TAG,
     DbContext,
     ParamDef,
     _complete_and_expand_params,
@@ -167,6 +170,11 @@ class ActivityExtended(Activity):
                 or activity for updating only input,
             or dict of attributes, for updating both at once, or any other attribute.
             The amount can reference the symbol 'old_amount' that will be replaced with the current amount of the exchange.
+
+            Passing a dict of attributes is also the way to tag a single exchange with an axis \
+            (see ``compute_impacts``) : only that exchange will be ventilated under the category::
+
+                myActivity.updateExchanges({some_act: dict(amount=2, phase="transport")})
         """
         if not _isForeground(self["database"]) and not Settings.internals:
             msg = f"You are updating a background activity in {self['database']}. Use copyActivity() in a foreground db instead."
@@ -318,6 +326,9 @@ class ActivityExtended(Activity):
     def _amount_to_formula(self, amount: ValueOrExpression, exchange: ExchangeDataset):
         res = dict()
         if isinstance(amount, Basic):
+            if amount.is_number:
+                return {"amount": float(amount.evalf())}
+
             current_amount = exchange.get("amount", None)
             if current_amount is not None:
                 amount = amount.subs(old_amount, current_amount)
@@ -329,8 +340,9 @@ class ActivityExtended(Activity):
                     raise Exception("Symbol '%s' not found in params : %s" % (symbol, all_symbols))
 
             res[STORE_FORMULA_KEY] = str(amount)
+            res[STORE_FORMULA_TAG] = True
             res["amount"] = 0
-        elif isinstance(amount, float) or isinstance(amount, int):
+        elif isinstance(amount, float | int):
             res["amount"] = amount
         else:
             raise Exception(
@@ -349,6 +361,9 @@ class ActivityExtended(Activity):
             # Update units
             amount = self._transform_unit(amount, exchange["unit"])
 
+            updates.pop(STORE_FORMULA_TAG, None)
+            exchange.pop(STORE_FORMULA_TAG, None)
+
             # Extract formula if two separate field "amount" and "formula"
             # Update the list of updates
             updates.update(self._amount_to_formula(amount, exchange))
@@ -392,7 +407,14 @@ class ActivityExtended(Activity):
                 yield exch
 
     def updateMeta(self, **kwargs):
-        """Update any property. Useful to update axes"""
+        """Update any custom property of the activity.
+
+        This is typically used to tag an activity with an axis : all its outgoing
+        exchanges will then be ventilated under that category by ``compute_impacts``::
+
+            myActivity.updateMeta(phase="manufacturing")
+            compute_impacts(model, methods, axis="phase")
+        """
         for key, val in kwargs.items():
             self._data[key] = val
         self.save()
@@ -475,6 +497,11 @@ def findActivity(
             search = search.lower()
             search = search.replace(",", " ")
 
+            # bw2data >= 4 backs `search` with FTS5, which rejects blank queries
+            # while bw2data 3 silently returned nothing.
+            if not search.strip():
+                return []
+
             # Find candidates via index
             # candidates = _find_candidates(db_name, name_key)
             candidates = _getDb(db_name).search(search, limit=limit)
@@ -482,7 +509,8 @@ def findActivity(
             if len(candidates) == 0:
                 # Try again removing strange caracters
                 search = re.sub(r"\w*[^a-zA-Z ]+\w*", " ", search)
-                candidates = _getDb(db_name).search(search, limit=limit)
+                if search.strip():
+                    candidates = _getDb(db_name).search(search, limit=limit)
 
             # Exact match
             return list(filter(act_filter, candidates))
@@ -546,13 +574,19 @@ def _newAct(db_name, code):
         warn(msg)
 
     db = _getDb(db_name)
-    # Already present : delete it ?
-    for act in db:
-        if act["code"] == code:
-            warn("Activity '%s' was already in '%s'. Overwriting it" % (code, db_name))
-            act.delete()
 
-    return db.new_activity(code)
+    try:
+        act = getActByCode(db_name, code)
+    except activity_not_found():
+        return db.new_activity(code)
+
+    # Already present : overwrite it in place.
+    # We must not delete+recreate the activity : on brightway 2.5, deleting an
+    # activity also removes the incoming links (exchanges from other activities
+    # consuming it), which would silently break previously built models.
+    warn("Activity '%s' was already in '%s'. Overwriting it" % (code, db_name))
+    purge_activity_content(act)
+    return act
 
 
 def newActivity(
@@ -630,7 +664,7 @@ def newActivity(
 
 @atomic
 def copyActivity(
-    db_name, activity: ActivityExtended, code=None, withExchanges=True, input_mapping=None, **kwargs
+    db_name, activity: ActivityExtended, code=None, withExchanges=True, stripFormula=True, input_mapping=None, **kwargs
 ) -> ActivityExtended:
     """Copy an activity and its exchanges into another database. You usually want to copy activities from your background to
     your foreground DB to update them, keeping your background DB clean.
@@ -643,7 +677,10 @@ def copyActivity(
         Source activity
     code:
         Code of the target activity. Also used as its name
-
+    withExchange:
+        Copy exchanges is True (default), otherwise do not copy them
+    stripFormula:
+        keep exchanges formula if True, default is False
 
     Returns
     -------
@@ -680,7 +717,7 @@ def copyActivity(
 
         # Chemical formulas might be in ecoinvent technosphere
         # We don't want them
-        if "formula" in data:
+        if stripFormula and ("formula" in data) and (STORE_FORMULA_TAG not in data):
             del data["formula"]
         ExchangeDataset.create(**dict_as_exchangedataset(data))
 

{lca_algebraic-1.4.1.dev3 → lca_algebraic-1.4.1.dev6}/lca_algebraic/base_utils.py

@@ -3,14 +3,16 @@ from functools import cache
 from inspect import isfunction
 from typing import Dict, Iterable, Tuple, Union
 
+import sympy
 import ipywidgets as widgets
 import numpy as np
 import pandas as pd
 from IPython.display import display
 from six import raise_from
 from sympy import Basic
-from sympy.physics.units import Quantity
+from pint import Quantity
 
+from lca_algebraic.settings import Settings
 from lca_algebraic.bw_wrapper import Activity, Database, is_output_exchange
 
 _user_functions = dict()
@@ -48,14 +50,23 @@ def _getDb(dbname):
     return dbs[dbname]
 
 
-def Max(a, b):
-    """Max define as algrebraic forumal with 'abs' for proper computation on vectors"""
-    return (a + b + abs(a - b)) / 2
+def _MinMax(op, arg0, *args):
+    from lca_algebraic.units import unit_registry as u
 
+    if not Settings.units_enabled:
+        return op(arg0, *args)
+    same_unit = all(x.units == arg0.units for x in args)
+    if not same_unit:
+        raise Exception("MinMax argments must have the same units")
+    return u.Quantity(op(arg0.magnitude, *[x.magnitude for x in args]), arg0.units)
 
-def Min(a, b):
-    """Max define as algrebraic forumal with 'abs' for proper computation on vectors"""
-    return (a + b - abs(b - a)) / 2
+
+def Max(arg0, *args):
+    return _MinMax(sympy.Max, arg0, *args)
+
+
+def Min(arg0, *args):
+    return _MinMax(sympy.Min, arg0, *args)
 
 
 def _actDesc(act: Activity):

{lca_algebraic-1.4.1.dev3 → lca_algebraic-1.4.1.dev6}/lca_algebraic/bw_wrapper/__init__.py

@@ -111,6 +111,10 @@ def copy_activity_skip_keys() -> set:
     return _backend.copy_activity_skip_keys()
 
 
+def purge_activity_content(act) -> None:
+    _backend.purge_activity_content(act)
+
+
 def bw2setup() -> None:
     _backend.bw2setup()
 
@@ -146,5 +150,6 @@ __all__ = [
     "process_node_default",
     "production_edge_default",
     "projects",
+    "purge_activity_content",
     "sqlite3_lci_db",
 ]

{lca_algebraic-1.4.1.dev3 → lca_algebraic-1.4.1.dev6}/lca_algebraic/bw_wrapper/bw2.py

@@ -91,6 +91,16 @@ class BW2Backend:
     def copy_activity_skip_keys(self) -> set:
         return {"database", "code"}
 
+    def purge_activity_content(self, act) -> None:
+        """Remove an activity's outgoing exchanges and non-identity attributes.
+
+        The activity row, its code and the incoming links (exchanges of other
+        activities pointing to it) are preserved.
+        """
+        act.exchanges().delete()
+        for key in [k for k in act._data if k not in {"database", "code"}]:
+            del act._data[key]
+
     def bw2setup(self):
         bw.bw2setup()
 

{lca_algebraic-1.4.1.dev3 → lca_algebraic-1.4.1.dev6}/lca_algebraic/bw_wrapper/bw25.py

@@ -108,6 +108,16 @@ class BW25Backend:
     def copy_activity_skip_keys(self) -> set:
         return {"database", "code", "id"}
 
+    def purge_activity_content(self, act) -> None:
+        """Remove an activity's outgoing exchanges and non-identity attributes.
+
+        The activity row, its code and the incoming links (exchanges of other
+        activities pointing to it) are preserved.
+        """
+        act.exchanges().delete(allow_in_sourced_project=True)
+        for key in [k for k in act._data if k not in {"database", "code", "id"}]:
+            del act._data[key]
+
     def bw2setup(self) -> None:
         raise NotImplementedError("bw2setup is only supported with brightway2")
 

{lca_algebraic-1.4.1.dev3 → lca_algebraic-1.4.1.dev6}/lca_algebraic/bw_wrapper/protocol.py

@@ -74,6 +74,9 @@ class BrightwayBackend(Protocol):
     def copy_activity_skip_keys(self) -> set:
         ...
 
+    def purge_activity_content(self, act) -> None:
+        ...
+
     def bw2setup(self) -> None:
         ...
 

{lca_algebraic-1.4.1.dev3 → lca_algebraic-1.4.1.dev6}/lca_algebraic/cache.py

@@ -1,5 +1,6 @@
 import os
 import time
+from base64 import b32encode
 from collections.abc import MutableMapping
 from datetime import datetime
 from os import path
@@ -19,6 +20,10 @@ EXPR_CACHE = "expr"
 MAPPING_CACHE = "mapping"
 
 
+def _filename_encode(s: str):
+    return b32encode(s.encode("utf-8")).decode("utf-8")
+
+
 # Overide the behaviour for pickling sympy.UndefineFunction
 class MyPickler(Pickler):
     def reducer_override(self, obj):
@@ -44,8 +49,16 @@ def flush_caches():
         cache.sync()
 
 
-def get_dependant_dbs(db_name, skip_proxy=True):
-    """Recursively get list of dependant db names, including the current one"""
+def get_dependant_dbs(db_name, skip_proxy=None):
+    """Recursively get list of dependant db names, including the current one
+
+    Proxy databases are skipped unless background factorization is enabled : with
+    ``factorize_static_bg`` the developed expressions / LCIA of a database refer to
+    the acts of its ``<db>-proxy`` databases, so a change of those proxies must be
+    visible (see the staleness check in ``_CacheDict``).
+    """
+    if skip_proxy is None:
+        skip_proxy = not Settings.factorize_static_bg
 
     # Only work if database is up to date (processed)
     if databases[db_name].get("dirty"):
@@ -89,7 +102,9 @@ class SyncDict(MutableMapping):
         self.load()
 
     def _filename(self):
-        return path.join(projects.dir, f"lca_algebraic_cache-{self.name}-{self.db_name}.pickle")
+        return path.join(
+            projects.dir, f"lca_algebraic_cache-{_filename_encode(self.name)}-{_filename_encode(self.db_name)}.pickle"
+        )
 
     # ---------- core MutableMapping ----------
     def __getitem__(self, key):

{lca_algebraic-1.4.1.dev3 → lca_algebraic-1.4.1.dev6}/lca_algebraic/lambda_expression.py

@@ -3,6 +3,7 @@ from dataclasses import dataclass
 from typing import Dict, List, Optional
 
 from sympy import Basic, Expr, lambdify, parse_expr
+from sympy.core import S
 from sympy.printing.numpy import NumPyPrinter
 
 from lca_algebraic.axis_dict import AxisDict
@@ -19,6 +20,32 @@ from lca_algebraic.settings import CSE, Settings
 from lca_algebraic.sympy_utils import find_cses, find_symbols
 
 
+class NumPyPrinterExt(NumPyPrinter):
+    def __init__(self, settings=None):
+        super().__init__(settings=settings)
+
+    def _helper_piecewise(self, *args):
+        from sympy.logic.boolalg import ITE, simplify_logic
+
+        def print_cond(cond):
+            """Problem having an ITE in the cond."""
+            if cond.has(ITE):
+                return self._print(simplify_logic(cond))
+            else:
+                return self._print(cond)
+
+        return "{}({},{},{})".format(
+            self._module_format(self._module + ".where"),
+            print_cond(args[0].cond),
+            self._print(args[0].expr),
+            self._helper_piecewise(*args[1:]) if len(args) > 1 else self._print(S.NaN),
+        )
+
+    def _print_Piecewise(self, expr):
+        "Piecewise function printer"
+        return self._helper_piecewise(*expr.args)
+
+
 @dataclass
 class ValueContext:
     """Represents a result value, with all parameters values used in context"""
@@ -172,7 +199,7 @@ class LambdWrapper:
 def _lambdify(expr: Basic, expanded_params):
     """Lambdify, handling manually the case of SymDict (for impacts by axis)"""
 
-    printer = NumPyPrinter(
+    printer = NumPyPrinterExt(
         {"fully_qualified_modules": False, "inline": True, "allow_unknown_functions": True, "user_functions": dict()}
     )