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

foxes/output/rotor_point_plots.py

@@ -1,14 +1,15 @@
 import numpy as np
 import matplotlib.pyplot as plt
 from matplotlib import colormaps
-from matplotlib.colors import LinearSegmentedColormap
 
 from foxes.input.states import SingleStateStates
 from foxes.core import WindFarm
 from foxes.algorithms import Downwind
 
+from .output import Output
 
-class RotorPointPlot:
+
+class RotorPointPlot(Output):
     """
     Visualizes rotor points and their weights.
 
@@ -23,7 +24,7 @@ class RotorPointPlot:
 
     """
 
-    def __init__(self, rotor_model, algo=None):
+    def __init__(self, rotor_model, algo=None, **kwargs):
         """
         Constructor.
 
@@ -33,8 +34,11 @@ class RotorPointPlot:
             The rotor model
         algo: foxes.core.Algorithm, optional
             The algorithm
+        kwargs: dict, optional
+            Additional parameters for the base class
 
         """
+        super().__init__(**kwargs)
         self.rotor_model = rotor_model
         self.algo = algo
 

foxes/output/slice_data.py

@@ -2,8 +2,8 @@ import numpy as np
 
 from foxes.output import Output
 from foxes.utils import write_nc
-import foxes.constants as FC
 import foxes.variables as FV
+import foxes.constants as FC
 
 from . import grids
 

foxes/output/state_turbine_map.py

@@ -2,6 +2,7 @@ import matplotlib.pyplot as plt
 import numpy as np
 
 import foxes.constants as FC
+
 from .output import Output
 
 
@@ -19,7 +20,7 @@ class StateTurbineMap(Output):
 
     """
 
-    def __init__(self, farm_results):
+    def __init__(self, farm_results, **kwargs):
         """
         Constructor.
 
