foxes 1.2.2__py3-none-any.whl → 1.2.4__py3-none-any.whl

foxes/models/point_models/ustar2ti.py

@@ -0,0 +1,84 @@
+import numpy as np
+from foxes.core import PointDataModel
+import foxes.variables as FV
+import foxes.constants as FC
+
+
+class Ustar2TI(PointDataModel):
+    """
+    Calculates TI from Ustar, using TI = Ustar / (kappa*WS)
+
+    Attributes
+    ----------
+    max_ti: float
+        Upper limit of the computed TI values
+
+    :group: models.point_models
+
+    """
+
+    def __init__(self, max_ti=None, **kwargs):
+        """
+        Constructor
+
+        Parameters
+        ----------
+        max_ti: float, optional
+            Upper limit of the computed TI values
+        kwargs: dict, optional
+            Additional parameters for the base class
+
+        """
+        super().__init__(**kwargs)
+        self.max_ti = max_ti
+
+    def output_point_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 [FV.TI]
+
+    def calculate(self, algo, mdata, fdata, pdata):
+        """
+        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
+        tdata: foxes.core.TData
+            The target point data
+
+        Returns
+        -------
+        results: dict
+            The resulting data, keys: output variable str.
+            Values: numpy.ndarray with shape (n_states, n_points)
+
+        """
+        ustar = pdata[FV.USTAR]
+        ws = pdata[FV.WS]
+
+        ti = (ustar / FC.KAPPA) / ws
+        if self.max_ti is not None:
+            ti = np.maximum(ti, self.max_ti)
+
+        return {FV.TI: ti}

foxes/models/turbine_models/lookup_table.py

@@ -4,7 +4,7 @@ import xarray as xr
 
 from foxes.core import TurbineModel
 from foxes.utils import PandasFileHelper
-from foxes.config import config, get_path
+from foxes.config import config, get_input_path
 import foxes.constants as FC
 
 
@@ -128,7 +128,7 @@ class LookupTable(TurbineModel):
             if isinstance(self.data_source, pd.DataFrame):
                 data = self.data_source
             else:
-                fpath = get_path(self.data_source)
+                fpath = get_input_path(self.data_source)
                 if verbosity > 0:
                     print(f"{self.name}: Reading file {fpath}")
                 data = PandasFileHelper.read_file(fpath, **self._rpars)

foxes/models/turbine_models/sector_management.py

@@ -3,7 +3,7 @@ import pandas as pd
 
 from foxes.core import TurbineModel
 from foxes.utils import PandasFileHelper
-from foxes.config import get_path
+from foxes.config import get_input_path
 import foxes.variables as FV
 import foxes.constants as FC
 
@@ -91,7 +91,7 @@ class SectorManagement(TurbineModel):
         if isinstance(self.source, pd.DataFrame):
             data = self.source
         else:
-            fpath = get_path(self.source)
+            fpath = get_input_path(self.source)
             if verbosity > 0:
                 print(f"{self.name}: Reading file {fpath}")
             data = PandasFileHelper.read_file(fpath, **self._rpars)

foxes/models/turbine_models/table_factors.py

@@ -4,7 +4,7 @@ from scipy.interpolate import interpn
 
 from foxes.core import TurbineModel
 from foxes.utils import PandasFileHelper
-from foxes.config import config, get_path
+from foxes.config import config, get_input_path
 
 
 class TableFactors(TurbineModel):
@@ -106,7 +106,7 @@ class TableFactors(TurbineModel):
         if isinstance(self.data_source, pd.DataFrame):
             self._data = self.data_source
         else:
-            fpath = get_path(self.data_source)
+            fpath = get_input_path(self.data_source)
             if verbosity > 0:
                 print(f"{self.name}: Reading file {fpath}")
             rpars = dict(index_col=0)

foxes/models/turbine_types/CpCt_file.py

@@ -3,7 +3,7 @@ import pandas as pd
 
 from foxes.data import parse_Pct_file_name
 from foxes.utils import PandasFileHelper
