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

foxes/models/turbine_types/calculator_type.py

@@ -0,0 +1,123 @@
+from foxes.core import TurbineType
+
+
+class CalculatorType(TurbineType):
+    """
+    Direct data infusion by a user function.
+
+    :group: models.turbine_types
+
+    """
+
+    def __init__(
+        self,
+        func,
+        out_vars,
+        *args,
+        needs_rews2=False,
+        needs_rews3=False,
+        **kwargs,
+    ):
+        """
+        Constructor.
+
+        Parameters
+        ----------
+        func: callable
+            The function to calculate farm variables, should have the signature:
+            f(algo, mdata, fdata, st_sel) -> dict, where the keys are
+            output variable names and the values are numpy.ndarrays
+            with shape (n_states, n_turbines).
+
+            Beware that the turbine ordering in fdata is in downwind order,
+            hence external data X of shape (n_states, n_turbines) in farm order
+            needs to be reordered by X[ssel, order] with
+            ssel = fdata[FV.ORDER_SSEL], order = fdata[FV.ORDER]
+            before using it in combination with fdata variables.
+        out_vars: list of str
+            The output variables of the function
+        args: tuple, optional
+            Additional parameters for TurbineType class
+        needs_rews2: bool
+            Flag for runs that require the REWS2 variable
+        needs_rews3: bool
+            Flag for runs that require the REWS3 variable
+        kwargs: dict, optional
+            Additional parameters for TurbineType class
+
+        """
+        super().__init__(*args, **kwargs)
+        self._func = func
+        self._ovars = out_vars
+        self._rews2 = needs_rews2
+        self._rews3 = needs_rews3
+
+    def needs_rews2(self):
+        """
+        Returns flag for requiring REWS2 variable
+
+        Returns
+        -------
+        flag: bool
+            True if REWS2 is required
+
+        """
+        return self._rews2
+
+    def needs_rews3(self):
+        """
+        Returns flag for requiring REWS3 variable
+
+        Returns
+        -------
+        flag: bool
+            True if REWS3 is required
+
+        """
+        return self._rews3
+
+    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
+
+        """
+        return self._ovars
+
+    def calculate(self, algo, mdata, fdata, st_sel):
+        """
+        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
+        st_sel: numpy.ndarray of bool
+            The state-turbine selection,
+            shape: (n_states, n_turbines)
+
+        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)
+        return self._func(algo, mdata, fdata, st_sel)

foxes/models/turbine_types/null_type.py

@@ -102,4 +102,5 @@ class NullType(TurbineType):
             Values: numpy.ndarray with shape (n_states, n_turbines)
 
         """
+        self.ensure_output_vars(algo, fdata)
         return {}

foxes/models/turbine_types/wsrho2PCt_from_two.py

@@ -262,6 +262,8 @@ class WsRho2PCtFromTwo(TurbineType):
             Values: numpy.ndarray with shape (n_states, n_turbines)
 
         """
