Merge branch 'feature/better-event-creation' into develop

Author: spjuhel

boario/event.py

@@ -14,28 +14,77 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
+import copy
 import json
 import tempfile
 import textwrap
 from collections.abc import Iterable
 
-import numpy
+import numpy as np
 import pymrio
 
 
-class TempMemmap(numpy.memmap):
+def _fast_sum(array: np.ndarray, axis: int) -> np.ndarray:
+    """
+    Perform a fast summation over the specified axis of the input array using einsum.
+
+    Parameters:
+        array (np.ndarray): Input array.
+        axis (int): Axis along which to perform the summation.
+
+    Returns:
+        np.ndarray: Summed array along the specified axis.
+
+    Raises:
+        ValueError: If the specified axis is out of bounds for the input array.
+
+    Example:
+        array = np.array([[1, 2, 3], [4, 5, 6]])
+        result = _fast_sum(array, 0)  # Sum along the first axis
+        print(result)  # Output: [5 7 9]
+    """
+    if axis == 0:
+        if array.ndim == 1:
+            return np.einsum("i->", array)
+        if array.ndim == 2:
+            return np.einsum("ij->j", array)
+        if array.ndim == 3:
+            return np.einsum("ijk->jk", array)
+        else:
+            raise NotImplementedError("Too many dimensions.")
+    elif axis == 1:
+        if array.ndim == 2:
+            return np.einsum("ij->i", array)
+        if array.ndim == 3:
+            return np.einsum("ijk->ik", array)
+        else:
+            raise NotImplementedError("Too many dimensions.")
+    elif axis == 2:
+        return np.einsum("ijk->ij", array)
+    else:
+        raise ValueError("Axis out of bounds for input array.")
+
+
+def _divide_arrays_ignore(a, b):
+    with np.errstate(divide="ignore", invalid="ignore"):
+        ret = np.divide(a, b)
+        np.nan_to_num(ret)
+        return ret
+
+
+class TempMemmap(np.memmap):
     def __new__(
         subtype,
         filename,
-        dtype=numpy.float64,
+        dtype=np.float64,
         mode="r+",
         offset=0,
         shape=None,
         order="C",
         save=False,
     ):
         if save:
-            self = numpy.memmap.__new__(
+            self = np.memmap.__new__(
                 subtype,
                 filename=filename,
                 dtype=dtype,
@@ -47,7 +96,7 @@ def __new__(
             return self
         else:
             ntf = tempfile.NamedTemporaryFile()
-            self = numpy.memmap.__new__(
+            self = np.memmap.__new__(
                 subtype,
                 ntf,
                 dtype=dtype,
@@ -67,11 +116,11 @@ def __del__(self):
 
 class CustomNumpyEncoder(json.JSONEncoder):
     def default(self, obj):
-        if isinstance(obj, numpy.integer):
+        if isinstance(obj, np.integer):
             return int(obj)
-        elif isinstance(obj, numpy.floating):
+        elif isinstance(obj, np.floating):
             return float(obj)
-        elif isinstance(obj, numpy.ndarray):
+        elif isinstance(obj, np.ndarray):
             return obj.tolist()
         else:
             return super(CustomNumpyEncoder, self).default(obj)
@@ -85,7 +134,7 @@ def flatten(lst):
             yield el
 
 
-def lexico_reindex(mrio: pymrio.IOSystem) -> pymrio.IOSystem:
+def lexico_reindex(mriot: pymrio.IOSystem) -> pymrio.IOSystem:
     """Reindex IOSystem lexicographicaly
 
     Sort indexes and columns of the dataframe of a ``pymrio.IOSystem`` by
@@ -103,23 +152,26 @@ def lexico_reindex(mrio: pymrio.IOSystem) -> pymrio.IOSystem:
 
 
     """
-    if mrio.Z is None:
-        raise ValueError("Given mrio has no Z attribute set")
-    mrio.Z = mrio.Z.reindex(sorted(mrio.Z.index), axis=0)
-    mrio.Z = mrio.Z.reindex(sorted(mrio.Z.columns), axis=1)
-    if mrio.Y is None:
-        raise ValueError("Given mrio has no Y attribute set")
-    mrio.Y = mrio.Y.reindex(sorted(mrio.Y.index), axis=0)
-    mrio.Y = mrio.Y.reindex(sorted(mrio.Y.columns), axis=1)
-    if mrio.x is None:
-        raise ValueError("Given mrio has no x attribute set")
-    mrio.x = mrio.x.reindex(sorted(mrio.x.index), axis=0)
-    if mrio.A is None:
-        raise ValueError("Given mrio has no A attribute set")
-    mrio.A = mrio.A.reindex(sorted(mrio.A.index), axis=0)
-    mrio.A = mrio.A.reindex(sorted(mrio.A.columns), axis=1)
-
-    return mrio
+    mriot = copy.deepcopy(mriot)
+    if getattr(mriot,"Z",None) is None:
+        raise ValueError("Given mriot has no Z attribute set")
+    mriot.Z = mriot.Z.reindex(sorted(mriot.Z.index), axis=0)
+    mriot.Z = mriot.Z.reindex(sorted(mriot.Z.columns), axis=1)
+    if getattr(mriot,"Y",None) is None:
+        raise ValueError("Given mriot has no Y attribute set")
+    mriot.Y = mriot.Y.reindex(sorted(mriot.Y.index), axis=0)
+    mriot.Y = mriot.Y.reindex(sorted(mriot.Y.columns), axis=1)
+    if getattr(mriot,"x",None) is None:
+        raise ValueError("Given mriot has no x attribute set")
+    mriot.x = mriot.x.reindex(
+        sorted(mriot.x.index), axis=0
+    )  # ignore type (wrong type hinting in pymrio)
+    if getattr(mriot,"A",None) is None:
+        raise ValueError("Given mriot has no A attribute set")
+    mriot.A = mriot.A.reindex(sorted(mriot.A.index), axis=0)
+    mriot.A = mriot.A.reindex(sorted(mriot.A.columns), axis=1)
+
+    return mriot
 
 
 def sizeof_fmt(num, suffix="B"):

boario/model_base.py

@@ -39,6 +39,7 @@ pydoclint = "^0.4.1"
 autoapi = "^2.0.1"
 sphinx-autodoc-typehints = "^2.0.0"
 numpydoc = "^1.7.0"
+pandas-stubs = "^2.2.2.240514"
 
 [build-system]
 requires = ["poetry-core"]
@@ -100,4 +101,7 @@ extend-ignore = ['E501','E203']
 
 
 defineConstant = { DEBUG = true }
-stubPath = "boario/stubs"
+stubPath = "boario/stubs"
+
+[tool.pytest.ini_options]
+addopts = "--cov=boario --cov-report html"