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

foxes/input/states/multi_height.py

@@ -200,14 +200,14 @@ class MultiHeightStates(States):
         if not isinstance(self.data_source, pd.DataFrame):
             self._data_source = get_input_path(self.data_source)
             if not self.data_source.is_file():
-                if verbosity:
+                if verbosity > 0:
                     print(
                         f"States '{self.name}': Reading static data '{self.data_source}' from context '{STATES}'"
                     )
                 self._data_source = algo.dbook.get_file_path(
                     STATES, self.data_source.name, check_raw=False
                 )
-                if verbosity:
+                if verbosity > 0:
                     print(f"Path: {self.data_source}")
             elif verbosity:
                 print(f"States '{self.name}': Reading file {self.data_source}")
@@ -627,14 +627,14 @@ class MultiHeightNCStates(MultiHeightStates):
         if not isinstance(self.data_source, Dataset):
             self._data_source = get_input_path(self.data_source)
             if not self.data_source.is_file():
-                if verbosity:
+                if verbosity > 0:
                     print(
                         f"States '{self.name}': Reading static data '{self.data_source}' from context '{STATES}'"
                     )
                 self._data_source = algo.dbook.get_file_path(
                     STATES, self.data_source.name, check_raw=False
                 )
-                if verbosity:
+                if verbosity > 0:
                     print(f"Path: {self.data_source}")
             elif verbosity:
                 print(f"States '{self.name}': Reading file {self.data_source}")

foxes/input/states/states_table.py

@@ -217,14 +217,14 @@ class StatesTable(States):
         else:
             self._data_source = get_input_path(self.data_source)
             if not self.data_source.is_file():
-                if verbosity:
+                if verbosity > 0:
                     print(
                         f"States '{self.name}': Reading static data '{self.data_source}' from context '{STATES}'"
                     )
                 self._data_source = algo.dbook.get_file_path(
                     STATES, self.data_source.name, check_raw=False
                 )
-                if verbosity:
+                if verbosity > 0:
                     print(f"Path: {self.data_source}")
             elif verbosity:
                 print(f"States '{self.name}': Reading file {self.data_source}")
@@ -552,14 +552,14 @@ class TabStates(StatesTable):
             if self.__tab_data is None:
                 self.__tab_source = get_input_path(self.__tab_source)
                 if not self.__tab_source.is_file():
-                    if verbosity:
+                    if verbosity > 0:
                         print(
                             f"States '{self.name}': Reading static data '{self.__tab_source}' from context '{STATES}'"
                         )
                     self.__tab_source = algo.dbook.get_file_path(
                         STATES, self.__tab_source.name, check_raw=False
                     )
-                    if verbosity:
+                    if verbosity > 0:
                         print(f"Path: {self.__tab_source}")
                 elif verbosity:
                     print(f"States '{self.name}': Reading file {self.__tab_source}")

foxes/input/states/wrg_states.py