-from foxes.config import config, get_path
+from foxes.config import config, get_input_path
 import foxes.constants as FC
 
 from .PCt_file import PCtFile
@@ -49,7 +49,7 @@ class CpCtFile(PCtFile):
         if not isinstance(data_source, pd.DataFrame):
             pars = parse_Pct_file_name(data_source)
             pars.update(parameters)
-            fpath = get_path(data_source)
+            fpath = get_input_path(data_source)
             data = PandasFileHelper.read_file(fpath, **pd_file_read_pars)
         else:
             data = data_source

foxes/models/turbine_types/CpCt_from_two.py

@@ -4,7 +4,7 @@ import pandas as pd
 from .PCt_from_two import PCtFromTwo
 from foxes.data import parse_Pct_two_files
 from foxes.utils import PandasFileHelper
-from foxes.config import config, get_path
+from foxes.config import config, get_input_path
 import foxes.constants as FC
 
 
@@ -56,8 +56,8 @@ class CpCtFromTwo(PCtFromTwo):
             data_source_ct, pd.DataFrame
         ):
             pars = parse_Pct_two_files(data_source_cp, data_source_ct)
-            path_cp = get_path(data_source_cp)
-            path_ct = get_path(data_source_ct)
+            path_cp = get_input_path(data_source_cp)
+            path_ct = get_input_path(data_source_ct)
             data_cp = PandasFileHelper.read_file(path_cp, **pd_file_read_pars_cp)
             data_ct = PandasFileHelper.read_file(path_ct, **pd_file_read_pars_ct)
         else:

foxes/models/turbine_types/PCt_file.py

@@ -5,7 +5,7 @@ from pathlib import Path
 from foxes.core import TurbineType
 from foxes.utils import PandasFileHelper
 from foxes.data import PCTCURVE, parse_Pct_file_name
-from foxes.config import get_path
+from foxes.config import get_input_path
 import foxes.variables as FV
 import foxes.constants as FC
 
@@ -174,7 +174,7 @@ class PCtFile(TurbineType):
         if isinstance(self.source, pd.DataFrame):
             data = self.source
         else:
