foxes 1.5.1__py3-none-any.whl → 1.5.2__py3-none-any.whl

foxes/input/yaml/windio/read_attributes.py

@@ -167,7 +167,13 @@ def _read_blockage(blockage_model, induction, algo_dict, mbook, verbosity):
         print("      Name:", wname)
         print("      Contents:", [k for k in blockage_model.keys()])
     if wname not in ["None", "none"]:
-        indc_dict = Dict(wmodel_type=indc_def_map[wname], induction=induction)
+        kys = list(blockage_model.keys())
+        for k in kys:
+            if len(k) > 3 and k[:3] == "ss_":
+                blockage_model[k[3:]] = blockage_model.pop_item(k)
+        indc_dict = Dict(
+            wmodel_type=indc_def_map[wname], induction=induction, **blockage_model
+        )
         mbook.wake_models[wname] = WakeModel.new(**indc_dict)
         if verbosity > 2:
             print(f"      Created wake model '{wname}':")
@@ -378,7 +384,7 @@ def read_attributes(wio_attrs, idict, mbook, verbosity=1):
             print("    Reading flow_model")
             print("      Name:", fmname)
             print("      Contents:", [k for k in flow_model.keys()])
-        if fmname != "foxes":
+        if verbosity > 0 and fmname != "foxes":
             print(f"Running flow model 'foxes', overruling original choice '{fmname}'")
 
     # read analysis:

foxes/input/yaml/windio/read_farm.py

@@ -3,7 +3,9 @@ import pandas as pd
 
 from foxes.utils import Dict
 from foxes.core import Turbine, TurbineType, WindFarm
+from foxes.models.farm_controllers import BasicFarmController, OpFlagController
 import foxes.variables as FV
+import foxes.constants as FC
 
 
 def read_turbine_types(wio_farm, mbook, ws_exp_P, ws_exp_ct, verbosity):
@@ -204,6 +206,22 @@ def read_farm(wio_dict, mbook, verbosity):
         ws_exp_P = 1
         ws_exp_ct = 1
 
+    # create farm controller:
+    if FV.OPERATING in wio_farm:
+        op_dims, operating = wio_farm.pop_item(FV.OPERATING)
+        assert (
+            len(op_dims) == 2
+            and op_dims[1] == FC.TURBINE
+            and op_dims[0] in [FC.STATE, FC.TIME]
+        ), f"Expecting operating field to have dims (state, turbine), got {op_dims}"
+        mbook.farm_controllers["farm_cntrl"] = OpFlagController(operating)
+    else:
+        mbook.farm_controllers["farm_cntrl"] = BasicFarmController()
+    if verbosity > 1:
+        print(
+            f"  Farm controller type: {type(mbook.farm_controllers['farm_cntrl']).__name__}"
+        )
+
     # read turbine type:
     ttypes = read_turbine_types(wio_farm, mbook, ws_exp_P, ws_exp_ct, verbosity)
 
@@ -211,6 +229,8 @@ def read_farm(wio_dict, mbook, verbosity):
     farm = WindFarm()
     wfarm = wio_farm["layouts"]
     if isinstance(wfarm, dict):
+        if "coordinates" in wfarm:
+            wfarm = {"0": wfarm}
         layouts = Dict(wfarm, _name=wio_farm.name + ".layouts")
     else:
         layouts = {str(i): lf for i, lf in enumerate(wfarm)}

foxes/input/yaml/windio/read_fields.py