+        # prepare:
+        self.ensure_output_vars(algo, fdata)
 
         # calculate P:
         st_sel_P = (

foxes/models/turbine_types/wsti2PCt_from_two.py

@@ -5,8 +5,8 @@ from scipy.interpolate import interpn
 from foxes.core import TurbineType
 from foxes.utils import PandasFileHelper
 from foxes.data import PCTCURVE, parse_Pct_two_files
-import foxes.variables as FV
 from foxes.config import config, get_input_path
+import foxes.variables as FV
 
 
 class WsTI2PCtFromTwo(TurbineType):
@@ -274,6 +274,8 @@ class WsTI2PCtFromTwo(TurbineType):
             Values: numpy.ndarray with shape (n_states, n_turbines)
 
         """
+        # prepare:
+        self.ensure_output_vars(algo, fdata)
 
         # calculate P:
         st_sel_P = (

foxes/output/farm_layout.py

@@ -186,6 +186,8 @@ class FarmLayoutOutput(Output):
             The image object
 
         """
+        if self.nofig:
+            return None, None
 
         if fig is None:
             fig = plt.figure(figsize=figsize)

foxes/output/farm_results_eval.py

@@ -25,7 +25,7 @@ class FarmResultsEval(Output):
 
     """
 
-    def __init__(self, farm_results):
+    def __init__(self, farm_results, **kwargs):
         """
         Constructor.
 
@@ -33,8 +33,11 @@ class FarmResultsEval(Output):
         ----------
         farm_results: xarray.Dataset
             The farm results
+        kwargs: dict, optional
+            Additional parameters for the base class
 
         """
+        super().__init__(**kwargs)
         self.results = farm_results
 
     def weinsum(self, rhs, *vars):

foxes/output/flow_plots_2d/flow_plots.py

@@ -96,6 +96,9 @@ class FlowPlots2D(SliceData):
             The image data, shape: (n_x, n_y)
 
         """
+        if self.nofig:
+            return None
+
         variables = list(set([var] + [FV.WD, FV.WS]))
         vi = variables.index(var)
         wdi = variables.index(FV.WD)
@@ -245,6 +248,9 @@ class FlowPlots2D(SliceData):
             The image data, shape: (n_x, n_y)
 
         """
+        if self.nofig:
+            return None
+
         variables = list(set([var] + [FV.WD, FV.WS]))
         vi = variables.index(var)
         wdi = variables.index(FV.WD)
@@ -395,6 +401,9 @@ class FlowPlots2D(SliceData):
             The image data, shape: (n_x, n_y)
 
         """
+        if self.nofig:
+            return None
+
         variables = list(set([var] + [FV.WD, FV.WS]))
         vi = variables.index(var)
         wdi = variables.index(FV.WD)
@@ -547,6 +556,9 @@ class FlowPlots2D(SliceData):
             or matplotlib.QuadContourSet
 
         """
+        if self.nofig:
+            yield None
+
         variables = list(set([var] + [FV.WD, FV.WS]))
         vi = variables.index(var)
         wdi = variables.index(FV.WD)
@@ -735,6 +747,9 @@ class FlowPlots2D(SliceData):
             or matplotlib.QuadContourSet
 
         """
+        if self.nofig:
+            yield None
+
         variables = list(set([var] + [FV.WD, FV.WS]))
         vi = variables.index(var)
         wdi = variables.index(FV.WD)
@@ -921,6 +936,9 @@ class FlowPlots2D(SliceData):
             or matplotlib.QuadContourSet
 
         """
+        if self.nofig:
+            yield None
+
         variables = list(set([var] + [FV.WD, FV.WS]))
         vi = variables.index(var)
         wdi = variables.index(FV.WD)

foxes/output/flow_plots_2d/get_fig.py

@@ -96,6 +96,7 @@ def get_fig(
         or matplotlib.QuadContourSet
 
     """
+
     # create plot:
     if fig is None:
         hfig = plt.figure(figsize=figsize)

foxes/output/output.py

@@ -17,12 +17,14 @@ class Output:
         The output file directory
     out_fname_fun: Function, optional
         Modifies file names by f(fname)
+    nofig: bool
+        Do not show figures
 
     :group: output
 
     """
 
-    def __init__(self, out_dir=None, out_fname_fun=None):
+    def __init__(self, out_dir=None, out_fname_fun=None, nofig=False):
         """
         Constructor.
 
@@ -32,12 +34,15 @@ class Output:
             The output file directory
         out_fname_fun: Function, optional
             Modifies file names by f(fname)
+        nofig: bool
+            Do not show figures
 
         """
         self.out_dir = (
             get_output_path(out_dir) if out_dir is not None else config.output_dir
         )
         self.out_fname_fun = out_fname_fun
+        self.nofig = nofig
 
         if not self.out_dir.is_dir():
             print(f"{type(self).__name__}: Creating output dir {self.out_dir}")

foxes/output/results_writer.py

@@ -46,7 +46,7 @@ class ResultsWriter(Output):
             self.data = data
         else:
             raise KeyError(
-                f"ResultsWriter: Either give 'farm_results' or 'data' arguments"
+                "ResultsWriter: Either give 'farm_results' or 'data' arguments"
             )
 
     def _get_data_vars(self, variables):

foxes/output/rose_plot.py

@@ -250,6 +250,9 @@ class RosePlotOutput(Output):
             The plot data
 
         """
+        if self.nofig:
+            return None
+
         data = self.get_data(wd_sectors, ws_var, ws_bins, wd_var, **kwargs)
 
         n_wsb = data.sizes[ws_var]
@@ -337,6 +340,8 @@ class RosePlotOutput(Output):
             The wind rose data
 
         """
+        if self.nofig:
+            return None
 
         r = self.get_figure(*args, ret_data=ret_data, **kwargs)
         fpath = self.get_fpath(file_name)
@@ -560,6 +565,9 @@ class WindRoseBinPlot(Output):
             The axes object
 
         """
+        if self.nofig:
+            return None
+
         data = self.get_data(
             variable=variable,
             ws_bins=ws_bins,
@@ -625,6 +633,8 @@ class WindRoseBinPlot(Output):
             The wind rose data
 
         """
+        if self.nofig:
+            return None
 
         r = self.get_figure(*args, ret_data=ret_data, **kwargs)
         fpath = self.get_fpath(file_name)

foxes/output/rotor_point_plots.py

@@ -77,6 +77,9 @@ class RotorPointPlot(Output):
             The plot axes
 
         """
+        if self.nofig:
+            return None
+
         if fig is None:
             fig = plt.figure(figsize=figsize)
             ax = fig.add_subplot(111)

foxes/output/state_turbine_map.py

@@ -69,6 +69,9 @@ class StateTurbineMap(Output):
             The plot axis
 
         """
+        if self.nofig:
+            return None
+
         turbines = self.results[FC.TURBINE].to_numpy()
         states = self.results[FC.STATE].to_numpy()
 

foxes/output/turbine_type_curves.py

@@ -105,6 +105,9 @@ class TurbineTypeCurves(Output):
             The plot axes, one for each variable
 
         """
+        if self.nofig:
+            return None
+
         vars = [variables] if isinstance(variables, str) else variables
         if isinstance(titles, str):
             titles = [titles]

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)
 
-        self.name = name if name is not None else type(self).__name__
+    @property
+    def name(self):
+        """
+        The dictionary name
+
+        Returns
+        -------
+        name: str
+            The dictionary name
+
+        """
+        return self._name
 
     def get_item(self, key, *deflt, prnt=True):
         """
@@ -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/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:

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: foxes
-Version: 1.4
+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,60 +44,41 @@ 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: h5netcdf
+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: dask; extra == "dask"
-Requires-Dist: distributed; extra == "dask"
-Requires-Dist: dask-jobqueue; extra == "dask"
-Requires-Dist: setuptools; extra == "dask"
-Provides-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: 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: 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: ruff; 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
@@ -159,7 +139,7 @@ Evaluation Software"`
 
 ## Requirements
 
-The supported Python versions are `Python 3.8`...`3.13`.
+The supported Python versions are `Python 3.9`...`3.13`.
 
 ## Installation