foxes 1.2.5__py3-none-any.whl → 1.4__py3-none-any.whl

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.2.5.dist-info → foxes-1.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: foxes
-Version: 1.2.5
+Version: 1.4
 Summary: Farm Optimization and eXtended yield Evaluation Software
 Author: Jonas Schulte
 Maintainer: Jonas Schulte
@@ -56,16 +56,15 @@ Requires-Dist: scipy
 Requires-Dist: cycler
 Requires-Dist: tqdm
 Requires-Dist: pyyaml
+Requires-Dist: h5netcdf
 Provides-Extra: opt
 Requires-Dist: foxes-opt; 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"
@@ -74,7 +73,6 @@ 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"
@@ -84,7 +82,6 @@ Requires-Dist: ray; extra == "eng0"
 Provides-Extra: test
 Requires-Dist: flake8; extra == "test"
 Requires-Dist: pytest; extra == "test"
-Requires-Dist: h5netcdf; extra == "test"
 Provides-Extra: doc
 Requires-Dist: setuptools; extra == "doc"
 Requires-Dist: sphinx; extra == "doc"
@@ -101,7 +98,8 @@ 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: ruff; extra == "dev"
+Dynamic: license-file
 
 # Welcome to foxes
 
@@ -161,14 +159,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.8`...`3.13`.
 
 ## Installation
 
@@ -191,15 +182,17 @@ For detailed examples of how to run _foxes_, check the `examples` and `notebooks
 ```python
 import foxes
 
-states = foxes.input.states.Timeseries("timeseries_3000.csv.gz", ["WS", "WD","TI","RHO"])
+if __name__ == "__main__":
+
+    states = foxes.input.states.Timeseries("timeseries_3000.csv.gz", ["WS", "WD","TI","RHO"])
 
-farm = foxes.WindFarm()
-foxes.input.farm_layout.add_from_file(farm, "test_farm_67.csv", turbine_models=["NREL5MW"])
+    farm = foxes.WindFarm()
+    foxes.input.farm_layout.add_from_file(farm, "test_farm_67.csv", turbine_models=["NREL5MW"])
 
-algo = foxes.algorithms.Downwind(farm, states, ["Jensen_linear_k007"])
-farm_results = algo.calc_farm()
+    algo = foxes.algorithms.Downwind(farm, states, ["Jensen_linear_k007"])
+    farm_results = algo.calc_farm()
 
-print(farm_results)
+    print(farm_results)
 ```
 
 ## Testing