antelope-interface 0.2.4__tar.gz → 0.2.5__tar.gz

{antelope_interface-0.2.4/src/antelope_interface.egg-info → antelope_interface-0.2.5}/PKG-INFO

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

{antelope_interface-0.2.4 → antelope_interface-0.2.5}/pyproject.toml

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

{antelope_interface-0.2.4 → antelope_interface-0.2.5}/setup.py

@@ -5,6 +5,8 @@ setup()
 
 """
 Version History:
+0.2.5 2024/05/06 - bg_lcia() becomes a basic interface route; sys_lcia() is the fully-featured background route
+
 0.2.4 2024/04/17 - split out BasicInterface from AbstractQuery. 
                    abandon setup.py except for this changelog.
                    Redesign ExteriorFlow to have maybe a little bit more logic

{antelope_interface-0.2.4 → antelope_interface-0.2.5}/src/antelope/exchanges_from_spreadsheet.py

@@ -1,11 +1,15 @@
 """
 This module provides a routine that generates a list of exchange refs from a properly formatted spreadsheet
 """
+
 from .refs import CatalogRef, ExchangeRef
 from .interfaces import check_direction
 
 
 class ValueIsBalance(Exception):
+    """
+    Used to signal when an exchange is reached that is designated as a balance.
+    """
     pass
 
 
@@ -93,6 +97,7 @@ def exchanges_from_spreadsheet(sheetlike, term_dict=None, node=None, origin=None
      - row(0) returns a header list
      - row(1) is the process's reference flow
      - subsequent rows are dependent flows
+
      !TODO: support multiple references with is_ref or is_reference field
 
     "entries" in the row() return must be "cell-like":

{antelope_interface-0.2.4 → antelope_interface-0.2.5}/src/antelope/interfaces/abstract_query.py

@@ -15,7 +15,8 @@ class PrivateArchive(Exception):
 
 
 class AbstractQuery(object):
-    """ Not-quite-abstract base class for executing queries
+    """
+    Not-quite-abstract base class for executing queries
 
     Query implementation must provide:
      - origin (property)

{antelope_interface-0.2.4 → antelope_interface-0.2.5}/src/antelope/interfaces/ibackground.py

@@ -20,7 +20,6 @@ More plugins are yet imagined.
 
 from .abstract_query import AbstractQuery
 from ..refs import ExchangeRef
-from itertools import chain
 
 
 class BackgroundRequired(Exception):
@@ -136,7 +135,7 @@ class BackgroundInterface(AbstractQuery):
                                    process, ref_flow=ref_flow, **kwargs)
 
     def _make_sys_lci_exchange(self, x):
-        return ExchangeRef(self.get(x.process), self.make_ref(x.flow), x.direction, value=x.value,
+        return ExchangeRef(self.make_ref(x.process), self.make_ref(x.flow), x.direction, value=x.value,
                            termination=x.termination, comment='SYS LCI', is_reference=False)
 
     def sys_lci(self, demand, **kwargs):
@@ -160,7 +159,7 @@ class BackgroundInterface(AbstractQuery):
         for i in self._perform_query(_interface, 'sys_lci', BackgroundRequired, demand, **kwargs):
             yield self._make_sys_lci_exchange(i)
 
-    def bg_lcia(self, process, query_qty, observed=None, ref_flow=None, **kwargs):
+    def sys_lcia(self, process, query_qty, observed=None, ref_flow=None, **kwargs):
         """
 
         :param process:
@@ -170,7 +169,7 @@ class BackgroundInterface(AbstractQuery):
         :param kwargs:
         :return:
         """
-        return self._perform_query(_interface, 'bg_lcia', BackgroundRequired,
+        return self._perform_query(_interface, 'sys_lcia', BackgroundRequired,
                                    process, query_qty, observed=observed, ref_flow=ref_flow, **kwargs)
 
     '''

{antelope_interface-0.2.4 → antelope_interface-0.2.5}/src/antelope/interfaces/ibasic.py

@@ -142,4 +142,16 @@ class BasicInterface(AbstractQuery):
         except TypeError:
             return False
 
+    def bg_lcia(self, process, query_qty=None, ref_flow=None, **kwargs):
+        """
+
+        :param process:
+        :param query_qty: if omitted, a catalog may select a default LCIA method
+        :param ref_flow:
+        :param kwargs:
+        :return:
+        """
+        return self._perform_query('basic', 'bg_lcia', BasicRequired,
+                                   process, query_qty, ref_flow=ref_flow, **kwargs)
+
 

{antelope_interface-0.2.4 → antelope_interface-0.2.5}/src/antelope/models/__init__.py

@@ -287,6 +287,10 @@ class ExteriorFlow(DirectedFlow):
     """
     context: List[str]
 
+    @property
+    def termination(self):
+        return self.context
+
     @classmethod
     def from_background(cls, flow, direction, context):
         if hasattr(context, 'entity_type'):
@@ -341,7 +345,7 @@ class ReferenceExchange(Exchange):
     termination: None
 
     @classmethod
-    def from_exchange(cls, x):
+    def from_exchange(cls, x, **kwargs):
         if x.termination is not None:
             cx = list(x.termination)
         else:
@@ -429,10 +433,11 @@ def generate_pydantic_inventory(xs, mode=None, values=False, ref_flow=None):
 
     :param xs: iterable of exchanges
     :param mode: [None] whether to filter the exchanges by type. could be one of:
-     None: generate all exchanges
-     'interior'
-     'exterior'
-     'cutoff'
+     - None: generate all exchanges
+     - 'interior'
+     - 'exterior'
+     - 'cutoff'
+
     :param values: (bool) [False] whether to include exchange values.
     :param ref_flow: (ignored if values=False) the reference flow with which the exchange value was computed. If None,
      this implies the exchange reports un-allocated exchange values

{antelope_interface-0.2.4 → antelope_interface-0.2.5}/src/antelope/refs/process_ref.py

@@ -315,4 +315,7 @@ class ProcessRef(EntityRef):
         :return:
         """
         ref_flow = self._use_ref_exch(ref_flow)
-        return self._query.bg_lcia(self.external_ref, lcia_qty, observed=observed, ref_flow=ref_flow, **kwargs)
+        if observed:
+            return self._query.sys_lcia(self.external_ref, lcia_qty, observed=observed, ref_flow=ref_flow, **kwargs)
+        else:
+            return self._query.bg_lcia(self.external_ref, lcia_qty, ref_flow=ref_flow, **kwargs)

{antelope_interface-0.2.4 → antelope_interface-0.2.5/src/antelope_interface.egg-info}/PKG-INFO

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