@@ -24,6 +24,7 @@ wio2foxes = {
     "reference_height": FV.H,
     "weibull_a": FV.WEIBULL_A,
     "weibull_k": FV.WEIBULL_k,
+    "operating": FV.OPERATING,
 }
 
 """ Mapping from foxes to windio variables
@@ -137,6 +138,7 @@ def read_wind_resource_field(
     """
     if name in [
         "potential_temperature",
+        "real_temperature",
         "friction_velocity",
         "k",
         "epsilon",
@@ -180,6 +182,7 @@ def read_wind_resource_field(
         "reference_height",
         "weibull_a",
         "weibull_k",
+        "operating",
     ] and _read_multi_dimensional_data(name, wio_data, fields, dims):
         return True
 

foxes/input/yaml/windio/read_outputs.py

@@ -110,14 +110,28 @@ def _read_flow_field(wio_outs, olist, algo, states_isel, verbosity):
             assert len(xb) == 2, f"Expecting two entries for x_bounds, got {xb}"
             yb = z_planes.pop_item("y_bounds")
             assert len(yb) == 2, f"Expecting two entries for y_bounds, got {yb}"
-            dx = z_planes.pop_item("dx")
-            dy = z_planes.pop_item("dy")
-            nx = max(int((xb[1] - xb[0]) / dx), 1) + 1
-            if (xb[1] - xb[0]) / (nx - 1) > dx:
-                nx += 1
-            ny = max(int((yb[1] - yb[0]) / dy), 1) + 1
-            if (yb[1] - yb[0]) / (ny - 1) > dy:
-                ny += 1
+            if "dx" in z_planes or "dy" in z_planes:
+                assert "dx" in z_planes and "dy" in z_planes, (
+                    f"Expecting both 'dx' and 'dy' in z_planes, got {list(z_planes.keys())}"
+                )
+                dx = z_planes.pop_item("dx")
+                dy = z_planes.pop_item("dy")
+                nx = max(int((xb[1] - xb[0]) / dx), 1) + 1
+                if (xb[1] - xb[0]) / (nx - 1) > dx:
+                    nx += 1
+                ny = max(int((yb[1] - yb[0]) / dy), 1) + 1
+                if (yb[1] - yb[0]) / (ny - 1) > dy:
+                    ny += 1
+            elif "Nx" in z_planes or "Ny" in z_planes:
+                assert "Nx" in z_planes and "Ny" in z_planes, (
+                    f"Expecting both 'Nx' and 'Ny' in z_planes, got {list(z_planes.keys())}"
+                )
+                nx = z_planes.pop_item("Nx")
+                ny = z_planes.pop_item("Ny")
+            else:
+                raise KeyError(
+                    f"Expecting either 'dx' and 'dy' or 'Nx' and 'Ny' in z_planes, got {list(z_planes.keys())}"
+                )
             z_list = np.asarray(z_list)
             if verbosity > 2:
                 print("          x_bounds      :", xb)
@@ -186,11 +200,10 @@ def read_outputs(wio_outs, idict, algo, verbosity=1):
 
     # read subset:
     run_configuration = wio_outs.pop_item("run_configuration", {})
+    states_isel = None
     if "times_run" in run_configuration:
         times_run = run_configuration.pop_item("times_run")
-        if times_run.get_item("all_occurences"):
-            states_isel = None
-        else:
+        if not times_run.get_item("all_occurences"):
             states_isel = times_run.get_item("subset")
     elif "wind_speeds_run" in run_configuration:
         wind_speeds_run = run_configuration.get_item("wind_speeds_run")
@@ -203,7 +216,6 @@ def read_outputs(wio_outs, idict, algo, verbosity=1):
             raise NotImplementedError(
                 f"Wind speed and direction subsets are not yet supported, got {directions_run.name} {directions_run}"
             )
-        states_isel = None
 
     # read turbine_outputs:
     _read_turbine_outputs(wio_outs, olist, algo, states_isel, verbosity)

foxes/input/yaml/windio/read_site.py

@@ -11,6 +11,14 @@ import foxes.constants as FC
 from .read_fields import read_wind_resource_field
 
 
+default_values = {
+    FV.WS: 8.0,
+    FV.WD: 270.0,
+    FV.TI: 0.1,
+    FV.RHO: 1.225,
+}
+
+
 def _get_profiles(coords, fields, dims, ovars, fixval, verbosity):
     """Read ABL profiles information
     :group: input.yaml.windio
@@ -22,6 +30,8 @@ def _get_profiles(coords, fields, dims, ovars, fixval, verbosity):
                 print(
                     f"Ignoring '{FV.Z0}', since no reference_height found. No ABL profile activated."
                 )
+            fields.pop(FV.Z0)
+            dims.pop(FV.Z0)
         elif FV.MOL in fields:
             ovars.append(FV.MOL)
             fixval[FV.H] = fields[FV.H]
@@ -56,7 +66,7 @@ def _get_SingleStateStates(
 
     smap = {FV.WS: "ws", FV.WD: "wd", FV.TI: "ti", FV.RHO: "rho"}
 
-    data = {smap[v]: d for v, d in fixval.items()}
+    data = {smap[v]: fixval.get(v, default_values[v]) for v in ovars}
     for v, d in coords.items():
         if v in smap:
             data[smap[v]] = d
@@ -91,7 +101,7 @@ def _get_Timeseries(
             print("        selecting class 'Timeseries'")
 
         data = {}
-        fix = {}
+        fix = {v: fixval.get(v, default_values[v]) for v in ovars if v not in fields}
         for v, d in fields.items():
             if dims[v] == (FC.TIME,):
                 data[v] = d
@@ -99,7 +109,6 @@ def _get_Timeseries(
                 fix[v] = d
             elif verbosity > 2:
                 print(f"        ignoring field '{v}' with dims {dims[v]}")
-        fix.update({v: d for v, d in fixval.items() if v not in data})
 
         sdata = pd.DataFrame(index=coords[FC.TIME], data=data)
         sdata.index.name = FC.TIME
@@ -132,7 +141,7 @@ def _get_MultiHeightNCTimeseries(
             )
 
         data = {}
-        fix = {}
+        fix = {v: fixval.get(v, default_values[v]) for v in ovars if v not in fields}
         for v, d in fields.items():
             if dims[v] == (FC.TIME, FV.H):
                 data[v] = ((FC.TIME, FV.H), d)
@@ -142,7 +151,6 @@ def _get_MultiHeightNCTimeseries(
                 fix[v] = d
             elif verbosity > 2:
                 print(f"        ignoring field '{v}' with dims {dims[v]}")
-        fix.update({v: d for v, d in fixval.items() if v not in data})
 
         sdata = Dataset(coords=coords, data_vars=data)
         states_dict.update(
@@ -153,6 +161,7 @@ def _get_MultiHeightNCTimeseries(
                 data_source=sdata,
                 output_vars=ovars,
                 fixed_vars=fix,
+                bounds_error=False,
             )
         )
         return True
@@ -177,7 +186,7 @@ def _get_WeibullSectors(
             print("        selecting class 'WeibullSectors'")
 
         data = {}
-        fix = {}
+        fix = {v: fixval.get(v, default_values[v]) for v in ovars if v not in fields}
         c = dims[FV.WEIBULL_A][0]
         for v, d in fields.items():
             if dims[v] == (c,):
@@ -186,7 +195,6 @@ def _get_WeibullSectors(
                 fix[v] = d
             elif verbosity > 2:
                 print(f"        ignoring field '{v}' with dims {dims[v]}")
-        fix.update({v: d for v, d in fixval.items() if v not in data})
 
         if FV.WD in coords:
             data[FV.WD] = coords[FV.WD]
@@ -230,13 +238,12 @@ def _get_WeibullPointCloud(
             print("        selecting class 'WeibullPointCloud'")
 
         data = {}
-        fix = {}
+        fix = {v: fixval.get(v, default_values[v]) for v in ovars if v not in fields}
         for v, d in fields.items():
             if len(dims[v]) == 0:
                 fix[v] = d
             elif v not in fixval:
                 data[v] = (dims[v], d)
-        fix.update({v: d for v, d in fixval.items() if v not in data})
 
         sdata = Dataset(
             coords=coords,
@@ -282,13 +289,12 @@ def _get_WeibullField(
             print("        selecting class 'WeibullField'")
 
         data = {}
-        fix = {}
+        fix = {v: fixval.get(v, default_values[v]) for v in ovars if v not in fields}
         for v, d in fields.items():
             if len(dims[v]) == 0:
                 fix[v] = d
             elif v not in fixval:
                 data[v] = (dims[v], d)
-        fix.update({v: d for v, d in fixval.items() if v not in data})
 
         sdata = Dataset(
             coords=coords,
@@ -342,7 +348,7 @@ def get_states(coords, fields, dims, verbosity=1):
         print("      Creating states")
 
     ovars = [FV.WS, FV.WD, FV.TI, FV.RHO]
-    fixval = {FV.RHO: 1.225}
+    fixval = {}
     profiles = _get_profiles(coords, fields, dims, ovars, fixval, verbosity)
 
     states_dict = {}
@@ -421,6 +427,21 @@ def read_site(wio_dict, verbosity=1):
     dims = Dict(_name="dims")
     for n, d in wind_resource.items():
         read_wind_resource_field(n, d, coords, fields, dims, verbosity)
+
+    # special case: operating field
+    if FV.OPERATING in fields:
+        wio_dict["wind_farm"][FV.OPERATING] = (
+            dims.pop(FV.OPERATING),
+            fields.pop(FV.OPERATING),
+        )
+        if FC.TURBINE in coords:
+            if not any([FC.TURBINE in dms for dms in dims.values()]):
+                if verbosity > 2:
+                    print(
+                        f"      Removing coordinate '{FC.TURBINE}', since only relevant for operating flag"
+                    )
+                coords.pop(FC.TURBINE)
+
     if verbosity > 2:
         print("      Coords:")
         for c, d in coords.items():

foxes/input/yaml/windio/windio.py

@@ -55,6 +55,7 @@ def read_windio(wio_dict, verbosity=1):
         algorithm=Dict(
             algo_type="Downwind",
             wake_models=[],
+            farm_controller="farm_cntrl",
             _name="wio2fxs.algorithm",
             verbosity=verbosity - 3,
         ),

foxes/models/farm_controllers/__init__.py

@@ -3,3 +3,4 @@ Farm controller models.
 """
 
 from .basic import BasicFarmController as BasicFarmController
+from .op_flag import OpFlagController as OpFlagController

foxes/models/farm_controllers/op_flag.py

@@ -0,0 +1,196 @@
+import numpy as np
+from xarray import open_dataset, Dataset
+
+from foxes.core import FarmController
+import foxes.constants as FC
+import foxes.variables as FV
+
+
+class OpFlagController(FarmController):
+    """
+    A basic controller with a flag for
+    turbine operation at each state.
+
+    Parameters
+    ----------
+    non_op_values: dict
+        The non-operational values for variables,
+        keys: variable str, values: float
+    var2ncvar: dict
+        The mapping of variable names to NetCDF variable names,
+        only needed if data_source is a path to a NetCDF file
+
+    :group: models.farm_controllers
+
+    """
+
+    def __init__(
+        self,
+        data_source,
+        non_op_values=None,
+        var2ncvar={},
+        **kwargs,
+    ):
+        """
+        Constructor.
+
+        Parameters
+        ----------
+        data_source: numpy.ndarray or str
+            The operating flag data, shape: (n_states, n_turbines),
+            or path to a NetCDF file
+        non_op_values: dict, optional
+            The non-operational values for variables,
+            keys: variable str, values: float
+        var2ncvar: dict
+            The mapping of variable names to NetCDF variable names,
+            only needed if data_source is a path to a NetCDF file
+        kwargs: dict, optional
+            Additional keyword arguments for the
+            base class constructor
+
+        """
+        super().__init__(**kwargs)
+        self.data_source = data_source
+        self.var2ncvar = var2ncvar
+
+        self.non_op_values = {
+            FV.P: 0.0,
+            FV.CT: 0.0,
+        }
+        if non_op_values is not None:
+            self.non_op_values.update(non_op_values)
+
+        self._op_flags = None
+
+    def output_farm_vars(self, algo):
+        """
+        The variables which are being modified by the model.
+
+        Parameters
+        ----------
+        algo: foxes.core.Algorithm
+            The calculation algorithm
+
+        Returns
+        -------
+        output_vars: list of str
+            The output variable names
+
+        """
+        vrs = set(super().output_farm_vars(algo))
+        vrs.update([FV.OPERATING])
+        return list(vrs)
+
+    def load_data(self, algo, verbosity=0):
+        """
+        Load and/or create all model data that is subject to chunking.
+
+        Such data should not be stored under self, for memory reasons. The
+        data returned here will automatically be chunked and then provided
+        as part of the mdata object during calculations.
+
+        Parameters
+        ----------
+        algo: foxes.core.Algorithm
+            The calculation algorithm
+        verbosity: int
+            The verbosity level, 0 = silent
+
+        Returns
+        -------
+        idata: dict
+            The dict has exactly two entries: `data_vars`,
+            a dict with entries `name_str -> (dim_tuple, data_ndarray)`;
+            and `coords`, a dict with entries `dim_name_str -> dim_array`
+
+        """
+
+        idata = super().load_data(algo, verbosity)
+
+        if isinstance(self.data_source, np.ndarray):
+            self._op_flags = self.data_source
+
+        elif isinstance(self.data_source, Dataset):
+            cop = self.var2ncvar.get(FV.OPERATING, FV.OPERATING)
+            self._op_flags = self.data_source[cop].to_numpy()
+
+        else:
+            if verbosity > 0:
+                print(f"OpFlagController: Reading data from {self.data_source}")
+            ds = open_dataset(self.data_source)
+            cop = self.var2ncvar.get(FV.OPERATING, FV.OPERATING)
+            self._op_flags = ds[cop].to_numpy()
+            del ds
+
+        assert self._op_flags.shape == (algo.n_states, algo.n_turbines), (
+            f"OpFlagController data shape {self._op_flags.shape} does not match "
+            f"(n_states, n_turbines)=({algo.n_states}, {algo.n_turbines})"
+        )
+        op_flags = self._op_flags.astype(bool)
+
+        off = np.where(~op_flags)
+        tmsels = idata["data_vars"][FC.TMODEL_SELS][1]
+        tmsels[off[0], off[1], :] = False
+        self._tmall = [np.all(t) for t in tmsels]
+
+        idata["data_vars"][FC.TMODEL_SELS] = (
+            (FC.STATE, FC.TURBINE, FC.TMODELS),
+            tmsels,
+        )
+        idata["data_vars"][FV.OPERATING] = (
+            (FC.STATE, FC.TURBINE),
+            op_flags,
+        )
+
+        return idata
+
+    def calculate(self, algo, mdata, fdata, pre_rotor, downwind_index=None):
+        """
+        The main model calculation.
+
+        This function is executed on a single chunk of data,
+        all computations should be based on numpy arrays.
+
+        Parameters
+        ----------
+        algo: foxes.core.Algorithm
+            The calculation algorithm
+        mdata: foxes.core.MData
+            The model data
+        fdata: foxes.core.FData
+            The farm data
+        pre_rotor: bool
+            Flag for running pre-rotor or post-rotor
+            models
+        downwind_index: int, optional
+            The index in the downwind order
+
+        Returns
+        -------
+        results: dict
+            The resulting data, keys: output variable str.
+            Values: numpy.ndarray with shape (n_states, n_turbines)
+
+        """
+        self.ensure_output_vars(algo, fdata)
+
+        # compute data for all operating turbines:
+        op = mdata[FV.OPERATING].astype(bool)
+        fdata[FV.OPERATING] = op
+        results = super().calculate(algo, mdata, fdata, pre_rotor, downwind_index)
+        results[FV.OPERATING] = fdata[FV.OPERATING]
+
+        # set non-operating values:
+        if downwind_index is None:
+            off = np.where(~op)
+            for v in self.output_farm_vars(algo):
+                if v != FV.OPERATING:
+                    fdata[v][off[0], off[1]] = self.non_op_values.get(v, np.nan)
+        else:
+            off = np.where(~op[:, downwind_index])
+            for v in self.output_farm_vars(algo):
+                if v != FV.OPERATING:
+                    fdata[v][off[0], downwind_index] = self.non_op_values.get(v, np.nan)
+
+        return results

foxes/models/wake_models/induction/self_similar.py

@@ -27,6 +27,12 @@ class SelfSimilar(TurbineInductionModel):
 
     Attributes
     ----------
+    alpha: float
+        The alpha parameter
+    beta: float
+        The beta parameter
+    gamma: float
+        The gamma parameter
     pre_rotor_only: bool
         Calculate only the pre-rotor region
     induction: foxes.core.AxialInductionModel or str
@@ -40,6 +46,8 @@ class SelfSimilar(TurbineInductionModel):
         self,
         superposition="ws_linear",
         induction="Madsen",
+        alpha=8 / 9,
+        beta=np.sqrt(2),
         gamma=1.1,
         pre_rotor_only=False,
     ):
