antelope-interface 0.3.1__tar.gz → 0.3.3__tar.gz

{antelope_interface-0.3.1/src/antelope_interface.egg-info → antelope_interface-0.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: antelope_interface
-Version: 0.3.1
+Version: 0.3.3
 Summary: A common interface for accessing LCA data
 Author-email: Brandon Kuczenski <bkuczenski@ucsb.edu>
 License: BSD-3-Clause

{antelope_interface-0.3.1 → antelope_interface-0.3.3}/pyproject.toml

@@ -22,7 +22,7 @@ classifiers = [
         "Topic :: Scientific/Engineering"
 ]
 dependencies = ["synonym_dict >= 0.2.4", "pydantic >= 2.5.0"]
-version = "0.3.1"
+version = "0.3.3"
 
 [tool.setuptools.packages.find]
 where = ["src"]

{antelope_interface-0.3.1 → antelope_interface-0.3.3}/setup.py

@@ -5,6 +5,10 @@ setup()
 
 """
 Version History:
+0.3.3  2025/09/08 - Apply ordering to exchange refs; pandas-friendly output for process refs
+
+0.3.2  2025/08/01 - 0.3.2 release. better background handling.
+
 0.3.1  2025/06/18 - 0.3.1 release. small tweaks to method signatures.
 
 0.3.0   2024/10/24 - 0.3.0 release. add comparators.

{antelope_interface-0.3.1 → antelope_interface-0.3.3}/src/antelope/__init__.py

@@ -11,7 +11,7 @@ from .interfaces.ibasic import BasicInterface, EntityNotFound, NoAccessToEntity,
 from .interfaces.iconfigure import ConfigureInterface
 from .interfaces.iexchange import ExchangeInterface, ExchangeRequired
 from .interfaces.iindex import IndexInterface, IndexRequired, directions, comp_dir, num_dir, check_direction, valid_sense, comp_sense
-from .interfaces.ibackground import BackgroundInterface, BackgroundRequired
+from .interfaces.ibackground import BackgroundInterface, BackgroundRequired, LinkingError
 from .interfaces.iquantity import QuantityInterface, QuantityRequired, NoFactorsFound, ConversionReferenceMismatch, FlowableMismatch
 from .interfaces.iforeground import ForegroundInterface
 

{antelope_interface-0.3.1 → antelope_interface-0.3.3}/src/antelope/interfaces/ibackground.py

@@ -26,6 +26,13 @@ class BackgroundRequired(Exception):
     pass
 
 
+class LinkingError(Exception):
+    """
+    To be returned when a strict linking strategy cannot be implemented
+    """
+    pass
+
+
 _interface = 'background'
 
 BACKGROUND_VALUES_REQUIRED = {'dependencies', 'emissions', 'cutoffs', 'lci', 'sys_lci', 'foreground', 'ad', 'bf'}

antelope_interface-0.3.3/src/antelope/qdb/qdb.py

@@ -0,0 +1,32 @@
+"""
+An interface specification for a quantity database.  This was originally conceived as being *the* quantity
+interface, but as things have developed it's become clear that the qdb does more (and less) than the
+quantity interface governs, and many (even most) of the operations of qdb are not even part of the antelope
+interface spec.
+
+For that reason, we are putting this *still in* antelope interface but *outside of* the abstract query framework,
+and making it a straight abstract base class.
+"""
+
+from abc import ABC
+
+
+class QdbInterface(ABC):
+    """
+    The main purpose of the qdb is to maintain a free-standing database of quantities and flows.  This will
+    most likely be implemented as a graph, but the interface for interacting with it is not going to care about
+    that.  Here we brainstorm about all the things we would want the qdb to do.
+
+    # quantities
+
+    Quantities are a fundamental concept in physical science; yet my implementation of them is basically made up
+    based on my experience and intuition.  We distinguish between reference quantities, which are directly measurable,
+    and which are [within qdb] *strictly* canonical and can therefore only be created or altered by privileged users,
+    and *indicators*, which are quantities that may or may not be directly measurable but are owned by users and
+    therefore not canonical.
+
+
+    In qdb, we only store *reference* quantities (right? or do we allow users
+    to make their own quantities?  we allow users to make their own *indicators*.  Only privileged users can c
+    """
+    pass

antelope_interface-0.3.3/src/antelope/qdb/units.py

@@ -0,0 +1,15 @@
+"""
+this belongs in the implementation, not the interface
+"""
+
+from pint import UnitRegistry
+
+
+U = UnitRegistry()
+
+
+comp_units = {
+    'm3': U.meter ** 3,
+    'm2a': U.meter ** 2 * U.year,
+    'tkm': U.tonne * U.kilometer,
+}

{antelope_interface-0.3.1 → antelope_interface-0.3.3}/src/antelope/refs/base.py

@@ -140,7 +140,10 @@ class BaseRef(BaseEntity):
         return item in self._d
 
     def __setitem__(self, key, value):
-        self._d[key] = value
+        if value is None:
+            self._d.pop(key, None)
+        else:
+            self._d[key] = value
 
     @property
     def _name(self):

{antelope_interface-0.3.1 → antelope_interface-0.3.3}/src/antelope/refs/exchange_ref.py

@@ -233,6 +233,36 @@ class ExchangeRef(object):
         except AttributeError:
             return False
 
+    def __lt__(self, other):
+        if EXCHANGE_TYPES.index(self.type) < EXCHANGE_TYPES.index(other.type):
+            return True
+        if self.type == other.type:
+            return (self.flow.external_ref, self.direction, self.value) < \
+                (other.flow.external_ref, other.direction, other.value)
+        return False
+
+    def __le__(self, other):
+        if self.__eq__(other):
+            return True
+        if self.__lt__(other):
+            return True
+        return False
+
+    def __gt__(self, other):
+        if EXCHANGE_TYPES.index(self.type) > EXCHANGE_TYPES.index(other.type):
+            return True
+        if self.type == other.type:
+            return (self.flow.external_ref, self.direction, self.value) > \
+                (other.flow.external_ref, other.direction, other.value)
+        return False
+
+    def __ge__(self, other):
+        if self.__eq__(other):
+            return True
+        if self.__gt__(other):
+            return True
+        return False
+
     @property
     def key(self):
         return self._hash

{antelope_interface-0.3.1 → antelope_interface-0.3.3}/src/antelope/refs/process_ref.py

@@ -341,3 +341,36 @@ class ProcessRef(EntityRef):
         """
         ref_flow = self._use_ref_exch(ref_flow)
         return self._query.deep_lcia(self.external_ref, lcia_qty, ref_flow=ref_flow, detailed=detailed, **kwargs)
+
+    @property
+    def inventory_as_series(self):
+        """
+        Use this as generative input to pandas.Series:
+        s = pandas.Series(process_ref.inventory_as_series)
+        :return:
+        """
+        def _tx_cx(_ex):
+            if _ex.type == 'reference':
+                return '*'
+            elif _ex.type == 'node':
+                return '#'
+            elif _ex.type == 'context':
+                return _ex.termination.name
+            else:
+                return None
+        return {(k.flow.name, _tx_cx(k), k.direction, k.unit): k.value for k in self.inventory()}
+
+    @property
+    def inventory_as_dataframe(self):
+        """
+        Use this as generative input to pandas.DataFrame:
+        df = pandas.DataFrame(process_ref.inventory_as_dataframe)
+        :return:
+        """
+        def _cx_of(_ex):
+            if _ex.type == 'context':
+                return _ex.termination.name
+            return None
+        for k in self.inventory():
+            yield {'Flow': k.flow.name, 'Direction': k.direction, 'Type': k.type, 'Unit': k.flow.unit,
+                   'Value': k.value, 'Context': _cx_of(k)}

{antelope_interface-0.3.1 → antelope_interface-0.3.3/src/antelope_interface.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: antelope_interface
-Version: 0.3.1
+Version: 0.3.3
 Summary: A common interface for accessing LCA data
 Author-email: Brandon Kuczenski <bkuczenski@ucsb.edu>
 License: BSD-3-Clause

{antelope_interface-0.3.1 → antelope_interface-0.3.3}/src/antelope_interface.egg-info/SOURCES.txt

@@ -22,6 +22,9 @@ src/antelope/interfaces/iquantity.py
 src/antelope/models/__init__.py
 src/antelope/models/auth.py
 src/antelope/models/comparators.py
+src/antelope/qdb/__init__.py
+src/antelope/qdb/qdb.py
+src/antelope/qdb/units.py
 src/antelope/refs/__init__.py
 src/antelope/refs/base.py
 src/antelope/refs/catalog_ref.py