foxes 0.8.2__py3-none-any.whl → 1.1.0.2__py3-none-any.whl

foxes/output/state_turbine_table.py

@@ -1,22 +1,24 @@
 from xarray import Dataset
 
 from foxes.utils import write_nc
-import foxes.constants as FC 
+import foxes.constants as FC
 
 from .output import Output
 
+
 class StateTurbineTable(Output):
     """
     Creates tables of state-turbine type data
-    
+
     Attributes
     ----------
     farm_results: xarray.Dataset
         The farm results
-    
+
     :group: output
-    
+
     """
+
     def __init__(self, farm_results):
         """
         Constructor.
@@ -28,17 +30,17 @@ class StateTurbineTable(Output):
 
         """
         self.farm_results = farm_results
-    
+
     def get_dataset(
-        self, 
-        variables, 
-        name_map={}, 
-        to_file=None, 
+        self,
+        variables,
+        name_map={},
+        to_file=None,
         **kwargs,
-        ):
+    ):
         """
         Creates a dataset object
-        
+
         Parameters
         ----------
         variables: list of str
@@ -49,12 +51,12 @@ class StateTurbineTable(Output):
             The output file path, if writing is desired
         kwargs: dict, optional
             Additional parameters for write_nc
-        
+
         Returns
         -------
         table: xarray.Dataset
             The state-turbine data table
-            
+
         """
         state = name_map.get(FC.STATE, FC.STATE)
         turbine = name_map.get(FC.TURBINE, FC.TURBINE)
@@ -65,14 +67,12 @@ class StateTurbineTable(Output):
                 turbine: self.farm_results[FC.TURBINE].to_numpy(),
             },
             data_vars={
-                name_map.get(v, v): (
-                    (state, turbine), self.farm_results[v].to_numpy())
+                name_map.get(v, v): ((state, turbine), self.farm_results[v].to_numpy())
                 for v in variables
-            }
+            },
         )
-        
+
         if to_file is not None:
             write_nc(ds=ds, fpath=to_file, **kwargs)
-        
+
         return ds
-    

foxes/utils/__init__.py

@@ -17,8 +17,8 @@ from .regularize import sqrt_reg
 from .windrose_plot import TabWindroseAxes
 from .tab_files import read_tab_file
 from .random_xy import random_xy_square
+from .dev_utils import print_mem
 
 from . import two_circles
 from . import abl
-from . import runners
 from . import geom2d

foxes/utils/abl/neutral.py

@@ -39,7 +39,7 @@ def ustar(ws_ref, h_ref, z0, kappa=0.41):
     z0: float
         The roughness length
     kappa: float
-        The van-Karman constant
+        The von Karman constant
 
     Returns
     -------
@@ -66,7 +66,7 @@ def calc_ws(height, z0, ustar, kappa=0.41):
     ustar: float
         The friction velocity
     kappa: float
-        The van-Karman constant
+        The von Karman constant
 
     Returns
     -------

foxes/utils/abl/stable.py

@@ -64,7 +64,7 @@ def ustar(ws_ref, h_ref, z0, mol, kappa=0.41):
     mol: float
         The Monin-Obukhov height
     kappa: float
-        The van-Karman constant
+        The von Karman constant
 
     Returns
     -------
@@ -92,7 +92,7 @@ def calc_ws(height, z0, ustar, psi, kappa=0.41):
     psi: float
         The Psi function values
     kappa: float
-        The van-Karman constant
+        The von Karman constant
 
     Returns
     -------

foxes/utils/abl/unstable.py

@@ -47,7 +47,7 @@ def ustar(ws_ref, h_ref, z0, mol, kappa=0.41):
     mol: float
         The Monin-Obukhov height
     kappa: float
-        The van-Karman constant
+        The von Karman constant
 
     Returns
     -------
@@ -75,7 +75,7 @@ def calc_ws(height, z0, ustar, psi, kappa=0.41):
     psi: float
         The Psi function values
     kappa: float
-        The van-Karman constant
+        The von Karman constant
 
     Returns
     -------

