foxes 1.3__py3-none-any.whl → 1.5__py3-none-any.whl

foxes/utils/dict.py

@@ -6,16 +6,11 @@ class Dict(dict):
     """
     A slightly enhanced dictionary.
 
-    Attributes
-    ----------
-    name: str
-        The dictionary name
-
     :group: utils
 
     """
 
-    def __init__(self, *args, name=None, **kwargs):
+    def __init__(self, *args, _name=None, **kwargs):
         """
         Constructor.
 
@@ -23,38 +18,28 @@ class Dict(dict):
         ----------
         *args: tuple, optional
             Arguments passed to `dict`
-        name: str, optional
+        _name: str, optional
             The dictionary name
         **kwargs: dict, optional
             Arguments passed to `dict`
 
         """
-        tmp = dict()
-        for a in args:
-            tmp.update(
-                {
-                    k: (
-                        Dict(d, name=f"{name}.{k}")
-                        if isinstance(d, dict) and not isinstance(d, Dict)
-                        else d
-                    )
-                    for k, d in a.items()
-                }
-            )
-
-        super().__init__(
-            **tmp,
-            **{
-                k: (
-                    Dict(d, name=k)
-                    if isinstance(d, dict) and not isinstance(d, Dict)
-                    else d
-                )
-                for k, d in kwargs.items()
-            },
-        )
+        super().__init__()
+        self._name = _name if _name is not None else type(self).__name__
+        self.update(*args, **kwargs)
+
+    @property
+    def name(self):
+        """
+        The dictionary name
+
+        Returns
+        -------
+        name: str
+            The dictionary name
 
-        self.name = name if name is not None else type(self).__name__
+        """
+        return self._name
 
     def get_item(self, key, *deflt, prnt=True):
         """
@@ -77,9 +62,9 @@ class Dict(dict):
         """
         try:
             if len(deflt):
-                assert (
-                    len(deflt) == 1
-                ), f"Expecting a single default entry, got {len(deflt)}"
+                assert len(deflt) == 1, (
+                    f"Expecting a single default entry, got {len(deflt)}"
+                )
                 data = self.get(key, deflt[0])
             else:
                 data = self[key]
@@ -93,7 +78,7 @@ class Dict(dict):
             raise e
 
         if isinstance(data, dict) and not isinstance(data, Dict):
-            data = Dict(data, name=f"{self.name}.{key}")
+            data = Dict(data, _name=f"{self.name}.{key}")
 
         return data
 
@@ -121,6 +106,25 @@ class Dict(dict):
             del self[key]
         return data
 
+    def __setitem__(self, key, value):
+        if isinstance(value, list):
+            out = []
+            for i, x in enumerate(value):
+                if isinstance(x, dict) and not isinstance(x, Dict):
+                    nme = f"{self.name}.{key}"
+                    if len(value) > 1:
+                        nme += f".{i}"
+                    out.append(Dict(x, _name=nme))
+                else:
+                    out.append(x)
+            value = out
+        elif isinstance(value, dict) and not isinstance(value, Dict):
+            out = Dict(_name=f"{self.name}.{key}")
+            out.update(value)
+            value = out
+
+        super().__setitem__(key, value)
+
     def __getitem__(self, key):
         try:
             return super().__getitem__(key)
@@ -129,6 +133,14 @@ class Dict(dict):
             e = f"{self.name}: Cannot find key '{key}'. Known keys: {k}"
             raise KeyError(e)
 
