foxes 1.0__py3-none-any.whl → 1.1.1__py3-none-any.whl

foxes/input/windio/read_attributes.py

@@ -24,6 +24,7 @@ def _read_wind_deficit(
         {
             "Linear": "ws_linear",
             "Quadratic": "ws_quadratic",
+            "Product": "ws_product",
         },
         name="ws_sup_dict",
     )
@@ -31,6 +32,7 @@ def _read_wind_deficit(
         {
             "Linear": "ws_linear_amb",
             "Quadratic": "ws_quadratic_amb",
+            "Product": "ws_product",
         },
         name="ws_sup_dict",
     )
@@ -311,7 +313,7 @@ def _read_analysis(wio_ana, algo_dict, verbosity):
         print("deflection_model not found, using default settings")
 
 
-def read_attributes(wio, algo_dict, verbosity):
+def read_attributes(wio, algo_dict, verbosity=1, **output_pars):
     """
     Reads the attributes part of windio
 
@@ -323,6 +325,8 @@ def read_attributes(wio, algo_dict, verbosity):
         The algorithm dictionary
     verbosity: int
         The verbosity level, 0=silent
+    **output_pars: dict, optional
+        Additional parameters for output reading
 
     Returns
     -------
@@ -358,6 +362,8 @@ def read_attributes(wio, algo_dict, verbosity):
     out_dicts = []
     if "outputs" in wio_attrs:
         outputs = Dict(wio_attrs["outputs"], name="outputs")
-        out_dicts, odir = read_outputs(outputs, algo_dict, verbosity)
+        out_dicts, odir = read_outputs(
+            outputs, algo_dict, verbosity=verbosity, **output_pars
+        )
 
     return out_dicts, odir

foxes/input/windio/read_fields.py

@@ -143,6 +143,9 @@ def read_wind_resource_field(
         "lapse_rate",
         "capping_inversion_thickness",
         "capping_inversion_strength",
+        "tau_x",
+        "tau_y",
+        "fc",
     ]:
         if verbosity > 2:
             print(f"        Ignoring variable '{name}'")

foxes/input/windio/read_outputs.py

@@ -126,7 +126,7 @@ def _read_flow_field(wio_outs, odir, out_dicts, verbosity):
             )
 
 
-def read_outputs(wio_outs, algo_dict, verbosity):
+def read_outputs(wio_outs, algo_dict, output_dir=None, verbosity=1):
     """
     Reads the windio outputs
 
@@ -136,6 +136,8 @@ def read_outputs(wio_outs, algo_dict, verbosity):
         The windio output data
     algo_dict: dict
         The algorithm dictionary
+    output_dir: pathlib.Path, optional
+        Path to the output folder
     verbosity: int
         The verbosity level, 0=silent
 
@@ -150,7 +152,11 @@ def read_outputs(wio_outs, algo_dict, verbosity):
 
     """
     out_dicts = []
-    odir = Path(wio_outs.pop("output_folder", "results"))
+    odir = (
+        Path(output_dir)
+        if output_dir is not None
+        else Path(wio_outs.pop("output_folder", "results"))
+    )
     odir.mkdir(exist_ok=True, parents=True)
     if verbosity > 2:
         print("  Reading outputs")

foxes/input/windio/windio.py

@@ -95,6 +95,7 @@ def read_windio(
     windio_yaml,
     verbosity=1,
     algo_pars=None,
+    output_dir=None,
     **runner_pars,
 ):
     """
