antelope-interface 0.2.7__tar.gz → 0.3.0__tar.gz

{antelope_interface-0.2.7/src/antelope_interface.egg-info → antelope_interface-0.3.0}/PKG-INFO

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

{antelope_interface-0.2.7 → antelope_interface-0.3.0}/pyproject.toml

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

{antelope_interface-0.2.7 → antelope_interface-0.3.0}/setup.py

@@ -5,6 +5,10 @@ setup()
 
 """
 Version History:
+0.3.0   2024/10/24 - 0.3.0 release. add comparators.
+
+0.3.0-pre 2024/09/22 - pre-release for workshop (minor bugfix on UnallocatedExchange model)
+
 0.2.7   2024/09/10 - synchronization release for background / LCI changes 
                      add make_ref() machinery to a few interface routes
                      alter extend_process to use dependencies instead of inventory

{antelope_interface-0.2.7 → antelope_interface-0.3.0}/src/antelope/models/__init__.py

@@ -340,6 +340,8 @@ class Exchange(ResponseModel):
         if x.type == 'context':
             cx = list(x.termination)
             term = None
+        elif x.type == 'reference':
+            term = cx = None
         else:
             term = x.termination
             cx = None

antelope_interface-0.3.0/src/antelope/models/comparators.py

@@ -0,0 +1,79 @@
+"""
+Comparators
+
+These tools enable quick comparison of sets of exchanges to see if they match
+"""
+from math import isclose
+
+
+def _rx_key(rx):
+    return rx.process.external_ref, rx.flow.external_ref, rx.direction
+
+
+def _exch_key(exch):
+    return exch.flow.external_ref, exch.direction, tuple(exch.termination)
+
+
+def compare_ref_exchanges(s1, s2):
+    """
+    Tests qualitative equivalence of two sets of *reference* exchanges (process, flow, direction).
+    :param s1:
+    :param s2:
+    :return:
+    """
+    set1 = {_rx_key(s) for s in s1}
+    set2 = {_rx_key(s) for s in s2}
+    d1 = set1.difference(set2)
+    d2 = set2.difference(set1)
+    if len(d1) + len(d2) == 0:
+        print('PASS (%d)' % len(set1))
+    else:
+        print('DIFFERENT (%d,%d / %d)' % (len(d1), len(d2), len(set1)))
+    return d1, d2
+
+
+def compare_exchanges(s1, s2):
+    """
+    Tests qualitative equivalence of two sets of *depenedent* exchanges (flow, direction, termination).
+    Returns two sets: those present only in s1, those present only in s2
+    :param s1:
+    :param s2:
+    :return:
+    """
+    set1 = {_exch_key(s) for s in s1}
+    set2 = {_exch_key(s) for s in s2}
+    d1 = set1.difference(set2)
+    d2 = set2.difference(set1)
+    if len(d1) + len(d2) == 0:
+        print('PASS (%d)' % len(set1))
+    else:
+        print('DIFFERENT (%d,%d / %d)' % (len(d1), len(d2), len(set1)))
+    return d1, d2
+
+
+def compare_exchange_values(s1, s2, rel_tol=1e-6):
+    """
+    The exchanges are unordered, so it's nontrivial to test two sets of results against one another.
+    We use the approach of mapping (flow.external_ref, direction, termination) to exchange value.
+    This is a summary test that compares the two sets and returns the entries in s2 that do NOT match
+    the entry in s1 (key error qualifies as nonmatch)
+    Thus a return value of length 0 indicates a passed test.
+    :param s1:
+    :param s2:
+    :param rel_tol: default 1e-6
+    :return: a list of failed exchanges, expressed as 2-tuples: (bad_exch, good_val) or (bad_exch, None)
+    """
+    c = {_exch_key(x): x.value for x in s1}
+    fail = []
+    for s in s2:
+        try:
+            v = c[_exch_key(s)]
+            if not isclose(v, s.value, rel_tol=rel_tol):
+                fail.append((s, v))
+        except KeyError:
+            fail.append((s, None))
+    if len(fail) == 0:
+        print('PASS (%d)' % len(c))
+    else:
+        print('DIFFERENT (%d / %d)' % (len(fail), len(c)))
+    return fail

{antelope_interface-0.2.7 → antelope_interface-0.3.0}/src/antelope/refs/base.py

@@ -17,15 +17,15 @@ without access to a query object that can implement the various methods.
 3. Grounded references should behave equivalently to the entities themselves. (except the remote catalogs can act
 as gatekeepers to decide what information can be disclosed)
 
-The inheritance pattern is:
-
-BaseRef
-|    |
-|    EntityRef (grounded by a catalog query)
-|      | \ \
-|    ProcessRef, FlowRef, QuantityRef [...]
-|
-CatalogRef (un-grounded)
+The inheritance pattern is: ::
+
+    BaseRef
+    |    |
+    |    EntityRef (grounded by a catalog query)
+    |      |            |         |
+    |    ProcessRef, FlowRef, QuantityRef [...]
+    |
+    CatalogRef (un-grounded)
 
 The CatalogRef can instantiate a grounded reference if supplied with a query object that implements the interface.
 

{antelope_interface-0.2.7 → antelope_interface-0.3.0/src/antelope_interface.egg-info}/PKG-INFO

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

{antelope_interface-0.2.7 → antelope_interface-0.3.0}/src/antelope_interface.egg-info/SOURCES.txt

@@ -21,6 +21,7 @@ src/antelope/interfaces/iindex.py
 src/antelope/interfaces/iquantity.py
 src/antelope/models/__init__.py
 src/antelope/models/auth.py
+src/antelope/models/comparators.py
 src/antelope/refs/__init__.py
 src/antelope/refs/base.py
 src/antelope/refs/catalog_ref.py