+    def update(self, *args, **kwargs):
+        """
+        Update the dictionary with the key/value pairs from other, overwriting existing keys.
+        """
+        other = dict(*args, **kwargs)
+        for k, v in other.items():
+            self[k] = v
+
     @classmethod
     def from_yaml(self, yml_file, verbosity=1):
         """
@@ -158,7 +170,7 @@ class Dict(dict):
             data = safe_load(stream)
         if data is None:
             data = {}
-        dct = Dict(data, name=fpath.stem)
+        dct = Dict(data, _name=fpath.stem)
         _print(dct, level=2)
 
         return dct

foxes/utils/exec_python.py

@@ -1,7 +1,7 @@
-import numpy as np
-import pandas as pd
-import xarray as xr
-import matplotlib.pyplot as plt
+import numpy as np  # noqa: F401
+import pandas as pd  # noqa: F401
+import xarray as xr  # noqa: F401
+import matplotlib.pyplot as plt  # noqa: F401
 
 
 def exec_python(s, indicator="%", newline=";", globals=globals(), locals={}):
@@ -38,7 +38,7 @@ def exec_python(s, indicator="%", newline=";", globals=globals(), locals={}):
         L = len(indicator)
         if len(s) > L and s[:L] == indicator:
             a = s[L:]
-            if not indicator in a:
+            if indicator not in a:
                 exec(a, globals, locals)
             else:
                 ilist = a.split(indicator)

foxes/utils/factory.py

@@ -107,7 +107,7 @@ class Factory:
                         f"Factory '{name_template}': Require indicator before variable '{v}' in template, e.g. '{v}<{v}>'"
                     )
 
-        self.options = Dict(name=f"{self._pre[0]}_options")
+        self.options = Dict(_name=f"{self._pre[0]}_options")
         for v, o in options.items():
             if v not in self.variables:
                 raise KeyError(
@@ -121,7 +121,7 @@ class Factory:
                         raise TypeError(
                             f"Factory '{name_template}': Found option for variable '{v}' that is not a str, {k}"
                         )
-                self.options[v] = Dict(name=f"{self._pre[0]}_options_{v}", **o)
+                self.options[v] = Dict(_name=f"{self._pre[0]}_options_{v}", **o)
             elif hasattr(o, "__call__"):
                 self.options[v] = o
             else:
@@ -526,9 +526,7 @@ class WakeKFactory:
                 s += f"\n  {v} from {list(f0.options[v])}"
             else:
                 s += f"\n  {v}={f0.hints.get(v, '(value)')}"
-        s += (
-            f"\n  [wake_k]=(None or k<k> or ka<ka> or ka<ka>_kb<kb>, e.g. 004 for 0.04)"
-        )
+        s += "\n  [wake_k]=(None or k<k> or ka<ka> or ka<ka>_kb<kb>, e.g. 004 for 0.04)"
         return s
 
 

foxes/utils/geom2d/__init__.py

@@ -2,8 +2,10 @@
 Geometries in two dimensions.
 """
 
-from .area_geometry import AreaGeometry, InvertedAreaGeometry
-from .area_geometry import AreaUnion, AreaIntersection
-from .polygon import ClosedPolygon
-from .circle import Circle
-from .half_plane import HalfPlane
+from .area_geometry import AreaGeometry as AreaGeometry
+from .area_geometry import InvertedAreaGeometry as InvertedAreaGeometry
+from .area_geometry import AreaUnion as AreaUnion
+from .area_geometry import AreaIntersection as AreaIntersection
+from .polygon import ClosedPolygon as ClosedPolygon
+from .circle import Circle as Circle
+from .half_plane import HalfPlane as HalfPlane

foxes/utils/geopandas_utils.py

