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

foxes/models/wake_superpositions/ws_quadratic.py

@@ -7,7 +7,7 @@ import foxes.constants as FC
 
 class WSQuadratic(WakeSuperposition):
     """
-    Quadratic supersposition of wind deficit results
+    Quadratic superposition of wind deficit results
 
     Attributes
     ----------
@@ -94,7 +94,7 @@ class WSQuadratic(WakeSuperposition):
             The target point data
         downwind_index: int
             The index of the wake causing turbine
-            in the downwnd order
+            in the downwind order
         st_sel: numpy.ndarray of bool
             The selection of targets, shape: (n_states, n_targets)
         variable: str
@@ -121,14 +121,15 @@ class WSQuadratic(WakeSuperposition):
         if np.any(st_sel):
             scale = self.get_data(
                 FV.AMB_REWS if self.scale_amb else FV.REWS,
-                FC.STATE_TARGET,
+                FC.STATE_TARGET_TPOINT,
                 lookup="w",
                 algo=algo,
                 fdata=fdata,
                 tdata=tdata,
                 downwind_index=downwind_index,
-                upcast=True,
-            )[st_sel, None]
+                upcast=False,
+                selection=st_sel,
+            )
 
             wake_delta[st_sel] += (scale * wake_model_result) ** 2
 
@@ -182,7 +183,7 @@ class WSQuadratic(WakeSuperposition):
 
 class WSQuadraticLocal(WakeSuperposition):
     """
-    Local quadratic supersposition of wind deficit results
+    Local quadratic superposition of wind deficit results
 
     Attributes
     ----------
@@ -261,7 +262,7 @@ class WSQuadraticLocal(WakeSuperposition):
             The target point data
         downwind_index: int
             The index of the wake causing turbine
-            in the downwnd order
+            in the downwind order
         st_sel: numpy.ndarray of bool
             The selection of targets, shape: (n_states, n_targets)
         variable: str

foxes/output/farm_layout.py

@@ -138,7 +138,7 @@ class FarmLayoutOutput(Output):
         ----------
         color_by: str, optional
             Set scatter color by variable results.
-            Use "mean_REWS" etc for means, also
+            Use "mean_REWS", etc, for means, also
             min, max, sum. All wrt states
         fontsize: int, optional
             Size of the turbine numbers
@@ -325,7 +325,7 @@ class FarmLayoutOutput(Output):
         fname = file_path if file_path is not None else self.farm.name + ".xyh"
         np.savetxt(fname, data, header="x y h")
 
-    def write_csv(self, file_path=None):
+    def write_csv(self, file_path=None, type_col=None, algo=None):
         """
         Writes csv layout file.
 
@@ -334,6 +334,10 @@ class FarmLayoutOutput(Output):
         file_path: str
             The file into which to plot, or None
             for default
+        type_col: str, optional
+            Name of the turbine type column
+        algo: foxes.core.Algorithm, optional
+            The algorithm, needed for turbine types
 
         """
 
@@ -341,17 +345,17 @@ class FarmLayoutOutput(Output):
 
         fname = file_path if file_path is not None else self.farm.name + ".csv"
 
-        lyt = pd.DataFrame(
-            index=range(len(data)), columns=["id", "name", "x", "y", "h", "D"]
-        )
+        lyt = pd.DataFrame(index=range(len(data)), columns=["name", "x", "y", "h", "D"])
         lyt.index.name = "index"
-        lyt["id"] = [t.info["id"] for t in self.farm.turbines]
-        lyt["name"] = [t.info["name"] for t in self.farm.turbines]
-        lyt["x"] = data[:, 0]
-        lyt["y"] = data[:, 1]
-        lyt["h"] = data[:, 2]
+        lyt["name"] = [t.name for t in self.farm.turbines]
+        lyt["x"] = np.round(data[:, 0], 4)
+        lyt["y"] = np.round(data[:, 1], 4)
+        lyt["h"] = np.round(data[:, 2], 4)
         lyt["D"] = [t.D for t in self.farm.turbines]
 