@@ -111,6 +112,8 @@ def read_windio(
         The verbosity level, 0 = silent
     algo_pars: dict, optional
         Additional algorithm parameters
+    output_dir: str, optional
+        Path to the output folder
     runner_pars: dict, optional
         Additional parameters for the WindioRunner
 
@@ -130,7 +133,7 @@ def read_windio(
     if verbosity > 0:
         print(f"Reading windio file {wio_file}")
 
-    yml_utils = import_module("windIO.utils.yml_utils", hint="pip install windio")
+    yml_utils = import_module("windIO.utils.yml_utils", hint="pip install git+https://github.com/kilojoules/windIO@master#egg=windIO")
     wio = yml_utils.load_yaml(wio_file)
 
     if verbosity > 1:
@@ -155,7 +158,8 @@ def read_windio(
     out_dicts, odir = read_attributes(
         wio,
         algo_dict,
-        verbosity,
+        output_dir=output_dir,
+        verbosity=verbosity,
     )
 
     if verbosity > 1:

foxes/models/farm_models/turbine2farm.py

@@ -65,7 +65,7 @@ class Turbine2FarmModel(FarmModel):
         return self.turbine_model.output_farm_vars(algo)
 
     def calculate(self, algo, mdata, fdata, **parameters):
-        """ "
+        """
         The main model calculation.
 
         This function is executed on a single chunk of data,

foxes/models/ground_models/wake_mirror.py

@@ -56,7 +56,7 @@ class WakeMirror(GroundModel):
             The target point data
         downwind_index: int
             The index of the wake causing turbine
-            in the downwnd order
+            in the downwind order
         wake_deltas: dict
             The wake deltas. Key: variable name,
             value: numpy.ndarray with shape
@@ -117,7 +117,7 @@ class WakeMirror(GroundModel):
             The target point data
         downwind_index: int
             The index of the wake causing turbine
-            in the downwnd order
+            in the downwind order
         wake_deltas: dict
             The wake deltas. Key: variable name,
             value: numpy.ndarray with shape

foxes/models/model_book.py

@@ -460,12 +460,39 @@ class ModelBook:
         )
 
         self.wake_models[f"RHB"] = fm.wake_models.induction.RankineHalfBody()
+
+        self.wake_models[f"VortexSheet"] = fm.wake_models.induction.VortexSheet()
+        self.wake_models.add_factory(
+            fm.wake_models.induction.VortexSheet,
+            "VortexSheet_<superposition>",
+            superposition=lambda s: f"ws_{s}",
+            hints={"superposition": "(Superposition, e.g. linear for ws_linear)"},
+        )
+
         self.wake_models[f"Rathmann"] = fm.wake_models.induction.Rathmann()
+        self.wake_models.add_factory(
+            fm.wake_models.induction.Rathmann,
+            "Rathmann_<superposition>",
+            superposition=lambda s: f"ws_{s}",
+            hints={"superposition": "(Superposition, e.g. linear for ws_linear)"},
+        )
+
         self.wake_models[f"SelfSimilar"] = fm.wake_models.induction.SelfSimilar()
         self.wake_models[f"SelfSimilar2020"] = (
             fm.wake_models.induction.SelfSimilar2020()
         )
-        self.wake_models[f"VortexSheet"] = fm.wake_models.induction.VortexSheet()
+        self.wake_models.add_factory(
+            fm.wake_models.induction.SelfSimilar,
+            "SelfSimilar_<superposition>",
+            superposition=lambda s: f"ws_{s}",
+            hints={"superposition": "(Superposition, e.g. linear for ws_linear)"},
+        )
+        self.wake_models.add_factory(
+            fm.wake_models.induction.SelfSimilar2020,
+            "SelfSimilar2020_<superposition>",
+            superposition=lambda s: f"ws_{s}",
+            hints={"superposition": "(Superposition, e.g. linear for ws_linear)"},
+        )
 
         self.ground_models = FDict(name="ground_models")
         self.ground_models["no_ground"] = fm.ground_models.NoGround()
@@ -515,7 +542,7 @@ class ModelBook:
                 m.name = k
 
     def __getitem__(self, key):
-        return self.sources.__getitem__(key)
+        return self.sources.get_item(key)
 
     def print_toc(self, subset=None, search=None):
         """

foxes/models/partial_wakes/axiwake.py

@@ -95,7 +95,7 @@ class PartialAxiwake(PartialCentre):
             The target point data
         downwind_index: int
             The index of the wake causing turbine
-            in the downwnd order
+            in the downwind order
         wake_deltas: dict
             The wake deltas. Key: variable name,
             value: numpy.ndarray with shape
@@ -127,7 +127,7 @@ class PartialAxiwake(PartialCentre):
         wcoos = algo.wake_frame.get_wake_coos(algo, mdata, fdata, tdata, downwind_index)
 
         # prepare x and r coordinates:
-        x = np.round(wcoos[..., 0, 0], 12)
+        x = wcoos[..., 0, 0]
         n = wcoos[..., 0, 1:3]
         R = np.linalg.norm(n, axis=-1)
         r = np.zeros((n_states, n_targets, self.n), dtype=FC.DTYPE)
@@ -145,7 +145,7 @@ class PartialAxiwake(PartialCentre):
             n[:, :, 0][~sel] = 1
 
         # case wake centre outside rotor disk:
-        sel = (x > 0) & (R > D / 2)
+        sel = (x > 1e-8) & (R > D / 2)
         if np.any(sel):
             n_sel = np.sum(sel)
             Rsel = np.zeros((n_sel, self.n + 1), dtype=FC.DTYPE)

foxes/models/partial_wakes/top_hat.py

@@ -121,7 +121,7 @@ class PartialTopHat(PartialCentre):
             The target point data
         downwind_index: int
             The index of the wake causing turbine
-            in the downwnd order
+            in the downwind order
         wake_deltas: dict
             The wake deltas. Key: variable name,
             value: numpy.ndarray with shape
@@ -148,7 +148,7 @@ class PartialTopHat(PartialCentre):
             upcast=True,
         )
 
-        sel0 = (ct > 0) & (x > 0)
+        sel0 = (ct > 1e-8) & (x > 1e-8)
         if np.any(sel0):
             R = np.linalg.norm(yz, axis=-1)
             del yz

foxes/models/point_models/set_uniform_data.py

@@ -119,7 +119,7 @@ class SetUniformData(PointDataModel):
         return self.ovars
 
     def calculate(self, algo, mdata, fdata, pdata):
-        """ "
+        """
         The main model calculation.
 
         This function is executed on a single chunk of data,

foxes/models/point_models/tke2ti.py

@@ -30,7 +30,7 @@ class TKE2TI(PointDataModel):
         return [FV.TI]
 
     def calculate(self, algo, mdata, fdata, pdata):
-        """ "
+        """
         The main model calculation.
 
         This function is executed on a single chunk of data,

foxes/models/point_models/wake_deltas.py

@@ -52,7 +52,7 @@ class WakeDeltas(PointDataModel):
         return [f"DELTA_{v}" for v in self.vars]
 
     def calculate(self, algo, mdata, fdata, pdata):
-        """ "
+        """
         The main model calculation.
 
         This function is executed on a single chunk of data,

foxes/models/rotor_models/grid.py

@@ -16,7 +16,7 @@ class GridRotor(RotorModel):
         maximal number of points is N = n * n
     reduce: bool
         Flag for reduction to points actually representing
-        an area with overlap with the circe, recalculating
+        an area with overlap with the circle, recalculating
         the self.__weights accordingly
     nint: int
         Integration steps per element
@@ -36,7 +36,7 @@ class GridRotor(RotorModel):
             maximal number of points is N = n * n
         reduce: bool
             Flag for reduction to points actually representing
-            an area with overlap with the circe, recalculating
+            an area with overlap with the circle, recalculating
             the self.__weights accordingly
         nint: int
             Integration steps per element

foxes/models/turbine_models/calculator.py

@@ -8,11 +8,11 @@ class Calculator(TurbineModel):
     Attributes
     ----------
     in_vars: list of str
-        The input farm vairables
+        The input farm variables
     out_vars: list of str
         The output variables
     func: Function
-        The function: f(in0, in1, ..., stsel) -> (out0, ou1, ...)
+        The function: f(in0, in1, ..., stsel) -> (out0, out1, ...)
         where inX and outY are numpy.ndarrays and
         st_sel is the state-turbine selection slice or array.
         All arrays have shape (n_states, n_turbines).
@@ -28,11 +28,11 @@ class Calculator(TurbineModel):
         Parameters
         ----------
         in_vars: list of str
-            The input farm vairables
+            The input farm variables
         out_vars: list of str
             The output variables
         func: Function
-            The function: f(in0, in1, ..., stsel) -> (out0, ou1, ...)
+            The function: f(in0, in1, ..., stsel) -> (out0, out1, ...)
             where inX and outY are numpy.ndarrays and
             st_sel is the state-turbine selection slice or array.
             All arrays have shape (n_states, n_turbines).

foxes/models/turbine_models/kTI_model.py

@@ -101,15 +101,31 @@ class kTI(TurbineModel):
             Values: numpy.ndarray with shape (n_states, n_turbines)
 
         """
+
         kti = self.get_data(
-            FV.KTI, FC.STATE_TURBINE, lookup="sf", fdata=fdata, upcast=True
-        )[st_sel]
+            FV.KTI,
+            FC.STATE_TURBINE,
+            lookup="sf",
+            fdata=fdata,
+            upcast=False,
+            selection=st_sel,
+        )
         kb = self.get_data(
-            FV.KB, FC.STATE_TURBINE, lookup="sf", fdata=fdata, upcast=True
-        )[st_sel]
+            FV.KB,
+            FC.STATE_TURBINE,
+            lookup="sf",
+            fdata=fdata,
+            upcast=False,
+            selection=st_sel,
+        )
         ti = self.get_data(
-            self.ti_var, FC.STATE_TURBINE, lookup="sf", fdata=fdata, upcast=True
-        )[st_sel]
+            self.ti_var,
+            FC.STATE_TURBINE,
+            lookup="f",
+            fdata=fdata,
+            upcast=False,
+            selection=st_sel,
+        )
 
         k = fdata.get(
             self.k_var, np.zeros((fdata.n_states, fdata.n_turbines), dtype=FC.DTYPE)

foxes/models/turbine_models/lookup_table.py

@@ -192,8 +192,9 @@ class LookupTable(TurbineModel):
                 FC.STATE_TURBINE,
                 lookup="fs",
                 fdata=fdata,
-                upcast=True,
-            )[st_sel]
+                upcast=False,
+                selection=st_sel,
+            )
             for v in self.input_vars
         }
 