@@ -0,0 +1,189 @@
+import numpy as np
+
+from foxes.core.states import States
+from foxes.config import config, get_input_path
+from foxes.utils.wrg_utils import ReaderWRG
+from foxes.data import STATES
+import foxes.variables as FV
+import foxes.constants as FC
+
+
+class WRGStates(States):
+    """
+    Ambient states based on WRG data
+
+    Attributes
+    ----------
+    wrg_fname: str
+        Name of the WRG file
+    ws_bins: numpy.ndarray
+        The wind speed bins, including
+        lower and upper bounds, shape: (n_ws_bins+1,)
+    fixed_vars: dict
+        Fixed uniform variable values, instead of
+        reading from data
+    bounds_extra_space: float or str
+        The extra space, either float in m,
+        or str for units of D, e.g. '2.5D'
+
+    :group: input.states
+
+    """
+
+    def __init__(
+        self,
+        wrg_fname,
+        ws_bins,
+        fixed_vars={},
+        bounds_extra_space="1D",
+        **kwargs,
+    ):
+        """
+        Constructor
+
+        Parameters
+        ----------
+        wrg_fname: str
+            Name of the WRG file
+        ws_bins: list of float
+            The wind speed bins, including
+            lower and upper bounds
+        fixed_vars: dict
+            Fixed uniform variable values, instead of
+            reading from data
+        bounds_extra_space: float or str, optional
+            The extra space, either float in m,
+            or str for units of D, e.g. '2.5D'
+        kwargs: dict, optional
+            Parameters for the base class
+
+        """
+        super().__init__(**kwargs)
+        self.wrg_fname = wrg_fname
+        self.ws_bins = np.asarray(ws_bins)
+        self.fixed_vars = fixed_vars
+        self.bounds_extra_space = bounds_extra_space
+
+    def load_data(self, algo, verbosity=0):
+        """
+        Load and/or create all model data that is subject to chunking.
+
+        Such data should not be stored under self, for memory reasons. The
+        data returned here will automatically be chunked and then provided
+        as part of the mdata object during calculations.
+
+        Parameters
+        ----------
+        algo: foxes.core.Algorithm
+            The calculation algorithm
+        verbosity: int
+            The verbosity level, 0 = silent
+
+        Returns
+        -------
+        idata: dict
+            The dict has exactly two entries: `data_vars`,
+            a dict with entries `name_str -> (dim_tuple, data_ndarray)`;
+            and `coords`, a dict with entries `dim_name_str -> dim_array`
+
+        """
+        # read wrg file:
+        fpath = get_input_path(self.wrg_fname)
+        if not fpath.is_file():
+            if verbosity > 0:
+                print(
+                    f"States '{self.name}': Reading static data '{self.wrg_fname}' from context '{STATES}'"
+                )
+            fpath = algo.dbook.get_file_path(STATES, self.wrg_fname, check_raw=False)
+            if verbosity > 0:
+                print(f"Path: {fpath}")
+        elif verbosity:
+            print(f"States '{self.name}': Reading file {fpath}")
+        wrg = ReaderWRG(fpath)
+        self._p0 = np.array([wrg.x0, wrg.y0], dtype=config.dtype_double)
+        self._nx = wrg.nx
+        self._ny = wrg.ny
+        self._ns = wrg.n_sectors
+        self._res = wrg.resolution
+
+        # find bounds:
+        if self.bounds_extra_space is not None:
+            xy_min, xy_max = algo.farm.get_xy_bounds(
+                extra_space=self.bounds_extra_space, algo=algo
+            )
+            if verbosity > 0:
+                print(
+                    f"States '{self.name}': Restricting to bounds {xy_min} - {xy_max}"
+                )
+            xy_min -= self._p0
+            xy_max -= self._p0
+            ij_min = np.asarray(xy_min / self._res, dtype=config.dtype_int)
+            ij_max = np.asarray(xy_max / self._res, dtype=config.dtype_int) + 1
+            sx = slice(ij_min[0], ij_max[0])
+            sy = slice(ij_min[1], ij_max[1])
+        else:
+            sx = np.s_[:]
+            sy = np.s_[:]
+
+        # store data:
+        A = []
+        k = []
+        fs = []
+        for s in range(self._ns):
+            A.append(wrg.data[f"A_{s}"].to_numpy().reshape(self._ny, self._nx)[sy, sx])
+            k.append(wrg.data[f"k_{s}"].to_numpy().reshape(self._ny, self._nx)[sy, sx])
+            fs.append(
+                wrg.data[f"fs_{s}"].to_numpy().reshape(self._ny, self._nx)[sy, sx]
+            )
+        del wrg
+        A = np.stack(A, axis=0).T
+        k = np.stack(k, axis=0).T
+        fs = np.stack(fs, axis=0).T
+        self._data = np.stack([A, k, fs], axis=-1)  # (x, y, wd, AKfs)
+
+        # store ws and wd:
+        self.WSWD = self.var("WSWD")
+        self._wds = np.arange(0.0, 360.0, 360 / self._ns)
+        self._wsd = self.ws_bins[1:] - self.ws_bins[:-1]
+        self._wss = 0.5 * (self.ws_bins[:-1] + self.ws_bins[1:])
+        self._N = len(self._wss) * self._ns
+        wswd = np.zeros((len(self._wss), self._ns, 2), dtype=config.dtype_double)
+        wswd[..., 0] = self._wss[:, None]
+        wswd[..., 1] = self._wds[None, :]
+        wswd = wswd.reshape(self._N, 2)
+        idata = super().load_data(algo, verbosity)
+        idata.coords[self.WSWD] = [self.var(FV.WS), self.var(FV.WD)]
+        idata.data_vars[self.WSWD] = ((FC.STATE, self.WSWD), wswd)
+
+        return idata
+
+    def size(self):
+        """
+        The total number of states.
+
+        Returns
+        -------
+        int:
+            The total number of states
+
+        """
+        return self._N
+
+    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
+
+        """
+        ovars = set([FV.WS, FV.WD, FV.WEIGHT])
+        ovars.update(self.fixed_vars.values())
+        return list(ovars)

foxes/models/wake_models/induction/vortex_sheet.py

@@ -183,12 +183,11 @@ class VortexSheet(TurbineInductionModel):
         sp_sel = (ct > 1e-8) & (x <= 0)
         ct_sel = ct[sp_sel]
         r_sph_sel = r_sph[sp_sel]
-        D_sel = D[sp_sel]
+        R_sel = D[sp_sel] / 2
+        xi = r_sph_sel / R_sel
 
         if np.any(sp_sel):
-            blockage = self.induction.ct2a(ct_sel) * (
-                (1 + 2 * r_sph_sel / D_sel) * (1 + (2 * r_sph_sel / D_sel) ** 2)
-            ) ** (-0.5)
+            blockage = self.induction.ct2a(ct_sel) * (1 + -xi / np.sqrt(1 + xi**2))
 
             self._superp.add_wake(
                 algo,
@@ -208,12 +207,10 @@ class VortexSheet(TurbineInductionModel):
             )  # mirror in rotor plane and inverse blockage, but not directly behind rotor
             ct_sel = ct[sp_sel]
             r_sph_sel = r_sph[sp_sel]
-            D_sel = D[sp_sel]
+            R_sel = D[sp_sel] / 2
+            xi = r_sph_sel / R_sel
             if np.any(sp_sel):
-                blockage = self.induction.ct2a(ct_sel) * (
-                    (1 + 2 * r_sph_sel / D_sel) * (1 + (2 * r_sph_sel / D_sel) ** 2)
-                ) ** (-0.5)
-
+                blockage = self.induction.ct2a(ct_sel) * (1 + -xi / np.sqrt(1 + xi**2))
                 self._superp.add_wake(
                     algo,
                     mdata,

foxes/utils/wrg_utils.py

@@ -58,13 +58,18 @@ class ReaderWRG:
         cols[10::3] = cols_sel("Ks", self._n_sectors)
 
         self._data = pd.read_csv(
-            self.fpath, names=cols, skiprows=1, sep="\s+", usecols=range(1, n_cols)
+            self.fpath, names=cols, skiprows=1, sep=r"\s+", usecols=range(1, n_cols)
         )
 
         self._data[cols_sel("fs", self._n_sectors)] /= 10
         self._data[cols_sel("As", self._n_sectors)] /= 10
         self._data[cols_sel("Ks", self._n_sectors)] /= 100
 
+        if len(self._data.index) != self._nx * self._ny:
+            raise ValueError(
+                f"Expecting {self._nx * self._ny} rows in data, got {len(self._data.index)}"
+            )
+
     @property
     def data(self):
         """
@@ -77,3 +82,81 @@ class ReaderWRG:
 
         """
         return self._data
+
+    @property
+    def nx(self):
+        """
+        The number of points in x direction
+
+        Returns
+        -------
+        n: int
+            The number of points in x direction
+
+        """
+        return self._nx
+
+    @property
+    def ny(self):
+        """
+        The number of points in y direction
+
+        Returns
+        -------
+        n: int
+            The number of points in y direction
+
+        """
+        return self._ny
+
+    @property
+    def x0(self):
+        """
+        The lower left x coordinate
+
+        Returns
+        -------
+        x: float
+            The lower left x coordinate
+
+        """
+        return self._utmx0
+
+    @property
+    def y0(self):
+        """
+        The lower left y coordinate
+
+        Returns
+        -------
+        y: float
+            The lower left y coordinate
+
+        """
+        return self._utmy0
+
+    @property
+    def n_sectors(self):
+        """
+        The number of wind direction sectors
+
+        Returns
+        -------
+        n: int
+            The number of wind direction sectors
+
+        """
+        return self._n_sectors
+
+    @property
+    def resolution(self):
+        """
+        The horizontal resolution
+
+        Returns
+        -------
+        res: float
+            The horizontal resolution
+
+        """
+        return self._res

{foxes-1.2.4.dist-info → foxes-1.2.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foxes
-Version: 1.2.4
+Version: 1.2.5
 Summary: Farm Optimization and eXtended yield Evaluation Software
 Author: Jonas Schulte
 Maintainer: Jonas Schulte
@@ -94,6 +94,8 @@ Requires-Dist: ipykernel; extra == "doc"
 Requires-Dist: ipywidgets; extra == "doc"
 Requires-Dist: m2r2; extra == "doc"
 Requires-Dist: lxml_html_clean; extra == "doc"
+Requires-Dist: dask; extra == "doc"
+Requires-Dist: distributed; extra == "doc"
 Provides-Extra: dev
 Requires-Dist: flake8; extra == "dev"
 Requires-Dist: pytest; extra == "dev"

{foxes-1.2.4.dist-info → foxes-1.2.5.dist-info}/RECORD

@@ -111,11 +111,12 @@ foxes/input/farm_layout/ring.py,sha256=ghfLkVVQciWDJJNqGs4jZVnM0XCII9ae3hAh9Wb49
 foxes/input/farm_layout/row.py,sha256=Bx9woFNkXbFXJg51GX2p2PbVgdxV3Ckxr-3TkB04PS4,1198
 foxes/input/states/__init__.py,sha256=Xkjr0Tn3jKEBcIk3GA1dRVzTDIX9Xco-Y23X-LUV-GA,526
 foxes/input/states/field_data_nc.py,sha256=LSSW6Q4Ica3gl9CuBuRm7wqKtYZpvOLGzTVqv8ylFm4,29429
-foxes/input/states/multi_height.py,sha256=ECKARj0tJ-Bzih8wiii_sy34HjfTAP4QCvLo4Fh7Ruk,23810
+foxes/input/states/multi_height.py,sha256=Bf14Kz_ke9LP314617qgYtGXSbBpEZKnFnfjNyh9sjc,23826
 foxes/input/states/one_point_flow.py,sha256=TuMYGSHz3nOwN3gdWxbQNRHzKmtVtV4AbnHTJ6dVceA,17787
 foxes/input/states/scan.py,sha256=43CnJl-iRUbRrJCtu-u6Na5DDY19_184myD6ScMfcFA,6101
 foxes/input/states/single.py,sha256=jwcZ2quljXS9cDyYbf3wgvbYUe6umqNfyfvRdylYbC0,6137
-foxes/input/states/states_table.py,sha256=HrsX2DVID1SbopBaevfq1HqkDtpH2mtfqslxYNDpNC8,20465
+foxes/input/states/states_table.py,sha256=pUpdhRGYmBvZD9kFQxXvUMP6oWPfiKsGhxX7m209SkE,20481
+foxes/input/states/wrg_states.py,sha256=29HBfLaK40GvNNZ2F9hX2iVh3P7AXdRW05By2WO-xjg,5915
 foxes/input/states/create/__init__.py,sha256=Ocqzmr9SOefeAvGX5DgawsPXfNdGzWOZ2ssvtqEmtAo,134
 foxes/input/states/create/random_abl_states.py,sha256=LFCA19TCInXmB2FbKDaOkqCDsN0eOUIp34yzR2NQjtQ,3425
 foxes/input/states/create/random_timeseries.py,sha256=gJpaQ4nEXxOjI4hp3xjNcVbCsmZUm-brXUxoqDb63WE,1266
@@ -205,7 +206,7 @@ foxes/models/wake_models/induction/rankine_half_body.py,sha256=LKYNAiamULPLQeohl
 foxes/models/wake_models/induction/rathmann.py,sha256=SFLqMFjcwSM2zSdyK8M60q8pB98ffixDWuvhRH5FYwE,7751
 foxes/models/wake_models/induction/self_similar.py,sha256=q7PM8mLjH8BW2_Qev_3yoAwchRy8cCoG6ps6mlYnIGQ,8444
 foxes/models/wake_models/induction/self_similar2020.py,sha256=D8yQxa5NQFII2gvKggcbJvuSDnrIRSy0Q5aCC3DoTPc,1634
-foxes/models/wake_models/induction/vortex_sheet.py,sha256=TYPXzlbcx8IMy3_Nbw4bY_mMWpSqST0JGwL1mJf4He8,7357
+foxes/models/wake_models/induction/vortex_sheet.py,sha256=aUTUr4NOiIXnQtzzde1Y6dNNP_chk3m_YcetuAovTfw,7270
 foxes/models/wake_models/ti/__init__.py,sha256=EOlqFHL2mzcKGFRZqlVYTiqGJqPb6dx7I5UWUDshy2U,125
 foxes/models/wake_models/ti/crespo_hernandez.py,sha256=GcRqWw2EjAka3Ss0If-HM-gkxJlV7Omm-5oyqF1-y0M,8933
 foxes/models/wake_models/ti/iec_ti.py,sha256=8efoMQibs8zolXF7iZALggdFL6fHeRdL5ikztRjxENI,7006
@@ -264,7 +265,7 @@ foxes/utils/subclasses.py,sha256=wCfhuialpBOQOPMwNbaplkVmf60vR9AIkY_o3tdkgXI,173
 foxes/utils/tab_files.py,sha256=H50IpLaqffJn9A51orCGc4fOhCOzoNUYDUKek4OAayU,1811
 foxes/utils/two_circles.py,sha256=xkj-SA_x-VXY7KtmSU4lcV4gFdplyhU3sBAC9vTdkF4,2810
 foxes/utils/wind_dir.py,sha256=6W0njWDvnIdOOjwqcMr64MW9ApjdtFA75blVUxirPMo,2823
-foxes/utils/wrg_utils.py,sha256=3T6NkznU1_nc5bTaq-rEuBRFeBPjqP4XnEhwhQArKnk,2019
+foxes/utils/wrg_utils.py,sha256=PsaOIKx3WrHekJPeJMHzMfTYoEXkOAV51QjRbGjobGQ,3534
 foxes/utils/xarray_utils.py,sha256=6VLTAitXTK6W5zlBTadWwN05qmq_TlEDpUCx227JxtY,1677
 foxes/utils/abl/__init__.py,sha256=ijn-ubLLlqqH6tTAXFRmBAxJZmVBlTEmtx1cdCCtG4I,135
 foxes/utils/abl/neutral.py,sha256=E4DEhvXvw74BPrYr1MjQjeIaoz6ZOTWVlqScKflm-0M,1358
@@ -303,9 +304,9 @@ tests/1_verification/flappy_0_6_2/row_Bastankhah_Crespo/flappy/run.py,sha256=nwI
 tests/1_verification/flappy_0_6_2/row_Bastankhah_linear_centre/test_row_Bastankhah_linear_centre.py,sha256=a7CQS-_Mnz3NynaTv1OY1CZ10iAqa7E3YxmkbDtoshw,2590
 tests/1_verification/flappy_0_6_2/row_Bastankhah_linear_centre/flappy/run.py,sha256=s6FbEdpiIdHYmdD8S85_NhLH-S3EOinXvw8RHmR2QOU,2122
 tests/3_examples/test_examples.py,sha256=rS2Dz04ktbS6v3TRDr96AkWGypr5u49jihqbEmGFmRU,694
-foxes-1.2.4.dist-info/LICENSE,sha256=bBCH6mYTPzSepk2s2UUZ3II_ZYXrn1bnSqB85-aZHxU,1071
-foxes-1.2.4.dist-info/METADATA,sha256=vAXcCQux4WPpc196ZFrNyXhyDNKBVL8PETlRB824oiM,8811
-foxes-1.2.4.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-foxes-1.2.4.dist-info/entry_points.txt,sha256=KuS44FRH5NnMw201A8Btr76eNRKr2UOoKHjejAsqKwE,123
-foxes-1.2.4.dist-info/top_level.txt,sha256=G7oHApEz5nc-iP__XsPcvjYe_NyXGmKMUMPHi3C3x6I,26
-foxes-1.2.4.dist-info/RECORD,,
+foxes-1.2.5.dist-info/LICENSE,sha256=bBCH6mYTPzSepk2s2UUZ3II_ZYXrn1bnSqB85-aZHxU,1071
+foxes-1.2.5.dist-info/METADATA,sha256=t7Ic8ZLWemygBNxnjuLMopK0uz_rI943L00tjHMgEE4,8890
+foxes-1.2.5.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+foxes-1.2.5.dist-info/entry_points.txt,sha256=KuS44FRH5NnMw201A8Btr76eNRKr2UOoKHjejAsqKwE,123
+foxes-1.2.5.dist-info/top_level.txt,sha256=G7oHApEz5nc-iP__XsPcvjYe_NyXGmKMUMPHi3C3x6I,26
+foxes-1.2.5.dist-info/RECORD,,