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

foxes/output/__init__.py

@@ -2,24 +2,26 @@
 Output tools and functions.
 """
 
-from .round import round_defaults
-from .output import Output
-from .farm_layout import FarmLayoutOutput
-from .farm_results_eval import FarmResultsEval
-from .rose_plot import RosePlotOutput, StatesRosePlotOutput, WindRoseBinPlot
-from .results_writer import ResultsWriter
-from .state_turbine_map import StateTurbineMap
-from .turbine_type_curves import TurbineTypeCurves
-from .animation import Animator
-from .calc_points import PointCalculator
-from .slice_data import SliceData
-from .slices_data import SlicesData
-from .rotor_point_plots import RotorPointPlot
-from .state_turbine_table import StateTurbineTable
-from .plt import plt
+from .output import Output as Output
+from .farm_layout import FarmLayoutOutput as FarmLayoutOutput
+from .farm_results_eval import FarmResultsEval as FarmResultsEval
+from .rose_plot import RosePlotOutput as RosePlotOutput
+from .rose_plot import StatesRosePlotOutput as StatesRosePlotOutput
+from .rose_plot import WindRoseBinPlot as WindRoseBinPlot
+from .results_writer import ResultsWriter as ResultsWriter
+from .state_turbine_map import StateTurbineMap as StateTurbineMap
+from .turbine_type_curves import TurbineTypeCurves as TurbineTypeCurves
+from .animation import Animator as Animator
+from .calc_points import PointCalculator as PointCalculator
+from .slice_data import SliceData as SliceData
+from .slices_data import SlicesData as SlicesData
+from .rotor_point_plots import RotorPointPlot as RotorPointPlot
+from .state_turbine_table import StateTurbineTable as StateTurbineTable
+from .plt import plt as plt
 
-from .flow_plots_2d import FlowPlots2D
-from .seq_plugins import SeqFlowAnimationPlugin, SeqWakeDebugPlugin
+from .flow_plots_2d import FlowPlots2D as FlowPlots2D
+from .seq_plugins import SeqFlowAnimationPlugin as SeqFlowAnimationPlugin
+from .seq_plugins import SeqWakeDebugPlugin as SeqWakeDebugPlugin
 
-from . import grids
-from . import seq_plugins
+from . import grids as grids
+from . import seq_plugins as seq_plugins

foxes/output/farm_layout.py

@@ -67,10 +67,10 @@ class FarmLayoutOutput(Output):
         self.D = D
 
         if from_results and farm_results is None:
-            raise ValueError(f"Missing farm_results for switch from_results.")
+            raise ValueError("Missing farm_results for switch from_results.")
 
         if from_results and results_state is None:
-            raise ValueError(f"Please specify results_state for switch from_results.")
+            raise ValueError("Please specify results_state for switch from_results.")
 
     def get_layout_data(self):
         """
@@ -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):
@@ -66,9 +69,9 @@ class FarmResultsEval(Output):
             if isinstance(v, str):
                 vdata = self.results[v].to_numpy()
                 nns = np.sum(np.isnan(vdata))
-                assert (
-                    nns == 0
-                ), f"Found {nns} nan values for variable '{v}' of shape {vdata.shape}"
+                assert nns == 0, (
+                    f"Found {nns} nan values for variable '{v}' of shape {vdata.shape}"
+                )
                 fields.append(vdata)
             else:
                 fields.append(v)
@@ -142,9 +145,9 @@ class FarmResultsEval(Output):
         for v, op in vars_op.items():
             vdata = self.results[v].to_numpy()
             nns = np.sum(np.isnan(vdata))
-            assert (
-                nns == 0
-            ), f"Found {nns} nan values for variable '{v}' of shape {vdata.shape}"
+            assert nns == 0, (
+                f"Found {nns} nan values for variable '{v}' of shape {vdata.shape}"
+            )
 
             if op == "weights":
                 rdata[v] = self.weinsum("t", vdata)
@@ -191,9 +194,9 @@ class FarmResultsEval(Output):
         for v, op in vars_op.items():
             vdata = self.results[v].to_numpy()
             nns = np.sum(np.isnan(vdata))
-            assert (
-                nns == 0
-            ), f"Found {nns} nan values for variable '{v}' of shape {vdata.shape}"
+            assert nns == 0, (
+                f"Found {nns} nan values for variable '{v}' of shape {vdata.shape}"
+            )
 
             if op == "weights":
                 rdata[v] = self.weinsum("s", vdata)
@@ -244,9 +247,9 @@ class FarmResultsEval(Output):
         for v, op in turbines_op.items():
             vdata = sdata[v].to_numpy()
             nns = np.sum(np.isnan(vdata))