foxes/models/turbine_types/PCt_file.py

@@ -25,7 +25,7 @@ class PCtFile(TurbineType):
     col_ct: str
         The ct column
     rho: float
-        The air densitiy for which the data is valid
+        The air density for which the data is valid
         or None for no correction
     WSCT: str
         The wind speed variable for ct lookup
@@ -66,7 +66,7 @@ class PCtFile(TurbineType):
         col_ct: str
             The ct column
         rho: float, optional
-            The air densitiy for which the data is valid
+            The air density for which the data is valid
             or None for no correction
         p_ct: float
             The exponent for yaw dependency of ct
@@ -108,7 +108,7 @@ class PCtFile(TurbineType):
 
     def needs_rews2(self):
         """
-        Returns flag for requirering REWS2 variable
+        Returns flag for requiring REWS2 variable
 
         Returns
         -------
@@ -120,7 +120,7 @@ class PCtFile(TurbineType):
 
     def needs_rews3(self):
         """
-        Returns flag for requirering REWS3 variable
+        Returns flag for requiring REWS3 variable
 
         Returns
         -------
@@ -276,7 +276,7 @@ class PCtFile(TurbineType):
             super().modify_cutin(modify_ct, modify_P)
 
     def calculate(self, algo, mdata, fdata, st_sel):