@@ -179,7 +179,7 @@ def read_shp_polygons(
     utmz = None
     utml = None
     apply_utm = False
-    if isinstance(to_utm, str) or to_utm == True:
+    if isinstance(to_utm, str) or to_utm:
         apply_utm = True
         check_import_utm()
         utmz = int(to_utm[:-1]) if isinstance(to_utm, str) else None
@@ -190,7 +190,7 @@ def read_shp_polygons(
     names = pnames if names is None else names
     for name in names:
         if name == name:  # exclude nan values
-            if not name in pnames:
+            if name not in pnames:
                 raise KeyError(
                     f"Name '{name}' not found in file '{fname}'. Names: {pnames}"
                 )

foxes/utils/pandas_utils.py

@@ -106,9 +106,10 @@ class PandasFileHelper:
             elif sfx == "h5":
                 f = pd.read_hdf
             elif sfx == "nc":
-                f = lambda fname, **pars: xarray.open_dataset(
-                    fname, **pars
-                ).to_dataframe()
+
+                def f(fname, **pars):
+                    """little helper to read netcdf files"""
+                    return xarray.open_dataset(fname, **pars).to_dataframe()
 
             if f is not None:
                 pars = deepcopy(cls.DEFAULT_READING_PARAMETERS[fmt])

foxes/utils/tab_files.py

@@ -63,7 +63,6 @@ def read_tab_file(fname, normalize=True):
 
 
 if __name__ == "__main__":
-
     import argparse
 
     parser = argparse.ArgumentParser()

foxes/utils/weibull.py

@@ -0,0 +1,28 @@
+import numpy as np
+
+
+def weibull_weights(ws, ws_deltas, A, k):
+    """
+    Computes the weibull weights for given wind speeds
+
+    Parameters
+    ----------
+    ws: numpy.ndarray
+        The wind speed bin centre values
+    ws_deltas: numpy.ndarray
+        The wind speed bin widths, same shape as ws
+    A: numpy.ndarray
+        The Weibull scale parameters, same shape as ws
+    k: numpy.ndarray
+        The Weibull shape parameters, same shape as ws
+
+    Returns
+    -------
+    weights: numpy.ndarray
+        The weights, same shape as ws
+
+    :group: utils
+
+    """
+    wsA = ws / A
+    return ws_deltas * (k / A * wsA ** (k - 1) * np.exp(-(wsA**k)))

foxes/utils/wrg_utils.py

@@ -42,7 +42,9 @@ class ReaderWRG:
                 int(self._res),
             )
 
-        cols_sel = lambda name, secs: [f"{name}_{i}" for i in range(secs)]
+        def cols_sel(name, secs):
+            """little helper to create column names"""
+            return [f"{name}_{i}" for i in range(secs)]
 
         cols = [0] * (8 + 3 * self._n_sectors)
         cols[0] = "utmx"

foxes/utils/xarray_utils.py

@@ -1,3 +1,5 @@
+import numpy as np
+from xarray import Dataset
 from pathlib import Path
 
 from foxes.variables import get_default_digits
@@ -31,18 +33,23 @@ def write_nc(
     """
     fpath = Path(fpath)
     if round is not None:
+        crds = {}
         for v in ds.coords.keys():
             d = round.get(v, get_default_digits(v))
             if d is not None:
                 if verbosity > 1:
                     print(f"File {fpath.name}: Rounding {v} to {d} decimals")
-                ds[v].data = ds[v].data.round(decimals=d)
+                crds[v] = np.round(ds[v].to_numpy(), d)
+            else:
+                crds[v] = ds[v].to_numpy()
+        dvrs = {}
         for v in ds.data_vars.keys():
             d = round.get(v, get_default_digits(v))
             if d is not None:
                 if verbosity > 1:
                     print(f"File {fpath.name}: Rounding {v} to {d} decimals")
-                ds[v].data = ds[v].data.round(decimals=d)
+                dvrs[v] = (ds[v].dims, np.round(ds[v].to_numpy(), d))
+        ds = Dataset(coords=crds, data_vars=dvrs)
 
     enc = None
     if complevel is not None and complevel > 0:

foxes/variables.py

@@ -54,6 +54,21 @@ WD = "WD"
 :group: foxes.variables
 """
 
+UV = "UV"
+""" The 2D wind vector in m/s
+:group: foxes.variables
+"""
+
+U = "U"
+""" The first horizontal wind vector component in m/s
+:group: foxes.variables
+"""
+
+V = "V"
+""" The second horizontal wind vector component in m/s
+:group: foxes.variables
+"""
+
 TI = "TI"
 """ The turbulence intensity
 :group: foxes.variables
@@ -128,6 +143,17 @@ calculated from third moment
 """
 
 
+WEIBULL_A = "Weibull_A"
+""" The Weibull scale parameter,
+:group: foxes.variables
+"""
+
+WEIBULL_k = "Weibull_k"
+""" The Weibull shape parameter,
+:group: foxes.variables
+"""
+
+
 AMB_WS = "AMB_WS"
 """ The ambient wind speed in m/s
 :group: foxes.variables
@@ -138,6 +164,21 @@ AMB_WD = "AMB_WD"
 :group: foxes.variables
 """
 
+AMB_UV = "AMB_UV"
+""" The ambient 2D wind vector in m/s
+:group: foxes.variables
+"""
+
+AMB_U = "AMB_U"
+""" The first horizontal ambient wind vector component in m/s
+:group: foxes.variables
+"""
+
+AMB_V = "AMB_V"
+""" The second horizontal ambient wind vector component in m/s
+:group: foxes.variables
+"""
+
 AMB_TI = "AMB_TI"
 """ The ambient turbulence intensity
 :group: foxes.variables
@@ -203,6 +244,16 @@ calculated from third moment
 :group: foxes.variables
 """
 
+AMB_WEIBULL_A = "AMB_Weibull_A"
+""" Ambient Weibull scale parameter,
+:group: foxes.variables
+"""
+
+AMB_WEIBULL_k = "AMB_Weibull_k"
+""" Ambient Weibull shape parameter,
+:group: foxes.variables
+"""
+
 
 var2amb = {
     v: f"AMB_{v}"
@@ -219,8 +270,13 @@ var2amb = {
         REWS,
         REWS2,
         REWS3,
+        WEIBULL_A,
+        WEIBULL_k,
         YLD,
         CAP,
+        UV,
+        U,
+        V,
     ]
 }
 """ Mapping from variable to the corresponding
@@ -282,9 +338,10 @@ PA_BETA = "PA_beta"
 :group: foxes.variables
 """
 
-DEFAULT_DIGITS = {
+DEFAULT_DIGITS = 4
+
+ROUND_DIGITS = {
     WD: 3,
-    WS: 4,
     TI: 6,
     RHO: 5,
     P: 3,
@@ -293,10 +350,14 @@ DEFAULT_DIGITS = {
     YLD: 3,
     CAP: 5,
     EFF: 5,
+    WEIBULL_A: 3,
+    WEIBULL_k: 3,
+    YAW: 3,
+    YAWM: 3,
 }
-""" The default output digits
-:group: foxes.variables
-"""
+ROUND_DIGITS.update(
+    {var2amb[v]: ROUND_DIGITS[v] for v in var2amb.keys() if v in ROUND_DIGITS}
+)
 
 
 def get_default_digits(variable):
@@ -314,7 +375,4 @@ def get_default_digits(variable):
         The default number of output digits
 
     """
-    v = amb2var.get(variable, variable)
-    if v in [REWS, REWS2, REWS3]:
-        v = WS
-    return DEFAULT_DIGITS.get(v, None)
+    return ROUND_DIGITS.get(variable, DEFAULT_DIGITS)

{foxes-1.3.dist-info → foxes-1.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: foxes
-Version: 1.3
+Version: 1.5
 Summary: Farm Optimization and eXtended yield Evaluation Software
 Author: Jonas Schulte
 Maintainer: Jonas Schulte
@@ -36,7 +36,6 @@ Classifier: Topic :: Scientific/Engineering
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Science/Research
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
@@ -45,63 +44,42 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Development Status :: 4 - Beta
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: matplotlib
-Requires-Dist: numpy
-Requires-Dist: pandas
-Requires-Dist: xarray
-Requires-Dist: scipy
-Requires-Dist: cycler
-Requires-Dist: tqdm
-Requires-Dist: pyyaml
+Requires-Dist: cycler>=0.10
+Requires-Dist: h5netcdf>=1.0
+Requires-Dist: matplotlib>=3.8
+Requires-Dist: numpy>=1.26
+Requires-Dist: pandas>=2.0
+Requires-Dist: pyyaml>=4.0
+Requires-Dist: scipy>=1.12
+Requires-Dist: tqdm>=2.0
+Requires-Dist: xarray>=2023
 Provides-Extra: opt
-Requires-Dist: foxes-opt; extra == "opt"
+Requires-Dist: foxes-opt>=0.5; extra == "opt"
 Provides-Extra: dask
-Requires-Dist: h5netcdf; extra == "dask"
-Requires-Dist: dask; extra == "dask"
-Requires-Dist: distributed; extra == "dask"
-Requires-Dist: dask-jobqueue; extra == "dask"
-Requires-Dist: setuptools; extra == "dask"
-Provides-Extra: eng
-Requires-Dist: h5netcdf; extra == "eng"
-Requires-Dist: multiprocess; extra == "eng"
-Requires-Dist: dask; extra == "eng"
-Requires-Dist: distributed; extra == "eng"
-Requires-Dist: dask-jobqueue; extra == "eng"
-Requires-Dist: setuptools; extra == "eng"
-Requires-Dist: mpi4py; extra == "eng"
-Requires-Dist: ray; extra == "eng"
-Provides-Extra: eng0
-Requires-Dist: h5netcdf; extra == "eng0"
-Requires-Dist: multiprocess; extra == "eng0"
-Requires-Dist: dask; extra == "eng0"
-Requires-Dist: distributed; extra == "eng0"
-Requires-Dist: dask-jobqueue; extra == "eng0"
-Requires-Dist: setuptools; extra == "eng0"
-Requires-Dist: ray; extra == "eng0"
-Provides-Extra: test
-Requires-Dist: flake8; extra == "test"
-Requires-Dist: pytest; extra == "test"
-Requires-Dist: h5netcdf; extra == "test"
+Requires-Dist: dask>=2022.0; extra == "dask"
+Requires-Dist: distributed>=2022.0; extra == "dask"
+Requires-Dist: dask-jobqueue>=0.8; extra == "dask"
+Requires-Dist: setuptools>=61.0; extra == "dask"
 Provides-Extra: doc
-Requires-Dist: setuptools; extra == "doc"
-Requires-Dist: sphinx; extra == "doc"
-Requires-Dist: sphinx-immaterial; extra == "doc"
-Requires-Dist: nbsphinx; extra == "doc"
-Requires-Dist: ipykernel; extra == "doc"
-Requires-Dist: ipywidgets; extra == "doc"
-Requires-Dist: m2r2; extra == "doc"
-Requires-Dist: lxml_html_clean; extra == "doc"
-Requires-Dist: dask; extra == "doc"
-Requires-Dist: distributed; extra == "doc"
-Provides-Extra: dev
-Requires-Dist: flake8; extra == "dev"
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: jupyter; extra == "dev"
-Requires-Dist: objsize; extra == "dev"
-Requires-Dist: black[jupyter]; extra == "dev"
+Requires-Dist: setuptools>=61.0; extra == "doc"
+Requires-Dist: sphinx>=5.0; extra == "doc"
+Requires-Dist: sphinx-immaterial>=0.10; extra == "doc"
+Requires-Dist: nbsphinx>=0.5; extra == "doc"
+Requires-Dist: ipykernel>=5.0; extra == "doc"
+Requires-Dist: ipywidgets>=5.0; extra == "doc"
+Requires-Dist: m2r2>=0.2; extra == "doc"
+Requires-Dist: lxml_html_clean>=0.4; extra == "doc"
+Requires-Dist: dask>=2022.0; extra == "doc"
+Requires-Dist: distributed>=2022.0; extra == "doc"
+Provides-Extra: test
+Requires-Dist: flake8>=0.1; extra == "test"
+Requires-Dist: pytest>=7.0; extra == "test"
+Provides-Extra: utils
+Requires-Dist: objsize>=0.5; extra == "utils"
+Dynamic: license-file
 
 # Welcome to foxes
 
@@ -161,14 +139,7 @@ Evaluation Software"`
 
 ## Requirements
 
-The supported Python versions are: 
-
-- `Python 3.8`
-- `Python 3.9`
-- `Python 3.10`
-- `Python 3.11`
-- `Python 3.12`
-- `Python 3.13`
+The supported Python versions are `Python 3.9`...`3.13`.
 
 ## Installation