+        if type_col is not None:
+            lyt[type_col] = [m.name for m in algo.farm_controller.turbine_types]
+
         lyt.to_csv(fname)
 
     def write_json(self, file_path=None):

foxes/output/farm_results_eval.py

@@ -381,7 +381,7 @@ class FarmResultsEval(Output):
         algo: foxes.core.Algorithm, optional
             The algorithm, for P_nominal lookup
         annual: bool, optional
-            Flag for returing annual results, by default False
+            Flag for returning annual results, by default False
         ambient: bool, optional
             Flag for ambient power, by default False
         hours: int, optional

foxes/output/grids.py

@@ -27,7 +27,7 @@ def calc_point_results(
     farm_results: xarray.Dataset, optional
         The farm results
     seq_iter: foxes.algorithms.sequential.SequentialIter, optional
-        The sequential itarator
+        The sequential iterator
     verbosity: int
         The verbosity level, 0 = silent
     kwargs: dict, optional

foxes/output/results_writer.py

@@ -83,7 +83,7 @@ class ResultsWriter(Output):
         Parameters
         ----------
         file_path: str
-            Path the the csv file
+            Path for the csv file
         variables: dict or list of str, optional
             The variables to be written. If a dict, then
             the keys are the foxes variables and the values
@@ -150,7 +150,7 @@ class ResultsWriter(Output):
         Parameters
         ----------
         file_path: str
-            Path the the csv file
+            Path for the nc file
         variables: dict or list of str, optional
             The variables to be written. If a dict, then
             the keys are the foxes variables and the values

foxes/output/rose_plot.py

@@ -118,7 +118,7 @@ class RosePlotOutput(Output):
         var: str
             The data variable name
         var_bins: list of float
-            The variable bin seperation values
+            The variable bin separation values
         wd_var: str, optional
             The wind direction variable name
         turbine: int, optional
@@ -231,7 +231,7 @@ class RosePlotOutput(Output):
         var: str
             The data variable name
         var_bins: list of float
-            The variable bin seperation values
+            The variable bin separation values
         wd_var: str, optional
             The wind direction variable name
         turbine: int, optional
@@ -330,7 +330,7 @@ class RosePlotOutput(Output):
         var: str
             The data variable name
         var_bins: list of float
-            The variable bin seperation values
+            The variable bin separation values
         ret_data: bool
             Flag for returning wind rose data
         kwargs: dict, optional

foxes/output/seq_plugins/seq_flow_ani_plugin.py

@@ -49,7 +49,7 @@ class SeqFlowAnimationPlugin(SequentialPlugin):
         Parameters
         ----------
         algo: foxes.algorithms.sequential.Sequential
-            The current sequetial algorithm
+            The current sequential algorithm
 
         """
         super().initialize(algo)
@@ -62,7 +62,7 @@ class SeqFlowAnimationPlugin(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

foxes/output/seq_plugins/seq_wake_debug_plugin.py

@@ -54,7 +54,7 @@ class SeqWakeDebugPlugin(SequentialPlugin):
         Parameters
         ----------
         algo: foxes.algorithms.sequential.Sequential
-            The current sequetial algorithm
+            The current sequential algorithm
 
         """
         super().initialize(algo)
@@ -67,7 +67,7 @@ class SeqWakeDebugPlugin(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

foxes/output/state_turbine_map.py

@@ -7,7 +7,7 @@ from .output import Output
 
 class StateTurbineMap(Output):
     """
-    Creates heat maps with turbines on the one
+    Creates heat maps with turbines on one axis
     and states on the other axis.
 
     Attributes

foxes/utils/abl/neutral.py

@@ -39,7 +39,7 @@ def ustar(ws_ref, h_ref, z0, kappa=0.41):
     z0: float
         The roughness length
     kappa: float
-        The van-Karman constant
+        The von Karman constant
 
     Returns
     -------
@@ -66,7 +66,7 @@ def calc_ws(height, z0, ustar, kappa=0.41):
     ustar: float
         The friction velocity
     kappa: float
-        The van-Karman constant
+        The von Karman constant
 
     Returns
     -------

foxes/utils/abl/stable.py

@@ -64,7 +64,7 @@ def ustar(ws_ref, h_ref, z0, mol, kappa=0.41):
     mol: float
         The Monin-Obukhov height
     kappa: float
-        The van-Karman constant
+        The von Karman constant
 
     Returns
     -------
@@ -92,7 +92,7 @@ def calc_ws(height, z0, ustar, psi, kappa=0.41):
     psi: float
         The Psi function values
     kappa: float
-        The van-Karman constant
+        The von Karman constant
 
     Returns
     -------

foxes/utils/abl/unstable.py

@@ -47,7 +47,7 @@ def ustar(ws_ref, h_ref, z0, mol, kappa=0.41):
     mol: float
         The Monin-Obukhov height
     kappa: float
-        The van-Karman constant
+        The von Karman constant
 
     Returns
     -------
@@ -75,7 +75,7 @@ def calc_ws(height, z0, ustar, psi, kappa=0.41):
     psi: float
         The Psi function values
     kappa: float
-        The van-Karman constant
+        The von Karman constant
 
     Returns
     -------

foxes/utils/data_book.py

@@ -89,7 +89,7 @@ class DataBook:
         context: str
             The context
         package: str or package
-            The package, must contain init.py` file
+            The package, must contain init.py file
         file_mane: str
             The file name
 

foxes/utils/dict.py

@@ -28,6 +28,29 @@ class Dict(dict):
         super().__init__(*args, **kwargs)
         self.name = name if name is not None else type(self).__name__
 
+    def get_item(self, key, prnt=True):
+        """
+        Gets an item, prints readable error if not found
+
+        Parameters
+        ----------
+        key: immutable object
+            The key
+        prnt: bool
+            Flag for message printing
+
+        """
+        try:
+            return self[key]
+        except KeyError as e:
+            if prnt:
+                print(f"\n{self.name}: Cannot find key '{key}'.\n")
+                print("Known keys:")
+                for k in self.keys():
+                    print("   ", k)
+                print()
+            raise e
+
     def __getitem__(self, key):
         try:
             return super().__getitem__(key)

foxes/utils/exec_python.py

@@ -17,7 +17,7 @@ def exec_python(s, indicator="%", newline=";", globals=globals(), locals={}):
     s: list, dict or object
         The source to by analyzed
     indicator: str
-        The indicator that trigger python evaluation
+        The indicator that triggers python evaluation
     newline: str
         The new line indicator
     globals: dict

foxes/utils/factory.py

@@ -618,6 +618,35 @@ class FDict(Dict):
                     return True
         return found
 
+    def get_item(self, key, prnt=True):
+        """
+        Gets an item, prints readable error if not found
+
+        Parameters
+        ----------
+        key: immutable object
+            The key
+        prnt: bool
+            Flag for message printing
+
+        """
+        try:
+            return self[key]
+        except KeyError as e:
+            if prnt:
+                print(
+                    f"\n{self.name}: Cannot find key '{key}', also no factory matches.\n"
+                )
+                print("Known keys:")
+                for k in self.keys():
+                    print("   ", k)
+                if len(self.factories):
+                    print("\nKnown factories:")
+                    for f in self.factories:
+                        print("   ", f.name_template)
+                print()
+            raise e
+
     def __getitem__(self, key):
         try:
             return super().__getitem__(key)
@@ -630,7 +659,6 @@ class FDict(Dict):
                     return obj
                 except ValueError:
                     pass
-
         k = ", ".join(sorted(list(self.keys())))
         e = f"{self.name}: Cannot find key '{key}', also no factory matches. Known keys: {k}. Known factories: {[f.name_template for f in self.factories]}"
         raise KeyError(e)

foxes/utils/geom2d/circle.py

@@ -21,7 +21,7 @@ class Circle(AreaGeometry):
 
     def __init__(self, centre, radius):
         """
-        Cobnstructor.
+        Constructor.
 
         Parameters
         ----------

foxes/utils/geom2d/polygon.py

@@ -74,7 +74,7 @@ class ClosedPolygon(AreaGeometry):
         points: numpy.ndarray
             The probe points, shape (n_points, 2)
         return_nearest: bool
-            Flag for return of the nearest point on bundary
+            Flag for return of the nearest point on boundary
 
         Returns
         -------

foxes/utils/geopandas_utils.py

@@ -50,7 +50,7 @@ def check_import_utm():
 
 def read_shp(fname, **kwargs):
     """
-    Read a shape file
+    Read a shapefile file
 
     Parameters
     ----------
@@ -74,7 +74,7 @@ def read_shp(fname, **kwargs):
 
 def shp2csv(ifile, ofile, in_kwargs={}, out_kwargs={}, verbosity=1):
     """
-    Read shape file, write csv file
+    Read shapefile file, write csv file
 
     Parameters
     ----------

foxes/utils/load.py

@@ -20,7 +20,7 @@ def import_module(name, package=None, hint=None):
     Returns
     -------
     mdl: module
-        The imnported package
+        The imported package
 
     :group: utils
 
@@ -35,7 +35,7 @@ def import_module(name, package=None, hint=None):
 
 def load_module(name, path):
     """
-    Imports a module from file path
+    Imports a module from a file path
 
     Parameters
     ----------

foxes/utils/pandas_helpers.py

@@ -133,7 +133,7 @@ class PandasFileHelper:
         format_dict: dict
             Dictionary with format entries for
             columns, e.g. '{:.4f}'
-        kwargs: dict, optional
+        **kwargs: dict, optional
             Parameters forwarded to the pandas writing method.
 
         """

foxes/utils/xarray_utils.py

@@ -6,7 +6,7 @@ from foxes.variables import get_default_digits
 
 def write_nc(ds, fpath, round={}, complevel=9, verbosity=1, **kwargs):
     """
-    Writes a dataset to netCFD file
+    Writes a dataset to netCDF file
 
     Parameters
     ----------

foxes/variables.py

@@ -4,7 +4,7 @@ X = "X"
 """
 
 Y = "Y"
-""" The y coordinate in 
+""" The y coordinate in m
 :group: foxes.variables
 """
 
@@ -257,7 +257,7 @@ Z0 = "z0"
 """
 
 MOL = "MOL"
-""" The Monin-Ubukhof length in m
+""" The Monin–Obukhov length in m
 :group: foxes.variables
 """
 
@@ -296,7 +296,7 @@ DEFAULT_DIGITS = {
 
 def get_default_digits(variable):
     """
-    Gets the default numbber of output digits
+    Gets the default number of output digits
 
     Parameters
     ----------

{foxes-1.0.dist-info → foxes-1.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foxes
-Version: 1.0
+Version: 1.1.1
 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
@@ -67,7 +68,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"
 Provides-Extra: doc
 Requires-Dist: sphinx; extra == "doc"
 Requires-Dist: sphinx-immaterial; extra == "doc"
@@ -83,14 +84,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"
-Provides-Extra: io
-Requires-Dist: windio>=1; extra == "io"
+Requires-Dist: ray; extra == "eng0"
 Provides-Extra: opt
 Requires-Dist: foxes-opt; extra == "opt"
 Provides-Extra: test
@@ -113,10 +114,11 @@ 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
-as well supports vectorization.
+optimization capabilities invoke the [foxes-opt](https://github.com/FraunhoferIWES/foxes-opt) package which
+as well supports vectorization and parallelization.
 
 `foxes` is build upon many years of experience with wake model code development at IWES, starting with the C++ based in-house code _flapFOAM_ (2011-2019) and the Python based direct predecessor _flappy_ (2019-2022).