-        """ "
+        """
         The main model calculation.
 
         This function is executed on a single chunk of data,

foxes/models/turbine_types/PCt_from_two.py

@@ -26,7 +26,7 @@ class PCtFromTwo(TurbineType):
     col_ct: str
         The ct column
     rho: float
-        The air densitiy for which the data is valid
+        The air density for which the data is valid
         or None for no correction
     WSCT: str
         The wind speed variable for ct lookup
@@ -76,7 +76,7 @@ class PCtFromTwo(TurbineType):
         col_ct: str
             The ct column
         rho: float, optional
-            The air densitiy for which the data is valid
+            The air density for which the data is valid
             or None for no correction
         p_ct: float
             The exponent for yaw dependency of ct
@@ -128,7 +128,7 @@ class PCtFromTwo(TurbineType):
 
     def needs_rews2(self):
         """
-        Returns flag for requirering REWS2 variable
+        Returns flag for requiring REWS2 variable
 
         Returns
         -------
@@ -140,7 +140,7 @@ class PCtFromTwo(TurbineType):
 
     def needs_rews3(self):
         """
-        Returns flag for requirering REWS3 variable
+        Returns flag for requiring REWS3 variable
 
         Returns
         -------
@@ -313,7 +313,7 @@ class PCtFromTwo(TurbineType):
             super().modify_cutin(modify_ct, modify_P)
 
     def calculate(self, algo, mdata, fdata, st_sel):
