matrix-utils 0.8__tar.gz → 0.9__tar.gz

{matrix_utils-0.8 → matrix_utils-0.9}/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [0.9] - 2026-07-12
+
+* Merge [#45](https://github.com/brightway-lca/matrix_utils/pull/45): Expose reference (production) exchange arrays from [bw_processing #108](https://github.com/brightway-lca/bw_processing/pull/108). New `ResourceGroup` properties `has_reference`, `reference`, and `reference_current`. Requires `bw_processing>=1.6`.
+
 ## [0.8] - 2026-06-04
 
 * Merge [#42](https://github.com/brightway-lca/matrix_utils/pull/42): Rename `scale_array` to `rescale_array`, tracking [bw_processing #104](https://github.com/brightway-lca/bw_processing/pull/104). Adds `ResourceGroup.rescale_current` and `MappedMatrix.input_rescale_vector()`.

{matrix_utils-0.8 → matrix_utils-0.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: matrix_utils
-Version: 0.8
+Version: 0.9
 Summary: Tools to create matrices from data packages
 Author-email: Chris Mutel <cmutel@gmail.com>
 Maintainer-email: Chris Mutel <cmutel@gmail.com>
@@ -28,7 +28,7 @@ License-File: LICENSE
 Requires-Dist: numpy
 Requires-Dist: scipy>=1.10
 Requires-Dist: pandas
-Requires-Dist: bw_processing>=1.5
+Requires-Dist: bw_processing>=1.6
 Requires-Dist: stats_arrays
 Provides-Extra: testing
 Requires-Dist: matrix_utils; extra == "testing"

{matrix_utils-0.8 → matrix_utils-0.9}/matrix_utils/__init__.py

@@ -11,7 +11,7 @@ __all__ = (
     "SparseMatrixDict",
 )
 
-__version__ = "0.8"
+__version__ = "0.9"
 
 from matrix_utils.array_mapper import ArrayMapper
 from matrix_utils.indexers import CombinatorialIndexer, Proxy, RandomIndexer, SequentialIndexer

{matrix_utils-0.8 → matrix_utils-0.9}/matrix_utils/resource_group.py

@@ -135,6 +135,14 @@ class ResourceGroup:
         except KeyError:
             return False
 
+    @property
+    def has_reference(self) -> bool:
+        try:
+            self.get_resource_by_suffix("reference")
+            return True
+        except KeyError:
+            return False
+
     @property
     def has_params(self) -> bool:
         try:
@@ -205,6 +213,18 @@ class ResourceGroup:
             return self.rescale
         return None
 
+    @property
+    def reference(self):
+        """The reference (production) exchange boolean array, with masks applied (if necessary)."""
+        return self.apply_masks(self.get_resource_by_suffix("reference"))
+
+    @property
+    def reference_current(self) -> Optional[np.ndarray]:
+        """Current reference flags with masks applied, or ``None`` if no reference array exists."""
+        if self.has_reference:
+            return self.reference
+        return None
+
     def get_indices_data(self):
         """The source data for the indices array."""
         indices = self.get_resource_by_suffix("indices")

{matrix_utils-0.8 → matrix_utils-0.9}/matrix_utils.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: matrix_utils
-Version: 0.8
+Version: 0.9
 Summary: Tools to create matrices from data packages
 Author-email: Chris Mutel <cmutel@gmail.com>
 Maintainer-email: Chris Mutel <cmutel@gmail.com>
@@ -28,7 +28,7 @@ License-File: LICENSE
 Requires-Dist: numpy
 Requires-Dist: scipy>=1.10
 Requires-Dist: pandas
-Requires-Dist: bw_processing>=1.5
+Requires-Dist: bw_processing>=1.6
 Requires-Dist: stats_arrays
 Provides-Extra: testing
 Requires-Dist: matrix_utils; extra == "testing"

{matrix_utils-0.8 → matrix_utils-0.9}/matrix_utils.egg-info/requires.txt

@@ -1,7 +1,7 @@
 numpy
 scipy>=1.10
 pandas
-bw_processing>=1.5
+bw_processing>=1.6
 stats_arrays
 
 [dev]

{matrix_utils-0.8 → matrix_utils-0.9}/pyproject.toml

@@ -39,7 +39,7 @@ dependencies = [
     "numpy",
     "scipy>=1.10",
     "pandas",
-    "bw_processing>=1.5",
+    "bw_processing>=1.6",
     "stats_arrays",
 ]
 

{matrix_utils-0.8 → matrix_utils-0.9}/tests/mapped_matrix.py

@@ -1154,6 +1154,64 @@ def test_has_rescale_true():
     assert mm.group("sv").has_rescale is True
 
 
+# ── has_reference / reference ──────────────────────────────────────────────────
+
+
+def test_has_reference_false():
+    mm = MappedMatrix(
+        packages=[basic_mm()], matrix="foo", use_arrays=False, use_distributions=False
+    )
+    assert mm.group("vector").has_reference is False
+
+
+def test_has_reference_true():
+    dp = bwp.create_datapackage()
+    dp.add_persistent_vector(
+        matrix="foo",
+        name="sv",
+        indices_array=np.array([(0, 0), (1, 1)], dtype=bwp.INDICES_DTYPE),
+        data_array=np.array([1.0, 2.0]),
+        reference_array=np.array([True, False], dtype=bool),
+    )
+    mm = MappedMatrix(packages=[dp], matrix="foo", use_arrays=False, use_distributions=False)
+    assert mm.group("sv").has_reference is True
+
+
+def test_reference_values():
+    dp = bwp.create_datapackage()
+    dp.add_persistent_vector(
+        matrix="foo",
+        name="sv",
+        indices_array=np.array([(0, 0), (1, 1)], dtype=bwp.INDICES_DTYPE),
+        data_array=np.array([1.0, 2.0]),
+        reference_array=np.array([True, False], dtype=bool),
+    )
+    mm = MappedMatrix(packages=[dp], matrix="foo", use_arrays=False, use_distributions=False)
+    group = mm.group("sv")
+    assert group.reference.dtype == bool
+    assert list(group.reference) == [True, False]
+
+
+def test_reference_current_none_when_absent():
+    mm = MappedMatrix(
+        packages=[basic_mm()], matrix="foo", use_arrays=False, use_distributions=False
+    )
+    assert mm.group("vector").reference_current is None
+
+
+def test_reference_current_returns_masked_values():
+    dp = bwp.create_datapackage()
+    dp.add_persistent_vector(
+        matrix="foo",
+        name="sv",
+        indices_array=np.array([(0, 0), (1, 1)], dtype=bwp.INDICES_DTYPE),
+        data_array=np.array([1.0, 2.0]),
+        reference_array=np.array([False, True], dtype=bool),
+    )
+    mm = MappedMatrix(packages=[dp], matrix="foo", use_arrays=False, use_distributions=False)
+    assert list(mm.group("sv").reference_current) == [False, True]
+
+
 # ── n_elements_dropped ─────────────────────────────────────────────────────────────────