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

foxes/VERSION

@@ -1 +1 @@
-0.7.4.25
+0.8.1

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

@@ -1,15 +1,23 @@
 Metadata-Version: 2.1
 Name: foxes
-Version: 0.7.4.25
+Version: 0.8.1
 Summary: Farm Optimization and eXtended yield Evaluation Software
 Author: Fraunhofer IWES
-Author-email: jonas.schmidt@iwes.fraunhofer.de
+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
 Project-URL: Documentation, https://fraunhoferiwes.github.io/foxes.docs/index.html
 Keywords: Wind farm,Wake modelling,Wind farm optimization
+Classifier: Topic :: Scientific/Engineering
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Development Status :: 4 - Beta
@@ -17,7 +25,7 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: matplotlib
-Requires-Dist: numpy <2
+Requires-Dist: numpy
 Requires-Dist: pandas
 Requires-Dist: xarray
 Requires-Dist: dask
@@ -25,19 +33,19 @@ Requires-Dist: distributed
 Requires-Dist: scipy
 Requires-Dist: netcdf4
 Requires-Dist: windrose
-Requires-Dist: iwopy >=0.1.4
 Requires-Dist: pyarrow
 Provides-Extra: all
 Requires-Dist: windio >=1 ; extra == 'all'
 Requires-Dist: flake8 ; extra == 'all'
 Requires-Dist: pytest ; extra == 'all'
-Requires-Dist: pymoo >=0.6 ; 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'
 Provides-Extra: doc
 Requires-Dist: sphinx ; extra == 'doc'
 Requires-Dist: sphinx-immaterial ; extra == 'doc'
@@ -48,11 +56,12 @@ Requires-Dist: m2r2 ; extra == 'doc'
 Requires-Dist: lxml-html-clean ; extra == 'doc'
 Provides-Extra: io
 Requires-Dist: windio >=1 ; extra == 'io'
+Provides-Extra: opt
+Requires-Dist: foxes-opt ; extra == 'opt'
 Provides-Extra: scripts
 Provides-Extra: test
 Requires-Dist: flake8 ; extra == 'test'
 Requires-Dist: pytest ; extra == 'test'
-Requires-Dist: pymoo >=0.6 ; extra == 'test'
 
 # Welcome to foxes
 
@@ -105,7 +114,7 @@ Evaluation Software"`
 }
  ```
 
-## Installation via pip
+## Requirements
 
 The supported Python versions are: 
 
@@ -115,125 +124,20 @@ The supported Python versions are:
 - `Python 3.11`
 - `Python 3.12`
 
-### Virtual Python environment
+## Installation
 
-First create a new `venv` environment, for example called `foxes` and located at `~/venv/foxes` (choose any other convenient name and location in your file system if you prefer), by
-
-```console
-python3 -m venv ~/venv/foxes
-```
-
-Then activate the environment every time you work with `foxes`, by
-
-```console
-source ~/venv/foxes/bin/activate
-```
-
-You can leave the environment by
-
-```console
-deactivate
-```
-
-The `pip` installation commands below should be executed within the active `foxes` environment.
-
-### Standard users
-
-As a standard user, you can install the latest release via [pip](https://pypi.org/project/foxes/) by
+Either install via pip:
 
 ```console
 pip install foxes
 ```
 
-This commands installs the version that correspond to the `main` branch at [github](https://github.com/FraunhoferIWES/foxes). Alternatively, you can decide to install the latest pre-release developments (non-stable) by
-
-```console
-pip install git+https://github.com/FraunhoferIWES/foxes@dev#egg=foxes
-```
-
-### Developers
-
-For developers using `pip`, simply invoke the `-e` flag in the installation command in your local clone:
-
-```console
-git clone https://github.com/FraunhoferIWES/foxes.git
-cd foxes
-pip install -e .
-```
-The last line makes sure that all your code changes are included whenever importing `foxes`. Concerning the `git clone` line, we actually recommend that you fork `foxes` on GitHub and then replace that command by cloning your fork instead.
-
-## Installation via conda
-
-The supported Python versions are: 
-
-- `Python 3.8`
-- `Python 3.9`
-- `Python 3.10`
-- `Python 3.11`
-- `Python 3.12`
-
-### Preparation (optional)
-
-It is strongly recommend to use the `libmamba` dependency solver instead of the default solver. Install it once by
-
-```console
-conda install conda-libmamba-solver -n base -c conda-forge
-```
-
-We recommend that you set this to be your default solver, by
-
-```console
-conda config --set solver libmamba
-```
-
-### Virtual Python environment
-
-First create a new `conda` environment, for example called `foxes`, by
-
-```console
-conda create -n foxes -c conda-forge
-```
-
-Then activate the environment every time you work with `foxes`, by
-
-```console
-conda activate foxes
-```
-
-You can leave the environment by
+Alternatively, install via conda:
 
 ```console
-conda deactivate
+conda install foxes -c conda-forge
 ```
 
-The `conda` installation commands below should be executed within the active `foxes` environment.
-
-### Standard users
-
-The `foxes` package is available on the channel [conda-forge](https://anaconda.org/conda-forge/foxes). You can install the latest version by
-
-```console
-conda install foxes -c conda-forge --solver=libmamba
-```
-
-The `--solver=libmamba` is optional. Note that it is not necessary if you have set the `libmamba` solver as your default, see above.
-
-### Developers
-
-For developers using `conda`, we recommend first installing foxes as described above, then removing only the `foxes` package while keeping the dependencies, and then adding `foxes` again from a git using `conda develop`:
-
-```console
-conda install foxes conda-build -c conda-forge --solver=libmamba
-conda remove foxes --force
-git clone https://github.com/FraunhoferIWES/foxes.git
-cd foxes
-conda develop .
-```
-
-The last line makes sure that all your code changes are included whenever importing `foxes`. The `--solver=libmamba` is optional. Note that it is not necessary if you have set the `libmamba` solver as your default, see above.
-
-Concerning the `git clone` line, we actually recommend that you fork `foxes` on GitHub and then replace that command by cloning your fork instead.
-
 ## Usage
 
 For detailed examples of how to run _foxes_, check the `examples` and `notebooks` folders in this repository. A minimal running example is the following, based on provided static `csv` data files:

{foxes-0.7.4.25.dist-info → foxes-0.8.1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-foxes/VERSION,sha256=wqudIC35UQ4X_ZXteUCZWmkgYOqn9W5YQaMpo8usws0,9
+foxes/VERSION,sha256=qvZyHcN8QLQjOsz8CB8ld2_zvR0qS51c6nYNHCz4ZmU,6
 foxes/__init__.py,sha256=4ptDOBaQC8fAd_ZH5XH7d5pIgx3JXEY9xLcK3Nrs2Ow,718
 foxes/constants.py,sha256=AQepsPOCRnHycNKvFyltcPFa4yUqYtTBOzgp56KKewA,2713
 foxes/variables.py,sha256=I-S25WejH33ffOcVnmN2TDL1pIxWqg0aM1lhIBwZ9NQ,4454
@@ -186,32 +186,6 @@ foxes/models/wake_superpositions/ws_max.py,sha256=MktXVo3PfMgh172DJP_KRftiqs8jXs
 foxes/models/wake_superpositions/ws_pow.py,sha256=aPtm5NwQx6byNfetSX57Z7tVkXtgXIRleSf4grKtZF0,9602
 foxes/models/wake_superpositions/ws_product.py,sha256=8dCDaKfuzHfTEBo0_N7BR-x_qG2tWXTabzPsgpIAtXk,4672
 foxes/models/wake_superpositions/ws_quadratic.py,sha256=jUo4wFkrUPbj-27m3ozCEzab7iamkNZtVlrCwY-Yh2w,9197
-foxes/opt/__init__.py,sha256=okwZagHJMkUkLvKCSQLbE0cjx_47RLl3bEz576j6CdI,172
-foxes/opt/constraints/__init__.py,sha256=UZzN_JlxGaASdGtvBn5d5xwdSDpwO6bklj3vw70IZvU,159
-foxes/opt/constraints/area_geometry.py,sha256=9TFsyuM8_pp3HEUV4N0w0KnhxOk0OLPMKd6ZvNQGC80,6156
-foxes/opt/constraints/min_dist.py,sha256=27D3IzbyyCBeC_A4dIGqcUGCz39cw7HfQiPAexgzpbE,7532
-foxes/opt/core/__init__.py,sha256=ugGfoIhn64oo_fYKyiGZo3eyFJfd7dhdwgl8MzgUl5o,289
-foxes/opt/core/farm_constraint.py,sha256=OGyzcz-lhnT4XAzxSRP2gAxh8jKO7JiCTaOv_b6f5wI,2009
-foxes/opt/core/farm_objective.py,sha256=unBJbs9XB6i_T-B_gbIq-NJY7iiAyfBdd2yCeOiG45g,2039
-foxes/opt/core/farm_opt_problem.py,sha256=DVW3xAv8PLi874ielfPiFwSXXthyRx9JEynQl7Rjmw0,9039
-foxes/opt/core/farm_vars_problem.py,sha256=7bS_nX1HbhBl9ZE44vy3UrLJJFie1in555joO6zpB0E,7774
-foxes/opt/core/pop_states.py,sha256=nW4lqmF4YNqVJYfOOaSYOId-pyzmH-RK8paU3xqSwtA,5780
-foxes/opt/objectives/__init__.py,sha256=Cs1CciLB53G_LOcjqqSBhyojB3FmyGeg5dInXpcw1l8,153
-foxes/opt/objectives/farm_vars.py,sha256=JutO-rvlKwR6KWY2vTuEJEZundqqUy0w6X-JkP_hd5w,8984
-foxes/opt/objectives/max_n_turbines.py,sha256=59vbT0vsWYE5ui9J_SVBmbLKr6tNwrLQKNXkGI_VcIA,4149
-foxes/opt/problems/__init__.py,sha256=ZfyWlykuyeH5_XC0ebmvQtchwY1ZQS9-TxcHVr_-4Gw,103
-foxes/opt/problems/opt_farm_vars.py,sha256=xf__1gdqv6NDKjzn_Xmr_uRWx1YXXTqSDg5K7WRyDnE,19425
-foxes/opt/problems/layout/__init__.py,sha256=aou75vqe8bjhstQCK3Eemg8PLKtE2DCJt2Aw476i-YM,229
-foxes/opt/problems/layout/farm_layout.py,sha256=ui8LWoBrqHIGNqb7YtlH0e95AieaZTNZKK6qL4nrggw,3924
-foxes/opt/problems/layout/reggrids_layout.py,sha256=1xHXnBQPK_9w2mMsiVdp85WSu6IlQuPAjAFGZu5vA4w,11804
-foxes/opt/problems/layout/regular_layout.py,sha256=2EZWY43PfQ821vcMeYs9LarXt6gYDUiIV4ijBjs5HOY,10583
-foxes/opt/problems/layout/geom_layouts/__init__.py,sha256=8QpYPWdT2QA6laSL8t7nkqXApmEtu6A00-TXWn6j28g,386
-foxes/opt/problems/layout/geom_layouts/constraints.py,sha256=1pU7RlVTmDtQ2U1DqgBb66tET-xcWzTeGkYKBwnda2k,22624
-foxes/opt/problems/layout/geom_layouts/geom_layout.py,sha256=CRdta3H65mxdO705dVDImsWrl6U9f4dY40UVxVsXJd4,8164
-foxes/opt/problems/layout/geom_layouts/geom_layout_gridded.py,sha256=7vXKVkPOHj2rOKY1TzPLB9_rAOR6Iqp9z-8w-j5HNmU,7586
-foxes/opt/problems/layout/geom_layouts/geom_reggrid.py,sha256=muAquvY_VFNwh-dZ-pJ290X-91a87IW5sQQwUu86PZg,10104
-foxes/opt/problems/layout/geom_layouts/geom_reggrids.py,sha256=uKkmqENXniZFA-XpCYCw6F6CN1TP13ZRSaoO3jt3hGY,14222
-foxes/opt/problems/layout/geom_layouts/objectives.py,sha256=QtEjrnwiNasJlplJmVBJGR_Q3l3KhTGScwOA88o-t28,17834
 foxes/output/__init__.py,sha256=7JSbLw8oEI3f-aFDCQ11ygNLm9b--6va1vMBeCftlx8,675
 foxes/output/animation.py,sha256=zljekg6k2DjqVaBw0OamB4i3eopi6g2j0a12B9hx7VQ,2637
 foxes/output/calc_points.py,sha256=QRZuZ6joHbhkEYDBX87QgEWwMMYbohAK3ZFuVwErK3Q,4497
@@ -266,9 +240,9 @@ foxes/utils/geom2d/half_plane.py,sha256=kzZD6pkZxZ03MK9WAboWzXb5Ws5dWLQY9GIahD4D
 foxes/utils/geom2d/polygon.py,sha256=8ASfy7No_-Pt_xDSeNsDtLEkCjBWsNZK8nIxDQtqeOE,5534
 foxes/utils/runners/__init__.py,sha256=-WL4ZmdgNYldkqhCV6dR-aXCumBrH-Ea-V1shsRhsbs,55
 foxes/utils/runners/runners.py,sha256=Sc06qsCzPduMyxbywgf6G3uHRioDs1qWRSc6GZbLFAY,6932
-foxes-0.7.4.25.dist-info/LICENSE,sha256=bBCH6mYTPzSepk2s2UUZ3II_ZYXrn1bnSqB85-aZHxU,1071
-foxes-0.7.4.25.dist-info/METADATA,sha256=JcchAtLkIF8BTPLq753kYMbC8ENjZ6tECY6uMRRyT70,9569
-foxes-0.7.4.25.dist-info/WHEEL,sha256=y4mX-SOX4fYIkonsAGA5N0Oy-8_gI4FXw5HNI1xqvWg,91
-foxes-0.7.4.25.dist-info/top_level.txt,sha256=B4spGR6JHsVHz7CEXsa68xsjYalAA70nBwHa1gfyRHc,6
-foxes-0.7.4.25.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-foxes-0.7.4.25.dist-info/RECORD,,
+foxes-0.8.1.dist-info/LICENSE,sha256=bBCH6mYTPzSepk2s2UUZ3II_ZYXrn1bnSqB85-aZHxU,1071
+foxes-0.8.1.dist-info/METADATA,sha256=_f7NCLGS6rSP_jlZ4vbNdW1EgClDYwkEn0h0qD-Auy8,6619
+foxes-0.8.1.dist-info/WHEEL,sha256=y4mX-SOX4fYIkonsAGA5N0Oy-8_gI4FXw5HNI1xqvWg,91
+foxes-0.8.1.dist-info/top_level.txt,sha256=B4spGR6JHsVHz7CEXsa68xsjYalAA70nBwHa1gfyRHc,6
+foxes-0.8.1.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+foxes-0.8.1.dist-info/RECORD,,

foxes/opt/__init__.py

@@ -1,9 +0,0 @@
-"""
-Wind farm optimization.
-"""
-
-from .core import FarmOptProblem, FarmObjective, FarmConstraint
-
-from . import problems
-from . import constraints
-from . import objectives

foxes/opt/constraints/__init__.py

@@ -1,6 +0,0 @@
-"""
-Wind farm optimization constraints.
-"""
-
-from .area_geometry import AreaGeometryConstraint, FarmBoundaryConstraint
-from .min_dist import MinDistConstraint

foxes/opt/constraints/area_geometry.py

@@ -1,214 +0,0 @@
-import numpy as np
-
-from foxes.opt.core.farm_constraint import FarmConstraint
-import foxes.variables as FV
-
-
-class AreaGeometryConstraint(FarmConstraint):
-    """
-    Constrains turbine positions to the inside
-    of a given area geometry.
-
-    Attributes
-    ----------
-    farm: foxes.WindFarm
-        The wind farm
-    sel_turbines: list
-        The selected turbines
-    geometry: foxes.utils.geom2d.AreaGeometry
-        The area geometry
-    disc_inside: bool
-        Ensure full rotor disc inside boundary
-    D: float
-        Use this radius for rotor disc inside condition
-
-    :group: opt.constraints
-
-    """
-
-    def __init__(
-        self,
-        problem,
-        name,
-        geometry,
-        sel_turbines=None,
-        disc_inside=False,
-        D=None,
-        **kwargs,
-    ):
-        """
-        Constructor.
-
-        Parameters
-        ----------
-        problem : foxes.opt.FarmOptProblem
-            The underlying optimization problem
-        name : str
-            The name of the constraint
-        geometry : foxes.utils.geom2d.AreaGeometry
-            The area geometry
-        sel_turbines : list of int, optional
-            The selected turbines
-        disc_inside : bool
-            Ensure full rotor disc inside boundary
-        D : float, optional
-            Use this radius for rotor disc inside condition
-        kwargs : dict, optional
-            Additional parameters for `iwopy.Constraint`
-
-        """
-        self.geometry = geometry
-        self.disc_inside = disc_inside
-        self.D = D
-
-        selt = problem.sel_turbines if sel_turbines is None else sel_turbines
-        vrs = []
-        cns = []
-        for ti in selt:
-            vrs += [problem.tvar(FV.X, ti), problem.tvar(FV.Y, ti)]
-            cns.append(f"{name}_{ti:04d}")
-
-        super().__init__(
-            problem, name, sel_turbines, vnames_float=vrs, cnames=cns, **kwargs
-        )
-
-    def n_components(self):
-        """
-        Returns the number of components of the
-        function.
-
-        Returns
-        -------
-        int:
-            The number of components.
-
-        """
-        return self.n_sel_turbines
-
-    def vardeps_float(self):
-        """
-        Gets the dependencies of all components
-        on the function float variables
-
-        Returns
-        -------
-        deps: numpy.ndarray of bool
-            The dependencies of components on function
-            variables, shape: (n_components, n_vars_float)
-
-        """
-        deps = np.zeros((self.n_components(), self.n_components(), 2), dtype=bool)
-        np.fill_diagonal(deps[:, :, 0], True)
-        np.fill_diagonal(deps[:, :, 1], True)
-        return deps.reshape(self.n_components(), self.n_components() * 2)
-
-    def calc_individual(self, vars_int, vars_float, problem_results, components=None):
-        """
-        Calculate values for a single individual of the
-        underlying problem.
-
-        Parameters
-        ----------
-        vars_int: np.array
-            The integer variable values, shape: (n_vars_int,)
-        vars_float: np.array
-            The float variable values, shape: (n_vars_float,)
-        problem_results: Any
-            The results of the variable application
-            to the problem
-        components: list of int, optional
-            The selected components or None for all
-
-        Returns
-        -------
-        values: np.array
-            The component values, shape: (n_sel_components,)
-
-        """
-        s = np.s_[:]
-        if components is not None and len(components) < self.n_components():
-            s = components
-        xy = vars_float.reshape(self.n_components(), 2)[s]
-
-        dists = self.geometry.points_distance(xy)
-        dists[self.geometry.points_inside(xy)] *= -1
-
-        if self.disc_inside:
-            if self.D is None:
-                dists += problem_results[FV.D].to_numpy()[0, self.sel_turbines][s] / 2
-            else:
-                dists += self.D / 2
-
-        return dists
-
-    def calc_population(self, vars_int, vars_float, problem_results, components=None):
-        """
-        Calculate values for all individuals of a population.
-
-        Parameters
-        ----------
-        vars_int: np.array
-            The integer variable values, shape: (n_pop, n_vars_int)
-        vars_float: np.array
-            The float variable values, shape: (n_pop, n_vars_float)
-        problem_results: Any
-            The results of the variable application
-            to the problem
-        components: list of int, optional
-            The selected components or None for all
-
-        Returns
-        -------
-        values: np.array
-            The component values, shape: (n_pop, n_sel_components)
-
-        """
-        n_pop = len(vars_float)
-        n_cmpnts = self.n_components()
-        s = np.s_[:]
-        if components is not None and len(components) < self.n_components():
-            n_cmpnts = len(components)
-            s = components
-        xy = vars_float[:, s].reshape(n_pop * n_cmpnts, 2)
-
-        dists = self.geometry.points_distance(xy)
-        dists[self.geometry.points_inside(xy)] *= -1
-        dists = dists.reshape(n_pop, n_cmpnts)
-
-        if self.disc_inside:
-            if self.D is None:
-                dists += (
-                    problem_results[FV.D].to_numpy()[None, 0, self.sel_turbines][s] / 2
-                )
-            else:
-                dists += self.D / 2
-
-        return dists
-
-
-class FarmBoundaryConstraint(AreaGeometryConstraint):
-    """
-    Constrains turbine positions to the inside of
-    the wind farm boundary
-
-    :group: opt.constraints
-
-    """
-
-    def __init__(self, problem, name="boundary", **kwargs):
-        """
-        Constructor.
-
-        Parameters
-        ----------
-        problem: foxes.opt.FarmOptProblem
-            The underlying optimization problem
-        name: str
-            The name of the constraint
-        kwargs: dict, optional
-            Additional parameters for `AreaGeometryConstraint`
-
-        """
-        b = problem.farm.boundary
-        assert b is not None, f"Constraint '{name}': Missing wind farm boundary."
-        super().__init__(problem, name, geometry=b, **kwargs)