-        """ "
+        """
         The main model calculation.
 
         This function is executed on a single chunk of data,

foxes/models/turbine_types/TBL_file.py

@@ -0,0 +1,80 @@
+import numpy as np
+import pandas as pd
+from pathlib import Path
+
+from .PCt_file import PCtFile
+from foxes.data import parse_Pct_file_name
+import foxes.constants as FC
+
+
+class TBLFile(PCtFile):
+    """
+    Reads turbine data from a TBL file.
+
+    Examples
+    --------
+    A TBL file is a csv file with space as separator
+    and two header lines. The followind lines denote
+    wind speed, ct, P.
+
+    - first row will be ignored
+    - second row: H D ct-stand-still rated-power-in-MW
+    - further rows: ws ct P-in-kW
+
+    For example:
+
+    45
+    175.0 290.0 0.03 22.0
+    3.0 0.820 102.9
+    3.5 0.800 444.0
+    4.0 0.810 874.7
+    4.5 0.820 1418.7
+    5.0 0.820 2100.9
+    5.5 0.830 3021.2
+    6.0 0.830 3904.7
+    6.5 0.830 5061.7
+    7.0 0.810 6379.0
+
+    :group: models.turbine_types
+
+    """
+
+    def __init__(
+        self,
+        tbl_file,
+        rho=1.225,
+        **parameters,
+    ):
+        """
+        Constructor.
+
+        Parameters
+        ----------
+        tbl_file: str
+            Path to the tbl file
+        rho: float
+            The air density for the curves
+        paramerers: dict, optional
+            Additional parameters for PCtFile class
+
+        """
+        fpath = Path(tbl_file)
+        assert fpath.suffix == ".tbl", f"Expecting *.tbl file, got '{tbl_file}'"
+
+        meta = np.genfromtxt(fpath, skip_header=1, max_rows=1)
+        sdata = pd.read_csv(
+            fpath, sep=" ", skiprows=2, header=None, names=["ws", "ct", "P"]
+        )
+
+        super().__init__(
+            sdata,
+            col_ws="ws",
+            col_P="P",
+            col_ct="ct",
+            H=meta[0],
+            D=meta[1],
+            P_nominal=meta[3] * 1e3,
+            P_unit="kW",
+            rho=rho,
+            **parameters,
+        )

foxes/models/turbine_types/__init__.py

@@ -10,3 +10,4 @@ from .null_type import NullType
 from .wsrho2PCt_from_two import WsRho2PCtFromTwo
 from .wsti2PCt_from_two import WsTI2PCtFromTwo
 from .lookup import FromLookupTable
+from .TBL_file import TBLFile

foxes/models/turbine_types/lookup.py

@@ -17,7 +17,7 @@ class FromLookupTable(TurbineType):
     source: str or pandas.DataFrame
         The file path, static name, or data
     rho: float