@@ -52,8 +60,12 @@ class SelfSimilar(TurbineInductionModel):
             The wind speed superposition.
         induction: foxes.core.AxialInductionModel or str
             The induction model
-        gamma: float, default=1.1
-            The parameter that multiplies Ct in the ct2a calculation
+        alpha: float
+            The alpha parameter
+        beta: float
+            The beta parameter
+        gamma: float
+            The gamma parameter
         pre_rotor_only: bool
             Calculate only the pre-rotor region
 
@@ -61,6 +73,8 @@ class SelfSimilar(TurbineInductionModel):
         super().__init__(wind_superposition=superposition)
         self.induction = induction
         self.pre_rotor_only = pre_rotor_only
+        self.alpha = alpha
+        self.beta = beta
         self.gamma = gamma
 
     def __repr__(self):
@@ -163,9 +177,13 @@ class SelfSimilar(TurbineInductionModel):
         """Helper function: using eqn 13 from [2]"""
         return np.sqrt(0.587 * (1.32 + x_R**2))
 
-    def _rad_fn(self, x_R, r_R, beta=np.sqrt(2), alpha=8 / 9):
+    def _rad_fn(self, x_R, r_R):
         """Helper function: define radial shape function (eqn 12 from [1])"""
-        return (1 / np.cosh(beta * (r_R) / self._r_half(x_R))) ** alpha  # * (x_R < 0)
+        with np.errstate(over="ignore"):
+            result = (
+                1 / np.cosh(self.beta * (r_R) / self._r_half(x_R))
+            ) ** self.alpha  # * (x_R < 0)
+        return result
 
     def contribute(
         self,

foxes/models/wake_models/induction/self_similar2020.py

@@ -25,7 +25,7 @@ class SelfSimilar2020(SelfSimilar):
 
     """
 
-    def _a0(self, ct, x_R, gamma=1.1):
+    def _a0(self, ct, x_R):
         """Helper function: define a0 with gamma factor, eqn 8 from [2]"""
 
         x_new = np.minimum(np.maximum(-1 * np.abs(x_R), -6), -1)

foxes/models/wake_models/ti/crespo_hernandez.py

@@ -218,7 +218,7 @@ class CrespoHernandezTIWake(TopHatWakeModel):
 
         # calculate:
         a = self.induction.ct2a(ct)
-        beta = (1 - a) / (1 - 2 * a)
+        beta = np.maximum((1 - a) / (1 - 2 * a), 0)
         radius = 2 * (k * x + self.sbeta_factor * np.sqrt(beta) * D)
 
         return radius

foxes/models/wake_models/wind/bastankhah14.py

@@ -194,7 +194,7 @@ class Bastankhah2014(GaussianWakeModel):
             # calculate sigma:
             # beta = 0.5 * (1 + np.sqrt(1.0 - ct)) / np.sqrt(1.0 - ct)
             a = self.induction.ct2a(ct)
-            beta = (1 - a) / (1 - 2 * a)
+            beta = np.maximum((1 - a) / (1 - 2 * a), 0)
             sigma = k * x + self.sbeta_factor * np.sqrt(beta) * D
             del beta, a
 

foxes/models/wake_models/wind/bastankhah16.py

@@ -423,7 +423,7 @@ class Bastankhah2016(DistSlicedWakeModel):
         self,
         superposition,
         alpha=0.58,
-        beta=0.07,
+        beta=0.077,
         induction="Madsen",
         **wake_k,
     ):

foxes/models/wake_models/wind/turbopark.py

@@ -220,7 +220,7 @@ class TurbOParkWake(GaussianWakeModel):
             # calculate sigma:
             # beta = np.sqrt(0.5 * (1 + np.sqrt(1.0 - ct)) / np.sqrt(1.0 - ct))
             a = self.induction.ct2a(ct)
-            beta = (1 - a) / (1 - 2 * a)
+            beta = np.maximum((1 - a) / (1 - 2 * a), 0)
             epsilon = self.sbeta_factor * np.sqrt(beta)
             del a, beta
 

foxes/output/state_turbine_map.py

@@ -39,6 +39,7 @@ class StateTurbineMap(Output):
         self,
         variable,
         title=None,
+        cbar_label=None,
         ax=None,
         figsize=None,
         rotate_xlabels=None,
@@ -93,8 +94,11 @@ class StateTurbineMap(Output):
 
         ax.set_yticks(turbines[:-1] + 0.5)
         ax.set_yticklabels(turbines[:-1])
-        xt = ax.get_xticks()
+        xt = np.asarray(ax.get_xticks())
         xtl = ax.get_xticklabels()
+        if xt.dtype != np.datetime64:
+            xt, ar = np.unique(xt.astype(int), return_index=True)
+            xtl = [int(float(xtl[i].get_text())) for i in ar]
         ax.set_xticks(
             xt[:-1] + 0.5 * (xt[-1] - xt[-2]), xtl[:-1], rotation=rotate_xlabels
         )
@@ -103,10 +107,9 @@ class StateTurbineMap(Output):
             ytl = [None for t in yt]
             ytl[::5] = ax.get_yticklabels()[::5]
             ax.set_yticks(yt, ytl)
-        fig.colorbar(c, ax=ax)
+        fig.colorbar(c, ax=ax, label=cbar_label)
 
-        t = title if title is not None else variable
-        ax.set_title(t)
+        ax.set_title(title)
         ax.set_ylabel("Turbine index")
         ax.set_xlabel("State")
 

foxes/variables.py

@@ -1,3 +1,8 @@
+OPERATING = "operating"
+""" Flag for turbine operation
+:group: foxes.variables
+"""
+
 X = "X"
 """ The x coordinate in m
 :group: foxes.variables
@@ -19,7 +24,7 @@ D = "D"
 """
 
 TXYH = "txyh"
-""" The turbine rotor centre coordinate 
+""" The turbine rotor centre coordinate
 vector (x, y, height)
 :group: foxes.variables
 """
@@ -190,13 +195,13 @@ AMB_RHO = "AMB_RHO"
 """
 
 AMB_YAW = "AMB_YAW"
-""" The ambient absolute yaw angle of 
+""" The ambient absolute yaw angle of
 a turbine in degrees
 :group: foxes.variables
 """
 
 AMB_YAWM = "AMB_YAWM"
-""" The ambient relative yaw angle of 
+""" The ambient relative yaw angle of
 a turbine in degrees
 :group: foxes.variables
 """

{foxes-1.5.1.dist-info → foxes-1.5.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: foxes
-Version: 1.5.1
+Version: 1.5.2
 Summary: Farm Optimization and eXtended yield Evaluation Software
 Author: Jonas Schulte
 Maintainer: Jonas Schulte
@@ -47,17 +47,16 @@ Classifier: Development Status :: 4 - Beta
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-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
+Requires-Dist: h5netcdf>=1.0
+Requires-Dist: pyyaml>=4.0
+Requires-Dist: tqdm>=2.0
 Provides-Extra: opt
-Requires-Dist: foxes-opt>=0.5; extra == "opt"
+Requires-Dist: foxes-opt>=0.6; extra == "opt"
 Provides-Extra: dask
 Requires-Dist: dask>=2022.0; extra == "dask"
 Requires-Dist: distributed>=2022.0; extra == "dask"

{foxes-1.5.1.dist-info → foxes-1.5.2.dist-info}/RECORD

@@ -23,7 +23,7 @@ examples/wind_rose/run.py,sha256=CU7pzOSlWHifFvdtKl_t9gufaAKw2TkjwvklDZRaawM,438
 examples/yawed_wake/run.py,sha256=X-cxmhC0rCRHyB00kXrsnqQ9fufSY7L35lozls7Nxuw,6882
 foxes/__init__.py,sha256=1RPU7w3WJ3jFb2aJdZKRy-6Fje9qAaH85WYcOCiDvwk,1375
 foxes/constants.py,sha256=jQcyeU53V629Tf8qQWc2F4Xw1rV3ywtJiT-g1JWenNg,3842
-foxes/variables.py,sha256=sK58u3HJRsWo-fbE7GPlQUhF0YUhY-qSg6Vl8Pv1Eo8,6144
+foxes/variables.py,sha256=7B5wFWUunrFZLjU2l2cgYZ5nyZmakOLR1gqh-G3BTuI,6225
 foxes/algorithms/__init__.py,sha256=L0VyK-B81zXr-IFI6NMhJ7Px9XVhlkmX0M0IrKhcf0o,327
 foxes/algorithms/downwind/__init__.py,sha256=tdTnMEVLi58EMkqStollQb4gPug4x8Te2K8ddAxkas8,75
 foxes/algorithms/downwind/downwind.py,sha256=Rqpe-BYWVt8eS1HxsRYFO93SgblVxmuTKFI1sSFzhXQ,26215
@@ -135,19 +135,20 @@ foxes/input/yaml/__init__.py,sha256=XGCJlbE1SwavEWEKDRAuJwqAi9Afm_qwPnQLxPKjzP4,
 foxes/input/yaml/dict.py,sha256=0hRqpF0Gn3FknS-xldyzzhKTTpYlv8GTqUBsLIFjolU,14921
 foxes/input/yaml/yaml.py,sha256=0hikKGhkjipYANJNeXgNZ8xzVj-mMscmsA26w_6HdgE,2741
 foxes/input/yaml/windio/__init__.py,sha256=HXJEBEDd1FbATkDfjXzA3sgo9detUxgvekmC32QOc5E,446
-foxes/input/yaml/windio/read_attributes.py,sha256=wibXcIGSY6iTMIyMQ9w6_RNaj3dDH7khd3LI-jsGW40,13017
-foxes/input/yaml/windio/read_farm.py,sha256=F2s27Z4yCvPaQsTlNbOtZiDzSwRmOBnMnhfNj4tW4nk,7428
-foxes/input/yaml/windio/read_fields.py,sha256=lWMm5GQ6AcnQ_bQPHpIDpClya6yQd9GdpR0qrImGyIs,4738
-foxes/input/yaml/windio/read_outputs.py,sha256=iwxZ-9VKlo2r_aH8D-bkJNGV9p1hRAjP5G6BFCA4MVw,7963
-foxes/input/yaml/windio/read_site.py,sha256=KVRTr92mNqmsxgHx2XkPIqHVV91WiEzaqvub5uils0A,13124
-foxes/input/yaml/windio/windio.py,sha256=IjspxFNBHwbCJ8vSOU3OcOpjVm9vwKTExVA0dQj9Rqo,5617
+foxes/input/yaml/windio/read_attributes.py,sha256=T4FLMGVgWWK4cyNnq0H8x7TX_pbeUv-X4NEmCC-0IBs,13252
+foxes/input/yaml/windio/read_farm.py,sha256=TraS7AYIbu8BVj9ml8dj9yWN9dCZ_VoHrrFkmWWaU28,8247
+foxes/input/yaml/windio/read_fields.py,sha256=pgMMkXaZ8BXzTIyNqgFxJCR_QvO7rn5xEEP77NjD17k,4818
+foxes/input/yaml/windio/read_outputs.py,sha256=IbD5_0PLMy6Dl1-oyCDoY4S6fetD7j03iUZG2cIJ7yY,8678
+foxes/input/yaml/windio/read_site.py,sha256=csmhoe46b3nUecMR9Nuc5vifAvOHB2g3SyR8MvFHzp8,13840
+foxes/input/yaml/windio/windio.py,sha256=mcznjZCwUpX06ADMvhp-kQMeBZG4pP7ooILb6-UH5_A,5659
 foxes/models/__init__.py,sha256=-wXjx9PkxWT2Koq4tmtCuasnlb8RIeLVWP7iSYPQ1Fc,727
 foxes/models/model_book.py,sha256=A9lCg-cQtGVQ2dpIGzcEJGHdyktUdpzqyqHrybUMRvo,30065
 foxes/models/axial_induction/__init__.py,sha256=QJN1RLxIt1EhQXIDVLjPSZ1zIoaS6YjK9VDdgw7NwsA,124
 foxes/models/axial_induction/betz.py,sha256=rAaq7pnu-FmfYh61BU5Af1h4_bG2AAimP4Qah1aZo88,894
 foxes/models/axial_induction/madsen.py,sha256=_-ycfh8SnIpCKWm1uwx5VH7f49FQvR0y1Nbb_U8xWyU,1403
-foxes/models/farm_controllers/__init__.py,sha256=0HEGiWEsrKjm8Opf890DzVHwTptSlTSgeo5QJMx9gnw,95
+foxes/models/farm_controllers/__init__.py,sha256=9c9vvgfUAvOG1I_5Bp58zJPC1mvUFuSQCDbRAUFTj4c,153
 foxes/models/farm_controllers/basic.py,sha256=6pinNXiyfoG3apXhqQWcnxx4vN_7Q63YryXX5Z7kTE0,249
+foxes/models/farm_controllers/op_flag.py,sha256=EEtPejZ5majpDiPO_8Y5Z6b2deNpj1PyOX7wsl56Shk,6021
 foxes/models/farm_models/__init__.py,sha256=8qV0dQ2N3HJpbOolhLtBs0LMdC8hctxy8J-OiqcSvKo,87
 foxes/models/farm_models/turbine2farm.py,sha256=LuK-qAy4aVXBqFCM4-1qogwAA4qfHsjYRFsrZy_OUro,2276
 foxes/models/ground_models/__init__.py,sha256=r_MuSulOGQ1SnrojfpwU9kky7tZhPtCwXbXIVvGdrkg,148
@@ -220,17 +221,17 @@ foxes/models/wake_models/top_hat.py,sha256=APZf6r26jfi2rP_rrmk4qXs1NGlzc1hsFxrj6
 foxes/models/wake_models/induction/__init__.py,sha256=xw5LiTh2YWRRNF8cyYACQc-735C23NarCMHWiHQ_5-8,311
 foxes/models/wake_models/induction/rankine_half_body.py,sha256=1NaV5eqcsxjlQwCSUDC-w3wO_SGgh4ykEYvNJX8ToBk,6427
 foxes/models/wake_models/induction/rathmann.py,sha256=ZPF16PESm1wWA7SL7sNbj_XPb4rAGGcmfBrby8VoU3o,7964
-foxes/models/wake_models/induction/self_similar.py,sha256=v3bQjX-RAYwJ-WbZfOpAVb-7Wbq8HXgsgqenP6Jel40,8505
-foxes/models/wake_models/induction/self_similar2020.py,sha256=kteNnjRG4SptcYiW3avBgiDjmX3NMefTB2G2rpb-Hjs,1527
+foxes/models/wake_models/induction/self_similar.py,sha256=WO5NStvfAy2xT-i4zW63ncyn-NH4_fNPAzv--nQjJvA,8869
+foxes/models/wake_models/induction/self_similar2020.py,sha256=FETB7iiS1av0ymb8w3sgYLRCK3jz0lVXAMgGZ6MXljg,1516
 foxes/models/wake_models/induction/vortex_sheet.py,sha256=Iy3QX_2lUA7MiEEYKFeRh7jz9s7KpyyS7qBLhfCEsAo,7197
 foxes/models/wake_models/ti/__init__.py,sha256=0ZKF4sHbtU3QCRzC1Ff0vnVymbdby7s12Qcy3PnBgKU,163
-foxes/models/wake_models/ti/crespo_hernandez.py,sha256=UVxeDbxPu7beKNm5b8jwvgOdqJFGUQxG9Wybwfwy5p8,8990
+foxes/models/wake_models/ti/crespo_hernandez.py,sha256=Or1uf0t8GjtQePyiczSIf4Dmb8tl4AMqdV9TqWFQNbE,9005
 foxes/models/wake_models/ti/iec_ti.py,sha256=P9SUNaxf9UdA_rufuJcmpgLXM1Fj1FRhFHU4DNxYFa4,7064
 foxes/models/wake_models/wind/__init__.py,sha256=QOCeb8E7TYuwkX5jhgPUST1kGmv9c59qvclLhtUeLnQ,379
-foxes/models/wake_models/wind/bastankhah14.py,sha256=zMhlZq9YMTMje-zbbx4BKHl9DwZK_e0SoODlNuVumvo,5567
-foxes/models/wake_models/wind/bastankhah16.py,sha256=6yBMInYi0Zg3Ly6x2gU9GbjTho6lmfQ1CkGd4uXIFgg,18742
+foxes/models/wake_models/wind/bastankhah14.py,sha256=0NxM4QO1CtaY7dim2Xc7CXK3uMMWCMkhuOd3Wnb75RU,5582
+foxes/models/wake_models/wind/bastankhah16.py,sha256=FuBQi9Q01f6gIK0_S5aO6QpCPJvyFzqH8wV44q1eTIw,18743
 foxes/models/wake_models/wind/jensen.py,sha256=rGEtBgTtT1z3_sGVHkAlqSP4sSErD2yQu-lDwqfykIw,4493
-foxes/models/wake_models/wind/turbopark.py,sha256=Vu69CeFnWfGfSlLRp0p4M7GCYezEUFt12ia_elCm7fg,15222
+foxes/models/wake_models/wind/turbopark.py,sha256=w0ZXloSgjsbk32JuivrmVF4WbVv0TNE3KiU9UC07Y4c,15237
 foxes/models/wake_superpositions/__init__.py,sha256=fMrBOoBGSa45xbc2E1Jdgjfkm2ahKBKgPeBVq8s9uH0,690
 foxes/models/wake_superpositions/ti_linear.py,sha256=Cqteww87M94ZDIrSoAoXSouCcH-Auj0u8NSD6JCv9Lw,3895
 foxes/models/wake_superpositions/ti_max.py,sha256=s2NYnqMIk-Bj6-SAUyhBX0WWEye5yu4hRoe5dGcLEAw,3920
@@ -255,7 +256,7 @@ foxes/output/rose_plot.py,sha256=bHd9LrGCsE39zUxmiaRk8Z3r2m3csWqSUTS-3H-vdnk,188
 foxes/output/rotor_point_plots.py,sha256=J2gfwDZVBrQIgCk6RJuj0Jq1UA1cmyh7k8VC2TfV6xw,3324
 foxes/output/slice_data.py,sha256=bnY8D0ITFFN-i1mSkm0e2ukIMqxjev2KaUINbxo62pA,33788
 foxes/output/slices_data.py,sha256=FqulnXnZ5aI2fOns4ffBYSw5j42IEGq-lLCNJxWG5HA,8671
-foxes/output/state_turbine_map.py,sha256=LY-fhGws2LC0b-Tgkh76g9gKzEtNBOUWYkVEZ_lV9dI,2772
+foxes/output/state_turbine_map.py,sha256=tBHDbAqxEqanVYRJhPlpvIV6FslZGG0VYEfRzEfh5AI,2944
 foxes/output/state_turbine_table.py,sha256=ldG0LcC126YsXQZtJY9OSWxW3ETbHdBehjtU21caTDw,2228
 foxes/output/turbine_type_curves.py,sha256=fvODho-HmH8hIrv0iQ6BXqtQ4Hz0jomnOTK-kV7vfBQ,5724
 foxes/output/flow_plots_2d/__init__.py,sha256=5pFJqvSuZKkm1TkN3d7won0mPLvr9MUg9m0TMlOqbec,91
@@ -295,7 +296,7 @@ foxes/utils/geom2d/example_intersection.py,sha256=4e6sjpZEk_bNc462YvwKPzwxdV1B90
 foxes/utils/geom2d/example_union.py,sha256=BKfLt1mtQcSto-qExeMQkq8tQ6kfFXVJ93Cc7DhOal8,1750
 foxes/utils/geom2d/half_plane.py,sha256=kzZD6pkZxZ03MK9WAboWzXb5Ws5dWLQY9GIahD4D9mA,6167
 foxes/utils/geom2d/polygon.py,sha256=Xj7triA5Pe4-48sNSAvGxEXlQGptV161LUpKKCf3YOY,5535
-foxes-1.5.1.dist-info/licenses/LICENSE,sha256=bBCH6mYTPzSepk2s2UUZ3II_ZYXrn1bnSqB85-aZHxU,1071
+foxes-1.5.2.dist-info/licenses/LICENSE,sha256=bBCH6mYTPzSepk2s2UUZ3II_ZYXrn1bnSqB85-aZHxU,1071
 tests/0_consistency/iterative/test_iterative.py,sha256=lzagmJ1y241l6Szw4Cu80S8S1ATHIyD7ukr1vVBrusY,2637
 tests/0_consistency/partial_wakes/test_partial_wakes.py,sha256=7rdg2lcUYUzxwCdGhue7A4QYCJQGrOO4E0bytgatYj4,2584
 tests/1_verification/flappy_0_6/PCt_files/test_PCt_files.py,sha256=8tIqifsykvxMCd9eD-mZWxRwT56sKjIxrGf3hf8aCFA,2530
@@ -320,9 +321,10 @@ tests/1_verification/flappy_0_6_2/row_Bastankhah_Crespo/test_row_Bastankhah_Cres
 tests/1_verification/flappy_0_6_2/row_Bastankhah_Crespo/flappy/run.py,sha256=nwIyn20ZyYHhCKcPCnm02zjwNKMRzr9t0U8TjKK61QU,2213
 tests/1_verification/flappy_0_6_2/row_Bastankhah_linear_centre/test_row_Bastankhah_linear_centre.py,sha256=QUULW3AJJq8zvUIdIQHkXiNZpaysVYIALh5HOJ6-428,2595
 tests/1_verification/flappy_0_6_2/row_Bastankhah_linear_centre/flappy/run.py,sha256=1paRjCe71AIM8igK4_f0FFH1xiIETvuBwnZAATiwWUU,2102
+tests/2_models/turbine_models/test_set_farm_vars.py,sha256=_y-lVYsL9jByh_34c08Qu4GgYxW8s-E2HsSyX7ptfnY,1680
 tests/3_examples/test_examples.py,sha256=9_PtvlYA6ELsQGHt-xAnsjCYdGj1ekX237ymWvEJaCk,732
-foxes-1.5.1.dist-info/METADATA,sha256=zRir9XRuTKME-eYx3K7yLKrD9wqWTah5-PTPWIKvEjw,8123
-foxes-1.5.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-foxes-1.5.1.dist-info/entry_points.txt,sha256=KuS44FRH5NnMw201A8Btr76eNRKr2UOoKHjejAsqKwE,123
-foxes-1.5.1.dist-info/top_level.txt,sha256=G7oHApEz5nc-iP__XsPcvjYe_NyXGmKMUMPHi3C3x6I,26
-foxes-1.5.1.dist-info/RECORD,,
+foxes-1.5.2.dist-info/METADATA,sha256=yJDpMwsBVrfk6vpMRDi85OFO89RTham8VVQk1-Bre7Y,8095
+foxes-1.5.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+foxes-1.5.2.dist-info/entry_points.txt,sha256=KuS44FRH5NnMw201A8Btr76eNRKr2UOoKHjejAsqKwE,123
+foxes-1.5.2.dist-info/top_level.txt,sha256=G7oHApEz5nc-iP__XsPcvjYe_NyXGmKMUMPHi3C3x6I,26
+foxes-1.5.2.dist-info/RECORD,,

tests/2_models/turbine_models/test_set_farm_vars.py

@@ -0,0 +1,64 @@
+import numpy as np
+
+import foxes
+import foxes.variables as FV
+import foxes.constants as FC
+
+
+def test_set_farm_vars():
+    n_s = 360
+    n_tr = 3
+
+    wd = np.arange(0.0, 360.0, 360 / n_s)
+    states = foxes.input.states.ScanStates(
+        scans={
+            FV.WD: wd,
+            FV.WS: [9.0],
+            FV.TI: [0.04],
+            FV.RHO: [1.225],
+        },
+    )
+
+    n_t = n_tr**2
+    x = np.zeros((n_s, n_t), dtype=foxes.config.dtype_double)
+    x[:] = wd[:, None] + np.arange(n_t)[None, :] / 10
+
+    farm = foxes.WindFarm()
+    foxes.input.farm_layout.add_grid(
+        farm,
+        xy_base=[0.0, 0.0],
+        step_vectors=[[800.0, 0.0], [0.0, 800.0]],
+        steps=[n_tr, n_tr],
+        turbine_models=["NREL5MW", "set_x"],
+        verbosity=0,
+    )
+
+    with foxes.Engine.new("default", verbosity=0):
+        for pr in [False, True]:
+            print(f"\npre_rotor = {pr}\n")
+
+            mbook = foxes.ModelBook()
+            mbook.turbine_models["set_x"] = foxes.models.turbine_models.SetFarmVars(
+                pre_rotor=pr
+            )
+            mbook.turbine_models["set_x"].add_var("x", x)
+
+            algo = foxes.algorithms.Downwind(
+                farm=farm,
+                states=states,
+                wake_models=["Bastankhah2014_linear_lim_k004"],
+                mbook=mbook,
+                verbosity=0,
+            )
+
+            farm_results = algo.calc_farm()
+
+            fr = farm_results.to_dataframe()
+            print(fr[[FV.WD, "x"]])
+
+            for i, g in fr.reset_index().groupby(FC.TURBINE):
+                assert np.allclose(g["x"].values, g[FV.WD].values + i / 10)
+
+
+if __name__ == "__main__":
+    test_set_farm_vars()