foxes/utils/data_book.py

@@ -89,7 +89,7 @@ class DataBook:
         context: str
             The context
         package: str or package
-            The package, must contain init.py` file
+            The package, must contain init.py file
         file_mane: str
             The file name
 

foxes/utils/dev_utils.py

@@ -0,0 +1,42 @@
+from .load import import_module
+
+
+def print_mem(obj, min_csize=0, max_csize=None, pre_str="OBJECT SIZE"):
+    """
+    Prints the memory consumption of a model and its components
+
+    Parmeters
+    ---------
+    obj: object
+        The object to be analyzed
+    min_csize: int
+        The minimal size of a component for being shown
+    max_csize: int, optional
+        The maximal allowed size of a component
+    pre_str: str
+        String to be printed before
+
+    :group: utils
+
+    """
+    objsize = import_module("objsize")
+    n = obj.name if hasattr(obj, "name") else ""
+    print(pre_str, type(obj).__name__, n, objsize.get_deep_size(obj))
+    for k in dir(obj):
+        o = None
+        try:
+            if (
+                hasattr(obj, k)
+                and not callable(getattr(obj, k))
+                and (len(k) < 3 or k[:2] != "__")
+            ):
+                o = getattr(obj, k)
+        except ValueError:
+            pass
+
+        if o is not None:
+            s = objsize.get_deep_size(getattr(obj, k))
+            if s >= min_csize:
+                print("   ", k, s)
+                if max_csize is not None and s > max_csize:
+                    raise ValueError(f"Component {k} exceeds maximal size {max_csize}")

foxes/utils/dict.py

@@ -28,10 +28,33 @@ class Dict(dict):
         super().__init__(*args, **kwargs)
         self.name = name if name is not None else type(self).__name__
 
+    def get_item(self, key, prnt=True):
+        """
+        Gets an item, prints readable error if not found
+
+        Parameters
+        ----------
+        key: immutable object
+            The key
+        prnt: bool
+            Flag for message printing
+
+        """
+        try:
+            return self[key]
+        except KeyError as e:
+            if prnt:
+                print(f"\n{self.name}: Cannot find key '{key}'.\n")
+                print("Known keys:")
+                for k in self.keys():
+                    print("   ", k)
+                print()
+            raise e
+
     def __getitem__(self, key):
         try:
             return super().__getitem__(key)
         except KeyError:
-            k = ", ".join(sorted(list(self.keys())))
+            k = ", ".join(sorted([f"{s}" for s in self.keys()]))
             e = f"{self.name}: Cannot find key '{key}'. Known keys: {k}"
             raise KeyError(e)

foxes/utils/exec_python.py

@@ -17,7 +17,7 @@ def exec_python(s, indicator="%", newline=";", globals=globals(), locals={}):
     s: list, dict or object
         The source to by analyzed
     indicator: str
-        The indicator that trigger python evaluation
+        The indicator that triggers python evaluation
     newline: str
         The new line indicator
     globals: dict

foxes/utils/factory.py

@@ -1,3 +1,5 @@
+import numpy as np
+
 from .dict import Dict
 import foxes.variables as FV
 
@@ -23,6 +25,8 @@ class Factory:
     hints: dict
         Hints for print_toc, only for variables for which the
         options are functions or missing
+    example: str
+        An example name
     options: dict
         For each variable, e.g. A, B or C, the list or dict
         or function that maps a str to the actual value
@@ -39,6 +43,7 @@ class Factory:
         kwargs={},
         var2arg={},
         hints={},
+        example_vars=None,
         **options,
     ):
         """
@@ -60,6 +65,8 @@ class Factory:
         hints: dict
             Hints for print_toc, only for variables for which the
             options are functions or missing
+        example_vars: dict, optional
+            Variable values for creating an example
         options: dict
             For each variable, e.g. A, B or C, the list or dict
             or function that maps a str to the actual value
@@ -122,6 +129,30 @@ class Factory:
                     f"Factory '{name_template}': Variable '{v}' has option of type '{type(v).__name__}'. Only list, tuple, dict or function are supported"
                 )
 
+        exvars = dict(
+            n=5,
+            n2=9,
+            superposition="linear",
+            kTI=0.2,
+            kb=0.001,
+            step=100,
+            dx=100,
+            dt="10s",
+        )
+        if example_vars is not None:
+            exvars.update(example_vars)
+        try:
+            self.example = ""
+            for i, v in enumerate(self._vars):
+                self.example += f"{self._pre[i]}{exvars[v]}"
+            self.example += self._pre[-1]
+            if not self.check_match(self.example, error=False):
+                raise ValueError(
+                    f"Example '{self.example}' does not match template '{self.name_template}'"
+                )
+        except KeyError:
+            self.example = None
+
     @property
     def name_prefix(self):
         """
@@ -171,56 +202,77 @@ class Factory:
                 s += f"\n  {v} from {list(self.options[v])}"
             else:
                 s += f"\n  {v}={self.hints.get(v, '(value)')}"
+        if self.example is not None:
+            s += f"\nExample: {self.example}"
         return s
 
-    def check_match(self, name):
+    def get_examples(self, **var_values):
         """
-        Tests if a name matches the template
+        Create example names from given values
 
         Parameters
         ----------
-        name: str
-            The name to be checked
+        var_values: dict
+            Variables values. Key: Variable,
+            value: list or value
 
         Returns
         -------
-        success: bool
-            True if the template is matched
+        examples: list of str
+            The examples
 
         """
-        data_str = name
-        for vi in range(len(self.variables)):
-            p = self._pre[vi]
-            i = data_str.find(p)
-            j = i + len(p)
-            if i < 0 or len(data_str) <= j:
-                return False
-            data_str = data_str[j:]
-
-            q = self._pre[vi + 1]
-            if q != "":
-                i = data_str.find(q)
-                j = i + len(q)
-                if i < 0 or len(data_str) <= j:
-                    return False
+
+        def gete(i, vals, vars, values, examples):
+            if i >= len(vars):
+                e = ""
+                for i, v in enumerate(self._vars):
+                    e += f"{self._pre[i]}{vals[v]}"
+                e += self._pre[-1]
+                self.check_match(e, error=True)
+                examples.append(e)
             else:
-                data_str = ""
+                v = vars[i]
+                if v in self._vars:
+                    vls = np.atleast_1d(values[i])
+                    for x in vls:
+                        vals[v] = x
+                        gete(i + 1, vals, vars, values, examples)
+                else:
+                    gete(i + 1, vals, vars, values, examples)
+
+        examples = []
+        gete(
+            0,
+            {},
+            list(var_values.keys()),
+            list(var_values.values()),
+            examples,
+        )
 
-        return True
+        return examples
 
-    def construct(self, name):
+    def check_match(self, name, error=False, ret_pars=False):
         """
-        Create an object of the base class.
+        Tests if a name matches the template and constructs
+        parameters
 
         Parameters
         ----------
         name: str
-            The name, matching the template
+            The name to be checked
+        error: bool
+            Flag for raising a Value error in case of
+            mismatch
+        ret_pars: bool
+            Flag for returning the parameters
 
         Returns
         -------
-        obj: object
-            The instance of the base class
+        success: bool
+            True if the template is matched
+        pars: dict, optional
+            The constructed parameters
 
         """
         j = 0
@@ -229,9 +281,14 @@ class Factory:
             if len(p) > 0:
                 i = name[j:].find(p)
                 if i < 0 or (pi == 0 and i > 0):
-                    raise ValueError(
-                        f"Factory '{self.name_template}': Name '{name}' not matching template"
-                    )
+                    if error:
+                        raise ValueError(
+                            f"Factory '{self.name_template}': Name '{name}' not matching template"
+                        )
+                    elif ret_pars:
+                        return False, {}
+                    else:
+                        return False
                 w = name[j : j + i]
                 j += i + len(p)
             else:
@@ -239,21 +296,41 @@ class Factory:
             if pi > 0:
                 wlist.append(w)
 
-        kwargs = {}
-        for vi, v in enumerate(self.variables):
-            w = self.var2arg.get(v, v)
-            data = wlist[vi]
-            if v in self.options:
-                o = self.options[v]
-                if hasattr(o, "__call__"):
-                    kwargs[w] = o(data)
+        if ret_pars:
+            kwargs = {}
+            for vi, v in enumerate(self.variables):
+                w = self.var2arg.get(v, v)
+                data = wlist[vi]
+                if v in self.options:
+                    o = self.options[v]
+                    if hasattr(o, "__call__"):
+                        kwargs[w] = o(data)
+                    else:
+                        kwargs[w] = self.options[v][data]
                 else:
-                    kwargs[w] = self.options[v][data]
-            else:
-                kwargs[w] = data
+                    kwargs[w] = data
 
-        kwargs.update(self.kwargs)
+            kwargs.update(self.kwargs)
+            return True, kwargs
 
+        return True
+
+    def construct(self, name):
+        """
+        Create an object of the base class.
+
+        Parameters
+        ----------
+        name: str
+            The name, matching the template
+
+        Returns
+        -------
+        obj: object
+            The instance of the base class
+
+        """
+        __, kwargs = self.check_match(name, error=True, ret_pars=True)
         return self.base(*self.args, **kwargs)
 
 
@@ -299,14 +376,20 @@ class WakeKFactory:
         i0 = name_template.find("_[wake_k]")
         i1 = i0 + len("_[wake_k]")
         kw = kwargs.pop("kwargs", {})
+        v2a = kwargs.pop("var2arg", {})
 
         if i0 < 0:
             raise ValueError(
                 f"String '_[wake_k]' not found in name template '{name_template}'"
             )
 
+        exvars = dict(k=0.04, ka=0.2, ambka=0.4, kb=0.001)
+        if "example_vars" in kwargs:
+            exvars.update(kwargs.pop("example_vars"))
+
         # add case ka, kb:
-        t = name_template[:i0] + "_ka<ka>_kb<kb>"
+        t0 = name_template[:i0]
+        t = t0 + "_ka<ka>_kb<kb>"
         if len(name_template) > i1:
             t += name_template[i1:]
         h = hints.copy()
@@ -323,17 +406,20 @@ class WakeKFactory:
                 **kwargs,
                 ka=lambda x: float(f"0.{x[1:]}" if x[0] == "0" else float(x)),
                 kb=lambda x: float(f"0.{x[1:]}" if x[0] == "0" else float(x)),
+                example_vars=exvars,
             )
         )
 
-        # add case ambient ka, kb:
-        t = name_template[:i0] + "_ambka<ka>_kb<kb>"
+        # add case ambient ambka, kb:
+        t = name_template[:i0] + "_ambka<ambka>_kb<kb>"
         if len(name_template) > i1:
             t += name_template[i1:]
         h = hints.copy()
-        h["ka"] = "(Value, e.g. 04 for 0.4)"
+        h["ambka"] = "(Value, e.g. 04 for 0.4)"
         h["kb"] = "(Value, e.g. 001 for 0.01)"
         kw["ti_var"] = FV.AMB_TI
+        hv2a = v2a.copy()
+        hv2a["ambka"] = "ka"
         self.factories.append(
             Factory(
                 base,
@@ -341,9 +427,11 @@ class WakeKFactory:
                 *args,
                 hints=h,
                 kwargs=kw.copy(),
+                var2arg=hv2a,
                 **kwargs,
-                ka=lambda x: float(f"0.{x[1:]}" if x[0] == "0" else float(x)),
+                ambka=lambda x: float(f"0.{x[1:]}" if x[0] == "0" else float(x)),
                 kb=lambda x: float(f"0.{x[1:]}" if x[0] == "0" else float(x)),
+                example_vars=exvars,
             )
         )
 
@@ -363,16 +451,19 @@ class WakeKFactory:
                 kwargs=kw.copy(),
                 **kwargs,
                 ka=lambda x: float(f"0.{x[1:]}" if x[0] == "0" else float(x)),
+                example_vars=exvars,
             )
         )
 
-        # add case ka:
-        t = name_template[:i0] + "_ambka<ka>"
+        # add case ambka:
+        t = name_template[:i0] + "_ambka<ambka>"
         if len(name_template) > i1:
             t += name_template[i1:]
         h = hints.copy()
-        h["ka"] = "(Value, e.g. 04 for 0.4)"
+        h["ambka"] = "(Value, e.g. 04 for 0.4)"
         kw["ti_var"] = FV.AMB_TI
+        hv2a = v2a.copy()
+        hv2a["ambka"] = "ka"
         self.factories.append(
             Factory(
                 base,
@@ -380,8 +471,10 @@ class WakeKFactory:
                 *args,
                 hints=h,
                 kwargs=kw.copy(),
+                var2arg=hv2a,
                 **kwargs,
-                ka=lambda x: float(f"0.{x[1:]}" if x[0] == "0" else float(x)),
+                ambka=lambda x: float(f"0.{x[1:]}" if x[0] == "0" else float(x)),
+                example_vars=exvars,
             )
         )
 
@@ -401,6 +494,7 @@ class WakeKFactory:
                 kwargs=kw.copy(),
                 **kwargs,
                 k=lambda x: float(f"0.{x[1:]}" if x[0] == "0" else float(x)),
+                example_vars=exvars,
             )
         )
 
@@ -417,6 +511,7 @@ class WakeKFactory:
                 hints=hints,
                 kwargs=kw.copy(),
                 **kwargs,
+                example_vars=exvars,
             )
         )
 
@@ -523,6 +618,35 @@ class FDict(Dict):
                     return True
         return found
 
+    def get_item(self, key, prnt=True):
+        """
+        Gets an item, prints readable error if not found
+
+        Parameters
+        ----------
+        key: immutable object
+            The key
+        prnt: bool
+            Flag for message printing
+
+        """
+        try:
+            return self[key]
+        except KeyError as e:
+            if prnt:
+                print(
+                    f"\n{self.name}: Cannot find key '{key}', also no factory matches.\n"
+                )
+                print("Known keys:")
+                for k in self.keys():
+                    print("   ", k)
+                if len(self.factories):
+                    print("\nKnown factories:")
+                    for f in self.factories:
+                        print("   ", f.name_template)
+                print()
+            raise e
+
     def __getitem__(self, key):
         try:
             return super().__getitem__(key)
@@ -535,7 +659,6 @@ class FDict(Dict):
                     return obj
                 except ValueError:
                     pass
-
         k = ", ".join(sorted(list(self.keys())))
         e = f"{self.name}: Cannot find key '{key}', also no factory matches. Known keys: {k}. Known factories: {[f.name_template for f in self.factories]}"
         raise KeyError(e)

foxes/utils/geom2d/circle.py

@@ -21,7 +21,7 @@ class Circle(AreaGeometry):
 
     def __init__(self, centre, radius):
         """
-        Cobnstructor.
+        Constructor.
 
         Parameters
         ----------

foxes/utils/geom2d/polygon.py

@@ -74,7 +74,7 @@ class ClosedPolygon(AreaGeometry):
         points: numpy.ndarray
             The probe points, shape (n_points, 2)
         return_nearest: bool
-            Flag for return of the nearest point on bundary
+            Flag for return of the nearest point on boundary
 
         Returns
         -------

foxes/utils/geopandas_utils.py

@@ -50,7 +50,7 @@ def check_import_utm():
 
 def read_shp(fname, **kwargs):
     """
-    Read a shape file
+    Read a shapefile file
 
     Parameters
     ----------
@@ -74,7 +74,7 @@ def read_shp(fname, **kwargs):
 
 def shp2csv(ifile, ofile, in_kwargs={}, out_kwargs={}, verbosity=1):
     """
-    Read shape file, write csv file
+    Read shapefile file, write csv file
 
     Parameters
     ----------