-        The air densitiy for which the data is valid
+        The air density for which the data is valid
         or None for no correction
     WSCT: str
         The wind speed variable for ct lookup
@@ -60,7 +60,7 @@ class FromLookupTable(TurbineType):
         lookup_pars: dict
             Additional parameters for the LookupTable model
         rho: float, optional
-            The air densitiy for which the data is valid
+            The air density for which the data is valid
             or None for no correction
         p_ct: float
             The exponent for yaw dependency of ct
@@ -119,7 +119,7 @@ class FromLookupTable(TurbineType):
 
     def needs_rews2(self):
         """
-        Returns flag for requirering REWS2 variable
+        Returns flag for requiring REWS2 variable
 
         Returns
         -------
@@ -131,7 +131,7 @@ class FromLookupTable(TurbineType):
 
     def needs_rews3(self):
         """
-        Returns flag for requirering REWS3 variable
+        Returns flag for requiring REWS3 variable
 
         Returns
         -------
@@ -228,7 +228,7 @@ class FromLookupTable(TurbineType):
             super().modify_cutin(modify_ct, modify_P)
 
     def calculate(self, algo, mdata, fdata, st_sel):
-        """ "
+        """
         The main model calculation.
 
         This function is executed on a single chunk of data,

foxes/models/turbine_types/null_type.py

@@ -37,7 +37,7 @@ class NullType(TurbineType):
 
     def needs_rews2(self):
         """
-        Returns flag for requirering REWS2 variable
+        Returns flag for requiring REWS2 variable
 
         Returns
         -------
@@ -49,7 +49,7 @@ class NullType(TurbineType):
 
     def needs_rews3(self):
         """
-        Returns flag for requirering REWS3 variable
+        Returns flag for requiring REWS3 variable
 
         Returns
         -------
@@ -77,7 +77,7 @@ class NullType(TurbineType):
         return []
 
     def calculate(self, algo, mdata, fdata, st_sel):
-        """ "
+        """
         The main model calculation.
 
         This function is executed on a single chunk of data,

foxes/models/turbine_types/wsrho2PCt_from_two.py

@@ -37,9 +37,9 @@ class WsRho2PCtFromTwo(TurbineType):
     rpars_ct: dict, optional
         Parameters for pandas ct file reading
     ipars_P: dict, optional
-        Parameters for scipy.interpolate.interpn()
+        Parameters for scipy.interpolate.interpn
     ipars_ct: dict, optional
-        Parameters for scipy.interpolate.interpn()
+        Parameters for scipy.interpolate.interpn
 
     :group: models.turbine_types
 
@@ -81,9 +81,9 @@ class WsRho2PCtFromTwo(TurbineType):
         pd_file_read_pars_ct:  dict
             Parameters for pandas ct file reading
         interpn_pars_P: dict, optional
-            Parameters for scipy.interpolate.interpn()
+            Parameters for scipy.interpolate.interpn
         interpn_pars_ct: dict, optional
-            Parameters for scipy.interpolate.interpn()
+            Parameters for scipy.interpolate.interpn
         parameters: dict, optional
             Additional parameters for TurbineType class
 
@@ -117,7 +117,7 @@ class WsRho2PCtFromTwo(TurbineType):
 
     def needs_rews2(self):
         """
-        Returns flag for requirering REWS2 variable
+        Returns flag for requiring REWS2 variable
 
         Returns
         -------
@@ -129,7 +129,7 @@ class WsRho2PCtFromTwo(TurbineType):
 
     def needs_rews3(self):
         """
-        Returns flag for requirering REWS3 variable
+        Returns flag for requiring REWS3 variable
 
         Returns
         -------
@@ -229,7 +229,7 @@ class WsRho2PCtFromTwo(TurbineType):
         print()
 
     def calculate(self, algo, mdata, fdata, st_sel):
-        """ "
+        """
         The main model calculation.
 
         This function is executed on a single chunk of data,