@@ -27,8 +28,11 @@ class StateTurbineMap(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 plot_map(

foxes/output/state_turbine_table.py

@@ -19,7 +19,7 @@ class StateTurbineTable(Output):
 
     """
 
-    def __init__(self, farm_results):
+    def __init__(self, farm_results, **kwargs):
         """
         Constructor.
 
@@ -27,8 +27,11 @@ class StateTurbineTable(Output):
         ----------
         farm_results: xarray.Dataset
             The farm results
+        kwargs: dict, optional
+            Additional parameters for the base class
 
         """
+        super().__init__(**kwargs)
         self.farm_results = farm_results
 
     def get_dataset(
@@ -48,7 +51,7 @@ class StateTurbineTable(Output):
         name_map: dict
             Map from foxes to output names
         to_file: str, optional
-            The output file path, if writing is desired
+            Name of the output file, if writing is desired
         kwargs: dict, optional
             Additional parameters for write_nc
 
@@ -73,6 +76,7 @@ class StateTurbineTable(Output):
         )
 
         if to_file is not None:
-            write_nc(ds=ds, fpath=to_file, **kwargs)
+            fpath = self.get_fpath(to_file)
+            write_nc(ds=ds, fpath=fpath, **kwargs)
 
         return ds

foxes/output/turbine_type_curves.py

@@ -7,8 +7,10 @@ from foxes.input.states import StatesTable
 from foxes.core import WindFarm, Turbine
 from foxes.algorithms import Downwind
 from foxes.models.turbine_models import SetFarmVars
+from foxes.config import config
 import foxes.variables as FV
 import foxes.constants as FC
+
 from .output import Output
 
 
@@ -26,7 +28,7 @@ class TurbineTypeCurves(Output):
 
     """
 
-    def __init__(self, mbook):
+    def __init__(self, mbook, **kwargs):
         """
         Constructor.
 
@@ -34,8 +36,11 @@ class TurbineTypeCurves(Output):
         ----------
         mbook: foxes.models.ModelBook
             The model book
+        kwargs: dict, optional
+            Additional parameters for the base class
 
         """
+        super().__init__(**kwargs)
         self.mbook = mbook
 
     def plot_curves(
@@ -113,7 +118,7 @@ class TurbineTypeCurves(Output):
         if not isinstance(axs, (list, tuple, np.ndarray)):
             axs = [axs]
 
-        ws = np.arange(ws_min, ws_max + ws_step, ws_step, dtype=FC.DTYPE)
+        ws = np.arange(ws_min, ws_max + ws_step, ws_step, dtype=config.dtype_double)
         n_states = len(ws)
         sdata = pd.DataFrame(index=range(n_states))
         sdata.index.name = FC.STATE

foxes/utils/__init__.py

@@ -5,7 +5,7 @@ General utilities.
 from .wind_dir import wd2uv, wd2wdvec, wdvec2wd, uv2wd, delta_wd
 from .pandas_utils import PandasFileHelper
 from .xarray_utils import write_nc
-from .subclasses import all_subclasses
+from .subclasses import all_subclasses, new_cls, new_instance
 from .dict import Dict
 from .factory import Factory, FDict, WakeKFactory
 from .data_book import DataBook
@@ -14,7 +14,6 @@ from .geopandas_utils import read_shp, shp2csv, read_shp_polygons, shp2geom2d
 from .load import import_module, load_module
 from .exec_python import exec_python
 from .regularize import sqrt_reg
-from .windrose_plot import TabWindroseAxes
 from .tab_files import read_tab_file
 from .random_xy import random_xy_square
 from .dev_utils import print_mem

foxes/utils/dict.py

@@ -1,3 +1,7 @@
+from yaml import safe_load
+from pathlib import Path
+
+
 class Dict(dict):
     """
     A slightly enhanced dictionary.
@@ -25,10 +29,34 @@ class Dict(dict):
             Arguments passed to `dict`
 
         """
-        super().__init__(*args, **kwargs)
+        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()
+            },
+        )
+
         self.name = name if name is not None else type(self).__name__
 
-    def get_item(self, key, prnt=True):
+    def get_item(self, key, *deflt, prnt=True):
         """
         Gets an item, prints readable error if not found
 
@@ -36,12 +64,25 @@ class Dict(dict):
         ----------
         key: immutable object
             The key
+        deflt: tuple, optional
+            Tuple of length 1, containing the default
         prnt: bool
             Flag for message printing
 
+        Returns
+        -------
+        data: object
+            The data
+
         """
         try:
-            return self[key]
+            if len(deflt):
+                assert (
+                    len(deflt) == 1
+                ), f"Expecting a single default entry, got {len(deflt)}"
+                data = self.get(key, deflt[0])
+            else:
+                data = self[key]
         except KeyError as e:
             if prnt:
                 print(f"\n{self.name}: Cannot find key '{key}'.\n")
@@ -51,6 +92,35 @@ class Dict(dict):
                 print()
             raise e
 
+        if isinstance(data, dict) and not isinstance(data, Dict):
+            data = Dict(data, name=f"{self.name}.{key}")
+
+        return data
+
+    def pop_item(self, key, *deflt, prnt=True):
+        """
+        Pops an item, prints readable error if not found
+
+        Parameters
+        ----------
+        key: immutable object
+            The key
+        deflt: tuple, optional
+            Tuple of length 1, containing the default
+        prnt: bool
+            Flag for message printing
+
+        Returns
+        -------
+        data: object
+            The data
+
+        """
+        data = self.get_item(key, *deflt, prnt=prnt)
+        if key in self:
+            del self[key]
+        return data
+
     def __getitem__(self, key):
         try:
             return super().__getitem__(key)
@@ -58,3 +128,37 @@ class Dict(dict):
             k = ", ".join(sorted([f"{s}" for s in self.keys()]))
             e = f"{self.name}: Cannot find key '{key}'. Known keys: {k}"
             raise KeyError(e)
+
+    @classmethod
+    def from_yaml(self, yml_file, verbosity=1):
+        """
+        Reads a yaml file
+
+        Parameters
+        ----------
+        yml_file: str
+            Path to the yaml file
+        verbosity: int
+            The verbosity level, 0 = silent
+
+        Returns
+        -------
+        dct: Dict
+            The data
+
+        """
+
+        def _print(*args, level=1, **kwargs):
+            if verbosity >= level:
+                print(*args, **kwargs)
+
+        fpath = Path(yml_file)
+        _print("Reading file", fpath)
+        with open(fpath) as stream:
+            data = safe_load(stream)
+        if data is None:
+            data = {}
+        dct = Dict(data, name=fpath.stem)
+        _print(dct, level=2)
+
+        return dct

foxes/utils/geopandas_utils.py

@@ -1,7 +1,8 @@
 import numpy as np
 import argparse
 
-import foxes.constants as FC
+from foxes.config import config
+
 from .dict import Dict
 from .geom2d import AreaUnion, ClosedPolygon
 
@@ -212,7 +213,7 @@ def read_shp_polygons(
                 if not len(data):
                     return []
                 if isinstance(data[0], tuple):
-                    out = np.array(data, dtype=FC.DTYPE)
+                    out = np.array(data, dtype=config.dtype_double)
                     return _to_utm(out) if apply_utm else out
                 return [_to_numpy(d) for d in data]
 

foxes/utils/subclasses.py

@@ -19,3 +19,72 @@ def all_subclasses(cls):
     return set(cls.__subclasses__()).union(
         [s for c in cls.__subclasses__() for s in all_subclasses(c)]
     )
+
+
+def new_cls(base_cls, cls_name):
+    """
+    Run-time class selector.
+
+    Parameters
+    ----------
+    base_cls: object
+        The base class
+    cls_name: string
+        Name of the class
+
+    Returns
+    -------
+    cls: object
+        The derived class
+
+    :group: utils
+
+    """
+
+    if cls_name is None:
+        return None
+
+    allc = all_subclasses(base_cls)
+    found = cls_name in [scls.__name__ for scls in allc]
+
+    if found:
+        for scls in allc:
+            if scls.__name__ == cls_name:
+                return scls
+
+    else:
+        estr = "Class '{}' not found, available classes derived from '{}' are \n {}".format(
+            cls_name, base_cls.__name__, sorted([i.__name__ for i in allc])
+        )
+        raise KeyError(estr)
+
+
+def new_instance(base_cls, cls_name, *args, **kwargs):
+    """
+    Run-time factory.
+
+    Parameters
+    ----------
+    base_cls: object
+        The base class
+    cls_name: string
+        Name of the class
+    args: tuple, optional
+        Additional parameters for the constructor
+    kwargs: dict, optional
+        Additional parameters for the constructor
+
+    Returns
+    -------
+    obj: object
+        The instance of the derived class
+
+    :group: utils
+
+    """
+
+    cls = new_cls(base_cls, cls_name)
+    if cls is None:
+        return None
+    else:
+        return cls(*args, **kwargs)

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foxes
-Version: 1.1.1
+Version: 1.2.1
 Summary: Farm Optimization and eXtended yield Evaluation Software
 Author: Jonas Schulte
 Maintainer: Jonas Schulte
@@ -54,29 +54,16 @@ Requires-Dist: pandas
 Requires-Dist: xarray
 Requires-Dist: scipy
 Requires-Dist: netcdf4
-Requires-Dist: windrose
 Requires-Dist: cycler
 Requires-Dist: tqdm
 Requires-Dist: pyyaml
+Provides-Extra: opt
+Requires-Dist: foxes-opt; 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: dev
-Requires-Dist: flake8; extra == "dev"
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: jupyter; extra == "dev"
-Requires-Dist: objsize; extra == "dev"
-Requires-Dist: black[jupyter]; extra == "dev"
-Provides-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"
 Provides-Extra: eng
 Requires-Dist: multiprocess; extra == "eng"
 Requires-Dist: dask; extra == "eng"
@@ -92,11 +79,23 @@ Requires-Dist: distributed; extra == "eng0"
 Requires-Dist: dask-jobqueue; extra == "eng0"
 Requires-Dist: setuptools; extra == "eng0"
 Requires-Dist: ray; extra == "eng0"
-Provides-Extra: opt
-Requires-Dist: foxes-opt; extra == "opt"
 Provides-Extra: test
 Requires-Dist: flake8; extra == "test"
 Requires-Dist: pytest; extra == "test"
+Provides-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"
+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: black[jupyter]; extra == "dev"
 
 # Welcome to foxes
 
@@ -163,6 +162,7 @@ The supported Python versions are:
 - `Python 3.10`
 - `Python 3.11`
 - `Python 3.12`
+- `Python 3.13`
 
 ## Installation