foxes 1.0__tar.gz → 1.1.0.2__tar.gz

{foxes-1.0/foxes.egg-info → foxes-1.1.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foxes
-Version: 1.0
+Version: 1.1.0.2
 Summary: Farm Optimization and eXtended yield Evaluation Software
 Author: Jonas Schulte
 Maintainer: Jonas Schulte
@@ -41,6 +41,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Development Status :: 4 - Beta
@@ -58,7 +59,7 @@ Requires-Dist: cycler
 Requires-Dist: tqdm
 Requires-Dist: pyyaml
 Provides-Extra: io
-Requires-Dist: windio>=1; extra == "io"
+Requires-Dist: windIO>=1.0; extra == "io"
 Provides-Extra: opt
 Requires-Dist: foxes-opt; extra == "opt"
 Provides-Extra: dask
@@ -73,12 +74,14 @@ 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"
@@ -95,7 +98,7 @@ Requires-Dist: flake8; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: jupyter; extra == "dev"
 Requires-Dist: objsize; extra == "dev"
-Requires-Dist: black; extra == "dev"
+Requires-Dist: black[jupyter]; extra == "dev"
 
 # Welcome to foxes
 
@@ -113,6 +116,7 @@ The software `foxes` is a modular wind farm simulation and wake modelling toolbo
 The fast performance of `foxes` is owed to vectorization and parallelization,
 and it is intended to be used for large wind farms and large timeseries inflow data.
 The parallelization on local or remote clusters is supported, based on 
+[mpi4py](https://mpi4py.readthedocs.io/en/stable/) or
 [dask.distributed](https://distributed.dask.org/en/stable/).
 The wind farm
 optimization capabilities invoke the [iwopy](https://github.com/FraunhoferIWES/iwopy) package which

{foxes-1.0 → foxes-1.1.0.2}/README.md

@@ -14,6 +14,7 @@ The software `foxes` is a modular wind farm simulation and wake modelling toolbo
 The fast performance of `foxes` is owed to vectorization and parallelization,
 and it is intended to be used for large wind farms and large timeseries inflow data.
 The parallelization on local or remote clusters is supported, based on 
+[mpi4py](https://mpi4py.readthedocs.io/en/stable/) or
 [dask.distributed](https://distributed.dask.org/en/stable/).
 The wind farm
 optimization capabilities invoke the [iwopy](https://github.com/FraunhoferIWES/iwopy) package which

{foxes-1.0 → foxes-1.1.0.2}/examples/states_lookup_table/run.py

@@ -51,7 +51,7 @@ if __name__ == "__main__":
     parser.add_argument(
         "-m", "--tmodels", help="The turbine models", default=[], nargs="+"
     )
-    parser.add_argument("-e", "--engine", help="The engine", default=None)
+    parser.add_argument("-e", "--engine", help="The engine", default="default")
     parser.add_argument(
         "-n", "--n_cpus", help="The number of cpus", default=None, type=int
     )

{foxes-1.0 → foxes-1.1.0.2}/examples/timeseries/run.py

@@ -99,6 +99,15 @@ if __name__ == "__main__":
         plt.show()
         plt.close(ax.get_figure())
 
+    engine = foxes.Engine.new(
+        args.engine,
+        n_procs=args.n_cpus,
+        chunk_size_states=args.chunksize_states,
+        chunk_size_points=args.chunksize_points,
+        verbosity=1,
+    )
+    engine.initialize()
+
     Algo = foxes.algorithms.Iterative if args.iterative else foxes.algorithms.Downwind
     algo = Algo(
         farm,
@@ -108,10 +117,6 @@ if __name__ == "__main__":
         wake_frame=args.frame,
         partial_wakes=args.pwakes,
         mbook=mbook,
-        engine=args.engine,
-        n_procs=args.n_cpus,
-        chunk_size_states=args.chunksize_states,
-        chunk_size_points=args.chunksize_points,
         verbosity=1,
     )
 
@@ -177,6 +182,8 @@ if __name__ == "__main__":
     print(f"Farm efficiency   : {o.calc_farm_efficiency()*100:.2f} %")
     print(f"Annual farm yield : {turbine_results[FV.YLD].sum():.2f} GWh")
 
+    engine.finalize()
+
     if not args.nofig:
         o = foxes.output.StateTurbineMap(farm_results)
         ax = o.plot_map(FV.P, cmap="inferno", figsize=(6, 7))

{foxes-1.0 → foxes-1.1.0.2}/foxes/algorithms/downwind/downwind.py

@@ -115,15 +115,15 @@ class Downwind(Algorithm):
         self.__states = states
         self.n_states = None
 
-        self.__rotor_model = self.mbook.rotor_models[rotor_model]
+        self.__rotor_model = self.mbook.rotor_models.get_item(rotor_model)
         self.rotor_model.name = rotor_model
 
-        self.__wake_frame = self.mbook.wake_frames[wake_frame]
+        self.__wake_frame = self.mbook.wake_frames.get_item(wake_frame)
         self.wake_frame.name = wake_frame
 
         self.__wake_models = {}
         for w in wake_models:
-            m = self.mbook.wake_models[w]
+            m = self.mbook.wake_models.get_item(w)
             m.name = w
             self.wake_models[w] = m
 
@@ -137,10 +137,12 @@ class Downwind(Algorithm):
                     try:
                         pw = values
                         if checkw:
-                            mbooks[pw].check_wmodel(self.wake_models[w], error=True)
+                            mbooks.get_item(pw).check_wmodel(
+                                self.wake_models[w], error=True
+                            )
                     except TypeError:
                         pw = deffunc(self.wake_models[w])
-                    target[w] = mbooks[pw]
+                    target[w] = mbooks.get_item(pw)
                     target[w].name = pw
             elif isinstance(values, list):
                 for i, w in enumerate(wake_models):
@@ -149,7 +151,7 @@ class Downwind(Algorithm):
                             f"Not enough {descr} in list {values}, expecting {len(wake_models)}"
                         )
                     pw = values[i]
-                    target[w] = mbooks[pw]
+                    target[w] = mbooks.get_item(pw)
                     target[w].name = pw
             else:
                 for w in wake_models:
@@ -157,7 +159,7 @@ class Downwind(Algorithm):
                         pw = values[w]
                     else:
                         pw = deffunc(self.wake_models[w])
-                    target[w] = mbooks[pw]
+                    target[w] = mbooks.get_item(pw)
                     target[w].name = pw
 
         self.__partial_wakes = {}
@@ -180,7 +182,7 @@ class Downwind(Algorithm):
             checkw=False,
         )
 
-        self.__farm_controller = self.mbook.farm_controllers[farm_controller]
+        self.__farm_controller = self.mbook.farm_controllers.get_item(farm_controller)
         self.farm_controller.name = farm_controller
 
     @property
@@ -541,7 +543,7 @@ class Downwind(Algorithm):
 
         # initialize models:
         if not mlist.initialized:
-            mlist.initialize(self, self.verbosity)
+            mlist.initialize(self, self.verbosity - 1)
             self._calc_farm_vars(mlist)
         self._print_model_oder(mlist, calc_pars)
 
@@ -574,7 +576,7 @@ class Downwind(Algorithm):
         # finalize models:
         if finalize:
             self.print("\n")
-            mlist.finalize(self, self.verbosity)
+            mlist.finalize(self, self.verbosity - 1)
             self.finalize()
         else:
             self.del_model_data(mlist)
@@ -678,6 +680,7 @@ class Downwind(Algorithm):
         farm_results,
         points,
         point_models=None,
+        outputs=None,
         calc_parameters={},
         persist_mdata=True,
         persist_pdata=False,
@@ -698,6 +701,8 @@ class Downwind(Algorithm):
             dimensions (state, turbine)
         points: numpy.ndarray
             The points of interest, shape: (n_states, n_points, 3)
+        outputs: list of str, optional
+            The output variables, or None for defaults
         point_models: str or foxes.core.PointDataModel
             Additional point models to be executed
         calc_parameters: dict
@@ -746,7 +751,7 @@ class Downwind(Algorithm):
 
         # initialize models:
         if not mlist.initialized:
-            mlist.initialize(self, self.verbosity)
+            mlist.initialize(self, self.verbosity - 1)
 
         # subset selections:
         sel = {} if states_sel is None else {FC.STATE: states_sel}
@@ -780,7 +785,7 @@ class Downwind(Algorithm):
         self.print("\nInput point data:\n\n", point_data, "\n")
 
         # check vars:
-        ovars = mlist.output_point_vars(self)
+        ovars = mlist.output_point_vars(self) if outputs is None else outputs
         self.print(f"\nOutput point variables:", ", ".join(ovars))
 
         # calculate:
@@ -800,7 +805,7 @@ class Downwind(Algorithm):
         # finalize models:
         if finalize:
             self.print("\n")
-            mlist.finalize(self, self.verbosity)
+            mlist.finalize(self, self.verbosity - 1)
             self.finalize()
 
         if ambient:

{foxes-1.0 → foxes-1.1.0.2}/foxes/algorithms/downwind/models/farm_wakes_calc.py

@@ -34,7 +34,7 @@ class FarmWakesCalculation(FarmDataModel):
         return list(dict.fromkeys(ovars))
 
     def calculate(self, algo, mdata, fdata):
-        """ "
+        """
         The main model calculation.
 
         This function is executed on a single chunk of data,

{foxes-1.0 → foxes-1.1.0.2}/foxes/algorithms/downwind/models/init_farm_data.py

@@ -48,7 +48,7 @@ class InitFarmData(FarmDataModel):
         ]
 
     def calculate(self, algo, mdata, fdata):
-        """ "
+        """
         The main model calculation.
 
         This function is executed on a single chunk of data,

{foxes-1.0 → foxes-1.1.0.2}/foxes/algorithms/downwind/models/point_wakes_calc.py

@@ -88,7 +88,7 @@ class PointWakesCalculation(PointDataModel):
         return self.pvars
 
     def calculate(self, algo, mdata, fdata, tdata, downwind_index=None):
-        """ "
+        """
         The main model calculation.
 
         This function is executed on a single chunk of data,

{foxes-1.0 → foxes-1.1.0.2}/foxes/algorithms/downwind/models/reorder_farm_output.py

@@ -48,7 +48,7 @@ class ReorderFarmOutput(FarmDataModel):
         return self.outputs if self.outputs is not None else algo.farm_vars
 
     def calculate(self, algo, mdata, fdata):
-        """ "
+        """
         The main model calculation.
 
         This function is executed on a single chunk of data,

{foxes-1.0 → foxes-1.1.0.2}/foxes/algorithms/downwind/models/set_amb_farm_results.py

@@ -42,7 +42,7 @@ class SetAmbFarmResults(FarmDataModel):
         return [FV.var2amb[v] for v in self.vars]
 
     def calculate(self, algo, mdata, fdata):
-        """ "
+        """
         The main model calculation.
 
         This function is executed on a single chunk of data,

{foxes-1.0 → foxes-1.1.0.2}/foxes/algorithms/downwind/models/set_amb_point_results.py

@@ -61,7 +61,7 @@ class SetAmbPointResults(PointDataModel):
         return [FV.var2amb[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-1.0 → foxes-1.1.0.2}/foxes/algorithms/iterative/iterative.py

@@ -331,7 +331,7 @@ class Iterative(Downwind):
             self.finalize()
             for m in self._mlist0.models:
                 if m not in self.sub_models():
-                    m.finalize(self, self.verbosity)
+                    m.finalize(self, self.verbosity - 1)
             del self._mlist0, self._calc_pars0
 
         if ret_dwnd_order:

{foxes-1.0 → foxes-1.1.0.2}/foxes/algorithms/iterative/models/farm_wakes_calc.py

@@ -64,7 +64,7 @@ class FarmWakesCalculation(FarmDataModel):
         return [] if self.urelax is None else [self.urelax]
 
     def calculate(self, algo, mdata, fdata):
-        """ "
+        """
         The main model calculation.
 
         This function is executed on a single chunk of data,

{foxes-1.0 → foxes-1.1.0.2}/foxes/algorithms/iterative/models/urelax.py

@@ -10,7 +10,7 @@ class URelax(FarmDataModel):
     ----------
     urel: dict
         The variables and their under-relaxation
-        factors bewteen 0 and 1
+        factors between 0 and 1
 
     :group: algorithms.iterative.models
 
@@ -24,7 +24,7 @@ class URelax(FarmDataModel):
         ----------
         urel: dict
             The variables and their under-relaxation
-            factors bewteen 0 and 1
+            factors between 0 and 1
 
         """
         super().__init__()
@@ -49,7 +49,7 @@ class URelax(FarmDataModel):
         return list(self.urel.keys())
 
     def calculate(self, algo, mdata, fdata):
-        """ "
+        """
         The main model calculation.
 
         This function is executed on a single chunk of data,

{foxes-1.0 → foxes-1.1.0.2}/foxes/algorithms/sequential/models/plugin.py

@@ -6,7 +6,7 @@ class SequentialPlugin:
     Parameters
     ----------
     algo: foxes.algorithms.sequential.Sequential
-        The sequetial algorithm
+        The sequential algorithm
 
     :group: algorithms.sequential.models
 
@@ -25,7 +25,7 @@ class SequentialPlugin:
         Parameters
         ----------
         algo: foxes.algorithms.sequential.Sequential
-            The current sequetial algorithm
+            The current sequential algorithm
 
         """
         self.algo = algo
@@ -37,7 +37,7 @@ class SequentialPlugin:
         Parameters
         ----------
         algo: foxes.algorithms.sequential.Sequential
-            The latest sequetial algorithm
+            The latest sequential algorithm
         fres: xarray.Dataset
             The latest farm results
         pres: xarray.Dataset, optional
@@ -53,7 +53,7 @@ class SequentialPlugin:
         Parameters
         ----------
         algo: foxes.algorithms.sequential.Sequential
-            The final sequetial algorithm
+            The final sequential algorithm
 
         """
         self.algo = algo

{foxes-1.0 → foxes-1.1.0.2}/foxes/algorithms/sequential/models/seq_state.py

@@ -135,7 +135,7 @@ class SeqState(States):
         return self.states.output_point_vars(algo)
 
     def calculate(self, algo, mdata, fdata, tdata):
-        """ "
+        """
         The main model calculation.
 
         This function is executed on a single chunk of data,

{foxes-1.0 → foxes-1.1.0.2}/foxes/constants.py

@@ -143,7 +143,7 @@ BLOCK_CONVERGENCE = "block_convergence"
 
 
 KAPPA = 0.41
-""" The Van-Karman constant
+""" The Von Karman constant
 :group: foxes.constants
 """
 
@@ -154,22 +154,22 @@ W = "W"
 """
 
 kW = "kW"
-""" The unit kilo watt
+""" The unit kilowatt
 :group: foxes.constants
 """
 
 MW = "MW"
-""" The unit mega watt
+""" The unit megawatt
 :group: foxes.constants
 """
 
 GW = "GW"
-""" The unit giga watt
+""" The unit gigawatt
 :group: foxes.constants
 """
 
 TW = "TW"
-""" The unit terra watt
+""" The unit terawatt
 :group: foxes.constants
 """
 

{foxes-1.0 → foxes-1.1.0.2}/foxes/core/algorithm.py

@@ -179,7 +179,7 @@ class Algorithm(Model):
             raise ValueError(
                 f"Algorithm '{self.name}': Cannot initialize while running"
             )
-        super().initialize(self, self.verbosity)
+        super().initialize(self, self.verbosity - 1)
 
     def store_model_data(self, model, idata, force=False):
         """
@@ -894,7 +894,7 @@ class Algorithm(Model):
         """
         if self.running:
             raise ValueError(f"Algorithm '{self.name}': Cannot finalize while running")
-        super().finalize(self, self.verbosity)
+        super().finalize(self, self.verbosity - 1)
         if clear_mem:
             self.__idata_mem = Dict()
             # self.reset_chunk_store()

{foxes-1.0 → foxes-1.1.0.2}/foxes/core/data_calc_model.py

@@ -5,7 +5,7 @@ from .model import Model
 
 class DataCalcModel(Model):
     """
-    Abstract base class for models with
+    Abstract base class for models
     that run calculation on xarray Dataset
     data.
 
@@ -35,7 +35,7 @@ class DataCalcModel(Model):
 
     @abstractmethod
     def calculate(self, algo, *data, **parameters):
-        """ "
+        """
         The main model calculation.
 
         This function is executed on a single chunk of data,

{foxes-1.0 → foxes-1.1.0.2}/foxes/core/engine.py

@@ -1,6 +1,6 @@
+import os
 import numpy as np
 from abc import ABC, abstractmethod
-from os import cpu_count
 from tqdm import tqdm
 from xarray import Dataset
 
@@ -58,7 +58,10 @@ class Engine(ABC):
         """
         self.chunk_size_states = chunk_size_states
         self.chunk_size_points = chunk_size_points
-        self.n_procs = n_procs if n_procs is not None else max(cpu_count() - 1, 1)
+        try:
+            self.n_procs = n_procs if n_procs is not None else os.process_cpu_count()
+        except AttributeError:
+            self.n_procs = os.cpu_count()
         self.verbosity = verbosity
         self.__initialized = False
         self.__entered = False
@@ -257,14 +260,18 @@ class Engine(ABC):
         chunk_sizes_targets = [n_targets]
         if n_targets > 1:
             if self.chunk_size_points is None:
-                chunk_size_targets = n_targets
-                n_chunks_targets = 1
+                if n_chunks_states == 1:
+                    n_chunks_targets = min(self.n_procs, n_targets)
+                    chunk_size_targets = max(int(n_targets / self.n_procs), 1)
+                else:
+                    chunk_size_targets = n_targets
+                    n_chunks_targets = 1
             else:
                 chunk_size_targets = min(n_targets, self.chunk_size_points)
                 n_chunks_targets = max(int(n_targets / chunk_size_targets), 1)
-                if int(n_targets / n_chunks_targets) > chunk_size_targets:
-                    n_chunks_targets += 1
-                    chunk_size_targets = int(n_targets / n_chunks_targets)
+            if int(n_targets / n_chunks_targets) > chunk_size_targets:
+                n_chunks_targets += 1
+                chunk_size_targets = int(n_targets / n_chunks_targets)
             chunk_sizes_targets = np.full(n_chunks_targets, chunk_size_targets)
             extra = n_targets - n_chunks_targets * chunk_size_targets
             if extra > 0:
@@ -419,7 +426,7 @@ class Engine(ABC):
             The final results dataset
 
         """
-        self.print("Combining results", level=2)
+        self.print(f"{type(self).__name__}: Combining results", level=2)
         pbar = tqdm(total=len(out_vars)) if self.verbosity > 1 else None
         data_vars = {}
         for v in out_vars:
@@ -502,10 +509,12 @@ class Engine(ABC):
         """
         n_states = model_data.sizes[FC.STATE]
         if point_data is None:
-            self.print(f"Calculating {n_states} states for {algo.n_turbines} turbines")
+            self.print(
+                f"{type(self).__name__}: Calculating {n_states} states for {algo.n_turbines} turbines"
+            )
         else:
             self.print(
-                f"Calculating data at {point_data.sizes[FC.TARGET]} points for {n_states} states"
+                f"{type(self).__name__}: Calculating data at {point_data.sizes[FC.TARGET]} points for {n_states} states"
             )
         if not self.initialized:
             raise ValueError(f"Engine '{type(self).__name__}' not initialized")
@@ -541,6 +550,7 @@ class Engine(ABC):
                 local_cluster="LocalClusterEngine",
                 slurm_cluster="SlurmClusterEngine",
                 mpi="MPIEngine",
+                ray="RayEngine",
                 numpy="NumpyEngine",
                 single="SingleChunkEngine",
             ).get(engine_type, engine_type)

{foxes-1.0 → foxes-1.1.0.2}/foxes/core/farm_controller.py

@@ -87,7 +87,7 @@ class FarmController(FarmDataModel):
 
     def needs_rews2(self):
         """
-        Returns flag for requirering REWS2 variable
+        Returns flag for requiring REWS2 variable
 
         Returns
         -------
@@ -102,7 +102,7 @@ class FarmController(FarmDataModel):
 
     def needs_rews3(self):
         """
-        Returns flag for requirering REWS3 variable
+        Returns flag for requiring REWS3 variable
 
         Returns
         -------
@@ -348,7 +348,7 @@ class FarmController(FarmDataModel):
         return list(ovars)
 
     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,

{foxes-1.0 → foxes-1.1.0.2}/foxes/core/farm_data_model.py

@@ -87,7 +87,7 @@ class FarmDataModel(DataCalcModel):
 
     @abstractmethod
     def calculate(self, algo, mdata, fdata):
-        """ "
+        """
         The main model calculation.
 
         This function is executed on a single chunk of data,

{foxes-1.0 → foxes-1.1.0.2}/foxes/core/ground_model.py

@@ -70,7 +70,7 @@ class GroundModel(Model):
             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
@@ -207,7 +207,7 @@ class GroundModel(Model):
             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