-            fpath = get_path(self.source)
+            fpath = get_input_path(self.source)
             if not fpath.is_file():
                 if verbosity > 0:
                     print(

foxes/models/turbine_types/PCt_from_two.py

@@ -4,7 +4,7 @@ import pandas as pd
 from foxes.core import TurbineType
 from foxes.utils import PandasFileHelper
 from foxes.data import PCTCURVE, parse_Pct_two_files
-from foxes.config import get_path
+from foxes.config import get_input_path
 import foxes.variables as FV
 import foxes.constants as FC
 
@@ -195,7 +195,7 @@ class PCtFromTwo(TurbineType):
         if isinstance(self.source_P, pd.DataFrame):
             self._data_P = self.source_P
         else:
-            fpath = get_path(self.source_P)
+            fpath = get_input_path(self.source_P)
             if not fpath.is_file():
                 fpath = algo.dbook.get_file_path(
                     PCTCURVE, self.source_P, check_raw=False
@@ -210,7 +210,7 @@ class PCtFromTwo(TurbineType):
         if isinstance(self.source_ct, pd.DataFrame):
             self._data_ct = self.source_ct
         else:
-            fpath = get_path(self.source_ct)
+            fpath = get_input_path(self.source_ct)
             if not fpath.is_file():
                 fpath = algo.dbook.get_file_path(
                     PCTCURVE, self.source_ct, check_raw=False

foxes/models/turbine_types/TBL_file.py

@@ -1,7 +1,7 @@
 import numpy as np
 import pandas as pd
 
-from foxes.config import get_path
+from foxes.config import get_input_path
 
 from .PCt_file import PCtFile
 
@@ -57,7 +57,7 @@ class TBLFile(PCtFile):
             Additional parameters for PCtFile class
 
         """
-        fpath = get_path(tbl_file)
+        fpath = get_input_path(tbl_file)
         assert fpath.suffix == ".tbl", f"Expecting *.tbl file, got '{tbl_file}'"
 
         meta = np.genfromtxt(fpath, skip_header=1, max_rows=1)

foxes/models/turbine_types/wsrho2PCt_from_two.py

@@ -5,7 +5,7 @@ from scipy.interpolate import interpn
 from foxes.core import TurbineType
 from foxes.utils import PandasFileHelper
 from foxes.data import PCTCURVE, parse_Pct_two_files
-from foxes.config import config, get_path
+from foxes.config import config, get_input_path
 import foxes.variables as FV
 
 
@@ -183,7 +183,7 @@ class WsRho2PCtFromTwo(TurbineType):
         if isinstance(self.source_P, pd.DataFrame):
             data = self.source_P
         else:
-            fpath = get_path(self.source_P)
+            fpath = get_input_path(self.source_P)
             if not fpath.is_file():
                 fpath = algo.dbook.get_file_path(
                     PCTCURVE, self.source_P, check_raw=False
@@ -202,7 +202,7 @@ class WsRho2PCtFromTwo(TurbineType):
         if isinstance(self.source_ct, pd.DataFrame):
             data = self.source_ct
         else:
-            fpath = get_path(self.source_ct)
+            fpath = get_input_path(self.source_ct)
             if not fpath.is_file():
                 fpath = algo.dbook.get_file_path(
                     PCTCURVE, self.source_ct, check_raw=False

foxes/models/turbine_types/wsti2PCt_from_two.py

@@ -6,7 +6,7 @@ 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_path
+from foxes.config import config, get_input_path
 
 
 class WsTI2PCtFromTwo(TurbineType):
@@ -195,7 +195,7 @@ class WsTI2PCtFromTwo(TurbineType):
         if isinstance(self.source_P, pd.DataFrame):
             data = self.source_P
         else:
-            fpath = get_path(self.source_P)
+            fpath = get_input_path(self.source_P)
             if not fpath.is_file():
                 fpath = algo.dbook.get_file_path(
                     PCTCURVE, self.source_P, check_raw=False
@@ -214,7 +214,7 @@ class WsTI2PCtFromTwo(TurbineType):
         if isinstance(self.source_ct, pd.DataFrame):
             data = self.source_ct
         else:
-            fpath = get_path(self.source_ct)
+            fpath = get_input_path(self.source_ct)
             if not fpath.is_file():
                 fpath = algo.dbook.get_file_path(
                     PCTCURVE, self.source_ct, check_raw=False

foxes/output/__init__.py

@@ -13,6 +13,7 @@ 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

foxes/output/output.py

@@ -1,6 +1,6 @@
 from pathlib import Path
 
-from foxes.config import config, get_path
+from foxes.config import config, get_output_path
 from foxes.utils import PandasFileHelper, new_instance, all_subclasses
 
 
@@ -34,7 +34,9 @@ class Output:
             Modifies file names by f(fname)
 
         """
-        self.out_dir = get_path(out_dir) if out_dir is not None else config.out_dir
+        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
 
         if not self.out_dir.is_dir():
@@ -59,7 +61,7 @@ class Output:
         fnm = Path(fname)
         if self.out_fname_fun is not None:
             fnm = self.out_fname_fun(fnm)
-        return self.out_dir / fnm if self.out_dir is not None else get_path(fnm)
+        return self.out_dir / fnm if self.out_dir is not None else get_output_path(fnm)
 
     def write(self, file_name, data, format_col2var={}, format_dict={}, **kwargs):
         """

foxes/output/slice_data.py

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

foxes/output/slices_data.py

@@ -0,0 +1,323 @@
+import xarray as xr
+import pandas as pd
+
+import foxes.constants as FC
+
+from .output import Output
+from .slice_data import SliceData
+
+
+class SlicesData(Output):
+    """
+    Create data for horizontal or vertical 2D slices, all in a
+    single Dataset
+
+    :group: output
+
+    """
+
+    def __init__(
+        self,
+        algo,
+        farm_results,
+        verbosity_delta=1,
+        **kwargs,
+    ):
+        """
+        Constructor.
+
+        Parameters
+        ----------
+        algo: foxes.Algorithm
+            The algorithm for point calculation
+        farm_results: xarray.Dataset
+            The farm results
+        verbosity_delta: int
+            Verbosity threshold for printing calculation info
+        kwargs: dict, optional
+            Additional parameters for the Output class
+
+        """
+        super().__init__(**kwargs)
+        self._slice_data = SliceData(
+            algo=algo,
+            farm_results=farm_results,
+            verbosity_delta=verbosity_delta,
+            **kwargs,
+        )
+
+    def get_mean_data_xy(
+        self,
+        z_list,
+        *args,
+        verbosity=0,
+        **kwargs,
+    ):
+        """
+        Creates mean data of 2D farm flow slices in a xy-plane.
+
+        Parameters
+        ----------
+        z_list: list of float
+            The z values
+        args: tuple, optional
+            Arguments for the SliceData function of the same name
+        verbosity: int, optional
+            The verbosity level, 0 = silent
+        kwargs: dict, optional
+            Arguments for the SliceData function of the same name
+
+        Returns
+        -------
+        data: xarray.Dataset
+            The gridded data
+
+        """
+        dsl = []
+        for z in z_list:
+            if verbosity > 0:
+                print(f"{type(self).__name__}: Creating slice z = {z}")
+            dsl.append(
+                self._slice_data.get_mean_data_xy(
+                    *args,
+                    z=z,
+                    data_format="xarray",
+                    ret_states=False,
+                    ret_grid=False,
+                    verbosity=verbosity,
+                    **kwargs,
+                )
+            )
+        out = xr.concat(dsl, pd.Index(z_list, name="z"))
+        del out.attrs["z"]
+        return out
+
+    def get_mean_data_xz(
+        self,
+        y_list,
+        *args,
+        verbosity=0,
+        **kwargs,
+    ):
+        """
+        Creates mean data of 2D farm flow slices in a xz-plane.
+
+        Parameters
+        ----------
+        y_list: list of float
+            The y values
+        args: tuple, optional
+            Arguments for the SliceData function of the same name
+        verbosity: int, optional
+            The verbosity level, 0 = silent
+        kwargs: dict, optional
+            Arguments for the SliceData function of the same name
+
+        Returns
+        -------
+        data: xarray.Dataset
+            The gridded data
+
+        """
+        dsl = []
+        for y in y_list:
+            if verbosity > 0:
+                print(f"{type(self).__name__}: Creating slice y = {y}")
+            dsl.append(
+                self._slice_data.get_mean_data_xz(
+                    *args,
+                    y=y,
+                    data_format="xarray",
+                    ret_states=False,
+                    ret_grid=False,
+                    verbosity=verbosity,
+                    **kwargs,
+                )
+            )
+        out = xr.concat(dsl, pd.Index(y_list, name="y"))
+        del out.attrs["y"]
+        return out
+
+    def get_mean_data_yz(
+        self,
+        x_list,
+        *args,
+        verbosity=0,
+        **kwargs,
+    ):
+        """
+        Creates mean data of 2D farm flow slices in a yz-plane.
+
+        Parameters
+        ----------
+        x_list: list of float
+            The x values
+        args: tuple, optional
+            Arguments for the SliceData function of the same name
+        verbosity: int, optional
+            The verbosity level, 0 = silent
+        kwargs: dict, optional
+            Arguments for the SliceData function of the same name
+
+        Returns
+        -------
+        data: xarray.Dataset
+            The gridded data
+
+        """
+        dsl = []
+        for x in x_list:
+            if verbosity > 0:
+                print(f"{type(self).__name__}: Creating slice x = {x}")
+            dsl.append(
+                self._slice_data.get_mean_data_yz(
+                    *args,
+                    x=x,
+                    data_format="xarray",
+                    ret_states=False,
+                    ret_grid=False,
+                    verbosity=verbosity,
+                    **kwargs,
+                )
+            )
+        out = xr.concat(dsl, pd.Index(x_list, name="x"))
+        del out.attrs["x"]
+        return out
+
+    def get_states_data_xy(
+        self,
+        z_list,
+        *args,
+        verbosity=0,
+        **kwargs,
+    ):
+        """
+        Creates states data of 2D farm flow slices in a xy-plane.
+
+        Parameters
+        ----------
+        z_list: list of float
+            The z values
+        args: tuple, optional
+            Arguments for the SliceData function of the same name
+        verbosity: int, optional
+            The verbosity level, 0 = silent
+        kwargs: dict, optional
+            Arguments for the SliceData function of the same name
+
+        Returns
+        -------
+        data: xarray.Dataset
+            The gridded data
+
+        """
+        dsl = []
+        for z in z_list:
+            if verbosity > 0:
+                print(f"{type(self).__name__}: Creating slice z = {z}")
+            dsl.append(
+                self._slice_data.get_states_data_xy(
+                    *args,
+                    z=z,
+                    data_format="xarray",
+                    ret_states=False,
+                    ret_grid=False,
+                    verbosity=verbosity,
+                    **kwargs,
+                )
+            )
+        out = xr.concat(dsl, pd.Index(z_list, name="z"))
+        del out.attrs["z"]
+        return out.transpose(FC.STATE, "z", ...)
+
+    def get_states_data_xz(
+        self,
+        y_list,
+        *args,
+        verbosity=0,
+        **kwargs,
+    ):
+        """
+        Creates states data of 2D farm flow slices in a xz-plane.
+
+        Parameters
+        ----------
+        y_list: list of float
+            The y values
+        args: tuple, optional
+            Arguments for the SliceData function of the same name
+        verbosity: int, optional
+            The verbosity level, 0 = silent
+        kwargs: dict, optional
+            Arguments for the SliceData function of the same name
+
+        Returns
+        -------
+        data: xarray.Dataset
+            The gridded data
+
+        """
+        dsl = []
+        for y in y_list:
+            if verbosity > 0:
+                print(f"{type(self).__name__}: Creating slice y = {y}")
+            dsl.append(
+                self._slice_data.get_states_data_xz(
+                    *args,
+                    y=y,
+                    data_format="xarray",
+                    ret_states=False,
+                    ret_grid=False,
+                    verbosity=verbosity,
+                    **kwargs,
+                )
+            )
+        out = xr.concat(dsl, pd.Index(y_list, name="y"))
+        del out.attrs["y"]
+        return out.transpose(FC.STATE, "z", "y", ...)
+
+    def get_states_data_yz(
+        self,
+        x_list,
+        *args,
+        verbosity=0,
+        **kwargs,
+    ):
+        """
+        Creates states data of 2D farm flow slices in a yz-plane.
+
+        Parameters
+        ----------
+        x_list: list of float
+            The x values
+        args: tuple, optional
+            Arguments for the SliceData function of the same name
+        verbosity: int, optional
+            The verbosity level, 0 = silent
+        kwargs: dict, optional
+            Arguments for the SliceData function of the same name
+
+        Returns
+        -------
+        data: xarray.Dataset
+            The gridded data
+
+        """
+        dsl = []
+        for x in x_list:
+            if verbosity > 0:
+                print(f"{type(self).__name__}: Creating slice x = {x}")
+            dsl.append(
+                self._slice_data.get_states_data_yz(
+                    *args,
+                    x=x,
+                    data_format="xarray",
+                    ret_states=False,
+                    ret_grid=False,
+                    verbosity=verbosity,
+                    **kwargs,
+                )
+            )
+        out = xr.concat(dsl, pd.Index(x_list, name="x"))
+        del out.attrs["x"]
+        return out.transpose(FC.STATE, "z", "y", "x", ...)