-            assert (
-                nns == 0
-            ), f"Found {nns} nan values for variable '{v}' of shape {vdata.shape}"
+            assert nns == 0, (
+                f"Found {nns} nan values for variable '{v}' of shape {vdata.shape}"
+            )
 
             if op == "weights":
                 if states_op[v] == "weights":
@@ -471,11 +474,11 @@ class FarmResultsEval(Output):
             duration = times[-1] - times[0] + delta_t
             duration_seconds = np.int64(duration.astype(np.int64) / 1e9)
             duration_hours = duration_seconds / 3600
-        elif hours is None and annual == True:
+        elif hours is None and annual:
             duration_hours = 8760
         elif hours is None:
             raise ValueError(
-                f"Expecting parameter 'hours' for non-timeseries data, or 'annual=True'"
+                "Expecting parameter 'hours' for non-timeseries data, or 'annual=True'"
             )
         else:
             duration_hours = hours
@@ -654,7 +657,7 @@ class FarmResultsEval(Output):
         else:
             hax = ax
 
-        hax.set_xlabel(f"State")
+        hax.set_xlabel("State")
         hax.set_ylabel(variable)
         cc = cycler(color="bgrcmyk")
 

foxes/output/flow_plots_2d/__init__.py

@@ -1,2 +1,2 @@
-from .flow_plots import FlowPlots2D
-from .get_fig import get_fig
+from .flow_plots import FlowPlots2D as FlowPlots2D
+from .get_fig import get_fig as get_fig

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)
@@ -181,6 +182,7 @@ def get_fig(
         hax.invert_yaxis()
 
     # add rotor position:
+    imr = []
     if show_rotor_dict is not None:
         D = show_rotor_dict["D"]
         coords = np.zeros(shape=(2, len(D)))  # array to hold change to turbine coords
@@ -211,12 +213,13 @@ def get_fig(
             turb_x2 = x[t] - coords[0, t]
             turb_y1 = y[t] + coords[1, t]
             turb_y2 = y[t] - coords[1, t]
-            hax.plot(
+            imr += hax.plot(
                 [turb_x1, turb_x2],
                 [turb_y1, turb_y2],
                 color=c,
                 linestyle="-",
                 linewidth=1,
+                animated=animated,
             )
 
     if add_bar:
@@ -233,7 +236,7 @@ def get_fig(
     if ret_state:
         out.append(si)
     if ret_im:
-        out.append([i for i in [im, qv, ttl] if i is not None])
+        out.append([i for i in [im, qv, ttl] if i is not None] + imr)
     if ret_state or ret_im:
         out = tuple(out)
 

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

@@ -1,7 +1,6 @@
 import numpy as np
 import matplotlib.pyplot as plt
 from xarray import Dataset
-from matplotlib.cm import ScalarMappable
 from matplotlib.projections.polar import PolarAxes
 from matplotlib.lines import Line2D
 
@@ -58,7 +57,7 @@ class RosePlotOutput(Output):
             self.results = farm_results
             self._rtype = FC.TURBINE
         else:
-            raise KeyError(f"Require either farm_results or point_results")
+            raise KeyError("Require either farm_results or point_results")
 
     @classmethod
     def get_data_info(cls, dname):
@@ -251,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]
@@ -296,7 +298,8 @@ class RosePlotOutput(Output):
 
         llines = [Line2D([0], [0], color=c, lw=10) for c in np.flip(color_list, axis=0)]
         lleg = [
-            f"[{ws_bins[i]:.1f}, {ws_bins[i+1]:.1f})" for i in range(n_wsb - 1, -1, -1)
+            f"[{ws_bins[i]:.1f}, {ws_bins[i + 1]:.1f})"
+            for i in range(n_wsb - 1, -1, -1)
         ]
         lpars = dict(
             loc="upper left",
@@ -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/seq_plugins/__init__.py

@@ -1,2 +1,2 @@
-from .seq_flow_ani_plugin import SeqFlowAnimationPlugin
-from .seq_wake_debug_plugin import SeqWakeDebugPlugin
+from .seq_flow_ani_plugin import SeqFlowAnimationPlugin as SeqFlowAnimationPlugin
+from .seq_wake_debug_plugin import SeqWakeDebugPlugin as SeqWakeDebugPlugin

foxes/output/seq_plugins/seq_flow_ani_plugin.py

@@ -1,5 +1,3 @@
-from copy import deepcopy
-
 from foxes.algorithms.sequential import SequentialPlugin
 
 from ..flow_plots_2d.flow_plots import FlowPlots2D
@@ -116,7 +114,6 @@ class SeqFlowAnimationPlugin(SequentialPlugin):
         fig = ax.get_figure()
         gdata = None
         while len(self._data):
-
             fres, d = self._data.pop(0)
 
             if d[2] is not None:

foxes/output/seq_plugins/seq_wake_debug_plugin.py

@@ -109,7 +109,6 @@ class SeqWakeDebugPlugin(SequentialPlugin):
 
         """
         while len(self._data):
-
             dt, pts, v = self._data.pop(0)
 
             N = len(pts)

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

@@ -1,4 +1,3 @@
-from tabnanny import verbose
 import matplotlib.pyplot as plt
 import numpy as np
 import pandas as pd
@@ -106,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]
@@ -182,19 +184,19 @@ class TurbineTypeCurves(Output):
             t = f"{vv}, {turbine_type}" if titles[i] is None else titles[i]
             ax.set_title(t)
 
-            l = "Wind speed [m/s]" if x_label is None else x_label
-            ax.set_xlabel(l)
+            lb = "Wind speed [m/s]" if x_label is None else x_label
+            ax.set_xlabel(lb)
 
             if y_labels[i] is None:
                 if v == FV.P:
-                    l = f"Power [kW]"
+                    lb = "Power [kW]"
                 elif v == FV.CT:
-                    l = "ct [-]"
+                    lb = "ct [-]"
                 else:
-                    l = v
+                    lb = v
             else:
-                l = y_labels[i]
-            ax.set_ylabel(l)
+                lb = y_labels[i]
+            ax.set_ylabel(lb)
 
             ax.grid()
 

foxes/utils/__init__.py

@@ -2,23 +2,41 @@
 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, new_cls, new_instance
-from .dict import Dict
-from .factory import Factory, FDict, WakeKFactory
-from .data_book import DataBook
-from .cubic_roots import cubic_roots
-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 .tab_files import read_tab_file
-from .random_xy import random_xy_square
-from .dev_utils import print_mem
-from .wrg_utils import ReaderWRG
+from .wind_dir import wd2uv as wd2uv
+from .wind_dir import wd2wdvec as wd2wdvec
+from .wind_dir import wdvec2wd as wdvec2wd
+from .wind_dir import uv2wd as uv2wd
+from .wind_dir import delta_wd as delta_wd
 
-from . import two_circles
-from . import abl
-from . import geom2d
+from .subclasses import all_subclasses as all_subclasses
+from .subclasses import new_cls as new_cls
+from .subclasses import new_instance as new_instance
+
+from .factory import Factory as Factory
+from .factory import FDict as FDict
+from .factory import WakeKFactory as WakeKFactory
+
+from .geopandas_utils import read_shp as read_shp
+from .geopandas_utils import shp2csv as shp2csv
+from .geopandas_utils import read_shp_polygons as read_shp_polygons
+from .geopandas_utils import shp2geom2d as shp2geom2d
+
+from .load import import_module as import_module
+from .load import load_module as load_module
+
+from .pandas_utils import PandasFileHelper as PandasFileHelper
+from .xarray_utils import write_nc as write_nc
+from .dict import Dict as Dict
+from .data_book import DataBook as DataBook
+from .cubic_roots import cubic_roots as cubic_roots
+from .exec_python import exec_python as exec_python
+from .regularize import sqrt_reg as sqrt_reg
+from .tab_files import read_tab_file as read_tab_file
+from .random_xy import random_xy_square as random_xy_square
+from .dev_utils import print_mem as print_mem
+from .wrg_utils import ReaderWRG as ReaderWRG
+from .weibull import weibull_weights as weibull_weights
+
+from . import two_circles as two_circles
+from . import abl as abl
+from . import geom2d as geom2d

foxes/utils/abl/__init__.py

@@ -2,7 +2,7 @@
 Atmospheric boundary layer functions.
 """
 
-from . import neutral
-from . import stable
-from . import unstable
-from . import sheared
+from . import neutral as neutral
+from . import stable as stable
+from . import unstable as unstable
+from . import sheared as sheared

foxes/utils/cubic_roots.py

@@ -104,7 +104,7 @@ def test_cubic_roots(roots, a0, a1, a2, a3=None, tol=1.0e-12):
         c2 = a2[n]
         c3 = a3[n]
 
-        print(f"Polynomial {n}: a = {(c0,c1,c2,c3)}")
+        print(f"Polynomial {n}: a = {(c0, c1, c2, c3)}")
 
         rts = np.unique(roots[n])
         rts = rts[~np.isnan(rts)]

foxes/utils/data_book.py

@@ -66,9 +66,10 @@ class DataBook:
         except AttributeError:
             contents = list(resources.contents(package))
 
-        check_f = lambda f: any(
-            [len(f) > len(s) and f[-len(s) :] == s for s in file_sfx]
-        )
+        def check_f(f):
+            """little helper function to check file endings"""
+            return any([len(f) > len(s) and f[-len(s) :] == s for s in file_sfx])
+
         contents = [f for f in contents if check_f(f)]
 
         try: