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

foxes/utils/dict.py

@@ -32,6 +32,6 @@ class Dict(dict):
         try:
             return super().__getitem__(key)
         except KeyError:
-            k = ", ".join(sorted(list(self.keys())))
+            k = ", ".join(sorted([f"{s}" for s in self.keys()]))
             e = f"{self.name}: Cannot find key '{key}'. Known keys: {k}"
             raise KeyError(e)

foxes/utils/factory.py

@@ -1,3 +1,5 @@
+import numpy as np
+
 from .dict import Dict
 import foxes.variables as FV
 
@@ -23,6 +25,8 @@ class Factory:
     hints: dict
         Hints for print_toc, only for variables for which the
         options are functions or missing
+    example: str
+        An example name
     options: dict
         For each variable, e.g. A, B or C, the list or dict
         or function that maps a str to the actual value
@@ -39,6 +43,7 @@ class Factory:
         kwargs={},
         var2arg={},
         hints={},
+        example_vars=None,
         **options,
     ):
         """
@@ -60,6 +65,8 @@ class Factory:
         hints: dict
             Hints for print_toc, only for variables for which the
             options are functions or missing
+        example_vars: dict, optional
+            Variable values for creating an example
         options: dict
             For each variable, e.g. A, B or C, the list or dict
             or function that maps a str to the actual value
@@ -122,6 +129,30 @@ class Factory:
                     f"Factory '{name_template}': Variable '{v}' has option of type '{type(v).__name__}'. Only list, tuple, dict or function are supported"
                 )
 
+        exvars = dict(
+            n=5,
+            n2=9,
+            superposition="linear",
+            kTI=0.2,
+            kb=0.001,
+            step=100,
+            dx=100,
+            dt="10s",
+        )
+        if example_vars is not None:
+            exvars.update(example_vars)
+        try:
+            self.example = ""
+            for i, v in enumerate(self._vars):
+                self.example += f"{self._pre[i]}{exvars[v]}"
+            self.example += self._pre[-1]
+            if not self.check_match(self.example, error=False):
+                raise ValueError(
+                    f"Example '{self.example}' does not match template '{self.name_template}'"
+                )
+        except KeyError:
+            self.example = None
+
     @property
     def name_prefix(self):
         """
@@ -171,56 +202,77 @@ class Factory:
                 s += f"\n  {v} from {list(self.options[v])}"
             else:
                 s += f"\n  {v}={self.hints.get(v, '(value)')}"
+        if self.example is not None:
+            s += f"\nExample: {self.example}"
         return s
 
-    def check_match(self, name):
+    def get_examples(self, **var_values):
         """
-        Tests if a name matches the template
+        Create example names from given values
 
         Parameters
         ----------
-        name: str
-            The name to be checked
+        var_values: dict
+            Variables values. Key: Variable,
+            value: list or value
 
         Returns
         -------
-        success: bool
-            True if the template is matched
+        examples: list of str
+            The examples
 
         """
-        data_str = name
-        for vi in range(len(self.variables)):
-            p = self._pre[vi]
-            i = data_str.find(p)
-            j = i + len(p)
-            if i < 0 or len(data_str) <= j:
-                return False
-            data_str = data_str[j:]
-
-            q = self._pre[vi + 1]
-            if q != "":
-                i = data_str.find(q)
-                j = i + len(q)
-                if i < 0 or len(data_str) <= j:
-                    return False
+
+        def gete(i, vals, vars, values, examples):
+            if i >= len(vars):
+                e = ""
+                for i, v in enumerate(self._vars):
+                    e += f"{self._pre[i]}{vals[v]}"
+                e += self._pre[-1]
+                self.check_match(e, error=True)
+                examples.append(e)
             else:
-                data_str = ""
+                v = vars[i]
+                if v in self._vars:
+                    vls = np.atleast_1d(values[i])
+                    for x in vls:
+                        vals[v] = x
+                        gete(i + 1, vals, vars, values, examples)
+                else:
+                    gete(i + 1, vals, vars, values, examples)
+
+        examples = []
+        gete(
+            0,
+            {},
+            list(var_values.keys()),
+            list(var_values.values()),
+            examples,
+        )
 
-        return True
+        return examples
 
-    def construct(self, name):
+    def check_match(self, name, error=False, ret_pars=False):
         """
-        Create an object of the base class.
+        Tests if a name matches the template and constructs
+        parameters
 
         Parameters
         ----------
         name: str
-            The name, matching the template
+            The name to be checked
+        error: bool
+            Flag for raising a Value error in case of
+            mismatch
+        ret_pars: bool
+            Flag for returning the parameters
 
         Returns
         -------
-        obj: object
-            The instance of the base class
+        success: bool
+            True if the template is matched
+        pars: dict, optional
+            The constructed parameters
 
         """
         j = 0
@@ -229,9 +281,14 @@ class Factory:
             if len(p) > 0:
                 i = name[j:].find(p)
                 if i < 0 or (pi == 0 and i > 0):
-                    raise ValueError(
-                        f"Factory '{self.name_template}': Name '{name}' not matching template"
-                    )
+                    if error:
+                        raise ValueError(
+                            f"Factory '{self.name_template}': Name '{name}' not matching template"
+                        )
+                    elif ret_pars:
+                        return False, {}
+                    else:
+                        return False
                 w = name[j : j + i]
                 j += i + len(p)
             else:
@@ -239,21 +296,41 @@ class Factory:
             if pi > 0:
                 wlist.append(w)
 
-        kwargs = {}
-        for vi, v in enumerate(self.variables):
-            w = self.var2arg.get(v, v)
-            data = wlist[vi]
-            if v in self.options:
-                o = self.options[v]
-                if hasattr(o, "__call__"):
-                    kwargs[w] = o(data)
+        if ret_pars:
+            kwargs = {}
+            for vi, v in enumerate(self.variables):
+                w = self.var2arg.get(v, v)
+                data = wlist[vi]
+                if v in self.options:
+                    o = self.options[v]
+                    if hasattr(o, "__call__"):
+                        kwargs[w] = o(data)
+                    else:
+                        kwargs[w] = self.options[v][data]
                 else:
-                    kwargs[w] = self.options[v][data]
-            else:
-                kwargs[w] = data
+                    kwargs[w] = data
 
-        kwargs.update(self.kwargs)
+            kwargs.update(self.kwargs)
+            return True, kwargs
+
+        return True
+
+    def construct(self, name):
+        """
+        Create an object of the base class.
+
+        Parameters
+        ----------
+        name: str
+            The name, matching the template
 
+        Returns
+        -------
+        obj: object
+            The instance of the base class
+
+        """
+        __, kwargs = self.check_match(name, error=True, ret_pars=True)
         return self.base(*self.args, **kwargs)
 
 
@@ -299,14 +376,20 @@ class WakeKFactory:
         i0 = name_template.find("_[wake_k]")
         i1 = i0 + len("_[wake_k]")
         kw = kwargs.pop("kwargs", {})
+        v2a = kwargs.pop("var2arg", {})
 
         if i0 < 0:
             raise ValueError(
                 f"String '_[wake_k]' not found in name template '{name_template}'"
             )
 
+        exvars = dict(k=0.04, ka=0.2, ambka=0.4, kb=0.001)
+        if "example_vars" in kwargs:
+            exvars.update(kwargs.pop("example_vars"))
+
         # add case ka, kb:
-        t = name_template[:i0] + "_ka<ka>_kb<kb>"
+        t0 = name_template[:i0]
+        t = t0 + "_ka<ka>_kb<kb>"
         if len(name_template) > i1:
             t += name_template[i1:]
         h = hints.copy()
@@ -323,17 +406,20 @@ class WakeKFactory:
                 **kwargs,
                 ka=lambda x: float(f"0.{x[1:]}" if x[0] == "0" else float(x)),
                 kb=lambda x: float(f"0.{x[1:]}" if x[0] == "0" else float(x)),
+                example_vars=exvars,
             )
         )
 
-        # add case ambient ka, kb:
-        t = name_template[:i0] + "_ambka<ka>_kb<kb>"
+        # add case ambient ambka, kb:
+        t = name_template[:i0] + "_ambka<ambka>_kb<kb>"
         if len(name_template) > i1:
             t += name_template[i1:]
         h = hints.copy()
-        h["ka"] = "(Value, e.g. 04 for 0.4)"
+        h["ambka"] = "(Value, e.g. 04 for 0.4)"
         h["kb"] = "(Value, e.g. 001 for 0.01)"
         kw["ti_var"] = FV.AMB_TI
+        hv2a = v2a.copy()
+        hv2a["ambka"] = "ka"
         self.factories.append(
             Factory(
                 base,
@@ -341,9 +427,11 @@ class WakeKFactory:
                 *args,
                 hints=h,
                 kwargs=kw.copy(),
+                var2arg=hv2a,
                 **kwargs,
-                ka=lambda x: float(f"0.{x[1:]}" if x[0] == "0" else float(x)),
+                ambka=lambda x: float(f"0.{x[1:]}" if x[0] == "0" else float(x)),
                 kb=lambda x: float(f"0.{x[1:]}" if x[0] == "0" else float(x)),
+                example_vars=exvars,
             )
         )
 
@@ -363,16 +451,19 @@ class WakeKFactory:
                 kwargs=kw.copy(),
                 **kwargs,
                 ka=lambda x: float(f"0.{x[1:]}" if x[0] == "0" else float(x)),
+                example_vars=exvars,
             )
         )
 
-        # add case ka:
-        t = name_template[:i0] + "_ambka<ka>"
+        # add case ambka:
+        t = name_template[:i0] + "_ambka<ambka>"
         if len(name_template) > i1:
             t += name_template[i1:]
         h = hints.copy()
-        h["ka"] = "(Value, e.g. 04 for 0.4)"
+        h["ambka"] = "(Value, e.g. 04 for 0.4)"
         kw["ti_var"] = FV.AMB_TI
+        hv2a = v2a.copy()
+        hv2a["ambka"] = "ka"
         self.factories.append(
             Factory(
                 base,
@@ -380,8 +471,10 @@ class WakeKFactory:
                 *args,
                 hints=h,
                 kwargs=kw.copy(),
+                var2arg=hv2a,
                 **kwargs,
-                ka=lambda x: float(f"0.{x[1:]}" if x[0] == "0" else float(x)),
+                ambka=lambda x: float(f"0.{x[1:]}" if x[0] == "0" else float(x)),
+                example_vars=exvars,
             )
         )
 
@@ -401,6 +494,7 @@ class WakeKFactory:
                 kwargs=kw.copy(),
                 **kwargs,
                 k=lambda x: float(f"0.{x[1:]}" if x[0] == "0" else float(x)),
+                example_vars=exvars,
             )
         )
 
@@ -417,6 +511,7 @@ class WakeKFactory:
                 hints=hints,
                 kwargs=kw.copy(),
                 **kwargs,
+                example_vars=exvars,
             )
         )
 

foxes/utils/pandas_helpers.py

@@ -41,7 +41,7 @@ class PandasFileHelper:
         "csv.gz": {},
         "csv.bz2": {},
         "csv.zip": {},
-        "h5": {"key": "flappy", "mode": "w"},
+        "h5": {"key": "foxes", "mode": "w"},
         "nc": {},
     }
 
@@ -133,12 +133,13 @@ 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.
 
         """
 
-        fdict = deepcopy(cls.DEFAULT_FORMAT_DICT)
+        digits = {c: FV.get_default_digits(c) for c in data.columns}
+        fdict = {c: "{:." + str(d) + "f}" for c, d in digits.items() if d is not None}
         fdict.update(format_dict)
 
         out = pd.DataFrame(index=data.index)

foxes/utils/wind_dir.py

@@ -24,7 +24,6 @@ def wd2wdvec(wd, ws=1.0, axis=-1):
     :group: utils
 
     """
-
     wdr = wd * np.pi / 180.0
     n = np.stack([np.sin(wdr), np.cos(wdr)], axis=axis)
 
@@ -79,7 +78,6 @@ def uv2wd(uv, axis=-1):
     :group: utils
 
     """
-
     if axis == -1:
         u = uv[..., 0]
         v = uv[..., 1]

foxes/utils/xarray_utils.py

@@ -1,4 +1,10 @@
-def write_nc(ds, fpath, round="auto", complevel=5, verbosity=1, **kwargs):
+import netCDF4
+from pathlib import Path
+
+from foxes.variables import get_default_digits
+
+
+def write_nc(ds, fpath, round={}, complevel=9, verbosity=1, **kwargs):
     """
     Writes a dataset to netCFD file
 
@@ -6,9 +12,9 @@ def write_nc(ds, fpath, round="auto", complevel=5, verbosity=1, **kwargs):
     ----------
     fpath: str
         Path to the output file, should be nc
-    round: dict or str, optional
-        The rounding definitions, or auto for
-        default settings
+    round: dict
+        The rounding digits, falling back to defaults
+        if variable not found
     complevel: int
         The compression level
     verbosity: int
@@ -17,21 +23,27 @@ def write_nc(ds, fpath, round="auto", complevel=5, verbosity=1, **kwargs):
         Additional parameters for xarray.to_netcdf
 
     """
-
+    fpath = Path(fpath)
     if round is not None:
         for v in ds.coords.keys():
-            if v in round:
+            d = round.get(v, get_default_digits(v))
+            if d is not None:
                 if verbosity > 1:
-                    print(f"Rounding {v} to {round[v]} decimals")
-                ds[v].data = ds[v].data.round(decimals=round[v])
+                    print(f"File {fpath.name}: Rounding {v} to {d} decimals")
+                ds[v].data = ds[v].data.round(decimals=d)
         for v in ds.data_vars.keys():
-            if v in round:
+            d = round.get(v, get_default_digits(v))
+            if d is not None:
                 if verbosity > 1:
-                    print(f"Rounding {v} to {round[v]} decimals")
-                ds[v].data = ds[v].data.round(decimals=round[v])
+                    print(f"File {fpath.name}: Rounding {v} to {d} decimals")
+                ds[v].data = ds[v].data.round(decimals=d)
+
+    enc = None
+    if complevel is not None and complevel > 0:
+        if verbosity > 1:
+            print(f"File {fpath.name}: Compression level = {complevel}")
+        enc = {k: {"zlib": True, "complevel": complevel} for k in ds.data_vars}
 
     if verbosity > 0:
         print("Writing file", fpath)
-
-    enc = {k: {"zlib": True, "complevel": complevel} for k in ds.data_vars}
     ds.to_netcdf(fpath, encoding=enc, **kwargs)

foxes/variables.py

@@ -276,3 +276,40 @@ PA_BETA = "PA_beta"
 """ The beta parameter of the PorteAgel wake model
 :group: foxes.variables
 """
+
+DEFAULT_DIGITS = {
+    WD: 3,
+    WS: 4,
+    TI: 6,
+    RHO: 5,
+    P: 3,
+    CT: 6,
+    T: 3,
+    YLD: 3,
+    CAP: 5,
+    EFF: 5,
+}
+""" The default output digits
+:group: foxes.variables
+"""
+
+
+def get_default_digits(variable):
+    """
+    Gets the default numbber of output digits
+
+    Parameters
+    ----------
+    variable: str
+        The variable name
+
+    Returns
+    -------
+    digits: int
+        The default number of output digits
+
+    """
+    v = amb2var.get(variable, variable)
+    if v in [REWS, REWS2, REWS3]:
+        v = WS
+    return DEFAULT_DIGITS.get(v, None)

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

@@ -1,13 +1,36 @@
 Metadata-Version: 2.1
 Name: foxes
-Version: 0.8.1
+Version: 1.0
 Summary: Farm Optimization and eXtended yield Evaluation Software
-Author: Fraunhofer IWES
-Author-email: jonas.schulte@iwes.fraunhofer.de
-License: MIT
-Project-URL: Source Code, https://github.com/FraunhoferIWES/foxes
-Project-URL: Bug Tracker, https://github.com/FraunhoferIWES/foxes/issues
+Author: Jonas Schulte
+Maintainer: Jonas Schulte
+License: MIT License
+        
+        Copyright (c) 2022 FraunhoferIWES
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/FraunhoferIWES/foxes
 Project-URL: Documentation, https://fraunhoferiwes.github.io/foxes.docs/index.html
+Project-URL: Repository, https://github.com/FraunhoferIWES/foxes.git
+Project-URL: Bug Tracker, https://github.com/FraunhoferIWES/foxes/issues
+Project-URL: Changelog, https://github.com/FraunhoferIWES/foxes/blob/main/CHANGELOG.md
 Keywords: Wind farm,Wake modelling,Wind farm optimization
 Classifier: Topic :: Scientific/Engineering
 Classifier: Intended Audience :: Developers
@@ -28,40 +51,51 @@ Requires-Dist: matplotlib
 Requires-Dist: numpy
 Requires-Dist: pandas
 Requires-Dist: xarray
-Requires-Dist: dask
-Requires-Dist: distributed
 Requires-Dist: scipy
 Requires-Dist: netcdf4
 Requires-Dist: windrose
-Requires-Dist: pyarrow
-Provides-Extra: all
-Requires-Dist: windio >=1 ; extra == 'all'
-Requires-Dist: flake8 ; extra == 'all'
-Requires-Dist: pytest ; extra == 'all'
-Requires-Dist: foxes-opt ; extra == 'all'
-Requires-Dist: sphinx ; extra == 'all'
-Requires-Dist: sphinx-immaterial ; extra == 'all'
-Requires-Dist: nbsphinx ; extra == 'all'
-Requires-Dist: ipykernel ; extra == 'all'
-Requires-Dist: ipywidgets ; extra == 'all'
-Requires-Dist: m2r2 ; extra == 'all'
-Requires-Dist: lxml-html-clean ; extra == 'all'
+Requires-Dist: cycler
+Requires-Dist: tqdm
+Requires-Dist: pyyaml
+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; 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'
+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"
+Requires-Dist: distributed; extra == "eng"
+Requires-Dist: dask-jobqueue; extra == "eng"
+Requires-Dist: setuptools; extra == "eng"
+Requires-Dist: mpi4py; 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: windio>=1; extra == "io"
 Provides-Extra: opt
-Requires-Dist: foxes-opt ; extra == 'opt'
-Provides-Extra: scripts
+Requires-Dist: foxes-opt; extra == "opt"
 Provides-Extra: test
-Requires-Dist: flake8 ; extra == 'test'
-Requires-Dist: pytest ; extra == 'test'
+Requires-Dist: flake8; extra == "test"
+Requires-Dist: pytest; extra == "test"
 
 # Welcome to foxes
 
@@ -76,7 +110,11 @@ The software `foxes` is a modular wind farm simulation and wake modelling toolbo
 - Wake model studies, comparison and validation,
 - Wind farm simulations invoking complex model chains.
 
-The calculation is fully vectorized and its fast performance is owed to [dask](https://www.dask.org/). Also the parallelization on local or remote clusters is enabled via `dask`. The wind farm
+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 
+[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.