foxes 1.0__tar.gz → 1.6.1__tar.gz

{foxes-1.0 → foxes-1.6.1}/MANIFEST.in

@@ -5,4 +5,3 @@ include foxes/data/states/*.csv.gz
 include foxes/data/states/*.nc
 include foxes/data/states/*.tab
 include foxes/data/farms/*.csv
-include foxes/data/windio/*.yaml

{foxes-1.0/foxes.egg-info → foxes-1.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: foxes
-Version: 1.0
+Version: 1.6.1
 Summary: Farm Optimization and eXtended yield Evaluation Software
 Author: Jonas Schulte
 Maintainer: Jonas Schulte
@@ -36,66 +36,51 @@ 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: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Development Status :: 4 - Beta
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: matplotlib
-Requires-Dist: numpy
-Requires-Dist: pandas
-Requires-Dist: xarray
-Requires-Dist: scipy
-Requires-Dist: netcdf4
-Requires-Dist: windrose
-Requires-Dist: cycler
-Requires-Dist: tqdm
-Requires-Dist: pyyaml
-Provides-Extra: io
-Requires-Dist: windio>=1; extra == "io"
+Requires-Dist: matplotlib>=3.8
+Requires-Dist: numpy>=1.26
+Requires-Dist: pandas>=2.0
+Requires-Dist: scipy>=1.12
+Requires-Dist: xarray>=2023
+Requires-Dist: netcdf4>=1.0
+Requires-Dist: pyyaml>=4.0
+Requires-Dist: tqdm>=2.0
+Requires-Dist: utm>=0.5
 Provides-Extra: opt
-Requires-Dist: foxes-opt; extra == "opt"
+Requires-Dist: foxes-opt>=0.6; extra == "opt"
 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: 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: test
-Requires-Dist: flake8; extra == "test"
-Requires-Dist: pytest; extra == "test"
+Requires-Dist: dask>=2022.0; extra == "dask"
+Requires-Dist: distributed>=2022.0; extra == "dask"
+Requires-Dist: dask-jobqueue>=0.8; extra == "dask"
+Requires-Dist: setuptools>=61.0; extra == "dask"
 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"
-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"
+Requires-Dist: setuptools>=61.0; extra == "doc"
+Requires-Dist: sphinx>=5.0; extra == "doc"
+Requires-Dist: sphinx-immaterial>=0.10; extra == "doc"
+Requires-Dist: nbsphinx>=0.5; extra == "doc"
+Requires-Dist: ipykernel>=5.0; extra == "doc"
+Requires-Dist: ipywidgets>=5.0; extra == "doc"
+Requires-Dist: m2r2>=0.2; extra == "doc"
+Requires-Dist: lxml_html_clean>=0.4; extra == "doc"
+Requires-Dist: dask>=2022.0; extra == "doc"
+Requires-Dist: distributed>=2022.0; extra == "doc"
+Provides-Extra: test
+Requires-Dist: flake8>=0.1; extra == "test"
+Requires-Dist: pytest>=7.0; extra == "test"
+Provides-Extra: utils
+Requires-Dist: objsize>=0.5; extra == "utils"
+Dynamic: license-file
 
 # Welcome to foxes
 
@@ -113,10 +98,11 @@ The software `foxes` is a modular wind farm simulation and wake modelling toolbo
 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 
+[mpi4py](https://mpi4py.readthedocs.io/en/stable/) or
 [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.
+optimization capabilities invoke the [foxes-opt](https://github.com/FraunhoferIWES/foxes-opt) package which
+as well supports vectorization and parallelization.
 
 `foxes` is build upon many years of experience with wake model code development at IWES, starting with the C++ based in-house code _flapFOAM_ (2011-2019) and the Python based direct predecessor _flappy_ (2019-2022).
 
@@ -154,13 +140,7 @@ Evaluation Software"`
 
 ## Requirements
 
-The supported Python versions are: 
-
-- `Python 3.8`
-- `Python 3.9`
-- `Python 3.10`
-- `Python 3.11`
-- `Python 3.12`
+The supported Python versions are `Python 3.9`...`3.14`.
 
 ## Installation
 
@@ -183,15 +163,17 @@ For detailed examples of how to run _foxes_, check the `examples` and `notebooks
 ```python
 import foxes
 
-states = foxes.input.states.Timeseries("timeseries_3000.csv.gz", ["WS", "WD","TI","RHO"])
+if __name__ == "__main__":
+
+    states = foxes.input.states.Timeseries("timeseries_3000.csv.gz", ["WS", "WD","TI","RHO"])
 
-farm = foxes.WindFarm()
-foxes.input.farm_layout.add_from_file(farm, "test_farm_67.csv", turbine_models=["NREL5MW"])
+    farm = foxes.WindFarm()
+    foxes.input.farm_layout.add_from_file(farm, "test_farm_67.csv", turbine_models=["NREL5MW"])
 
-algo = foxes.algorithms.Downwind(farm, states, ["Jensen_linear_k007"])
-farm_results = algo.calc_farm()
+    algo = foxes.algorithms.Downwind(farm, states, ["Jensen_linear_k007"])
+    farm_results = algo.calc_farm()
 
-print(farm_results)
+    print(farm_results)
 ```
 
 ## Testing

{foxes-1.0 → foxes-1.6.1}/README.md

@@ -14,10 +14,11 @@ The software `foxes` is a modular wind farm simulation and wake modelling toolbo
 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 
+[mpi4py](https://mpi4py.readthedocs.io/en/stable/) or
 [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.
+optimization capabilities invoke the [foxes-opt](https://github.com/FraunhoferIWES/foxes-opt) package which
+as well supports vectorization and parallelization.
 
 `foxes` is build upon many years of experience with wake model code development at IWES, starting with the C++ based in-house code _flapFOAM_ (2011-2019) and the Python based direct predecessor _flappy_ (2019-2022).
 
@@ -55,13 +56,7 @@ Evaluation Software"`
 
 ## Requirements
 
-The supported Python versions are: 
-
-- `Python 3.8`
-- `Python 3.9`
-- `Python 3.10`
-- `Python 3.11`
-- `Python 3.12`
+The supported Python versions are `Python 3.9`...`3.14`.
 
 ## Installation
 
@@ -84,15 +79,17 @@ For detailed examples of how to run _foxes_, check the `examples` and `notebooks
 ```python
 import foxes
 
-states = foxes.input.states.Timeseries("timeseries_3000.csv.gz", ["WS", "WD","TI","RHO"])
+if __name__ == "__main__":
+
+    states = foxes.input.states.Timeseries("timeseries_3000.csv.gz", ["WS", "WD","TI","RHO"])
 
-farm = foxes.WindFarm()
-foxes.input.farm_layout.add_from_file(farm, "test_farm_67.csv", turbine_models=["NREL5MW"])
+    farm = foxes.WindFarm()
+    foxes.input.farm_layout.add_from_file(farm, "test_farm_67.csv", turbine_models=["NREL5MW"])
 
-algo = foxes.algorithms.Downwind(farm, states, ["Jensen_linear_k007"])
-farm_results = algo.calc_farm()
+    algo = foxes.algorithms.Downwind(farm, states, ["Jensen_linear_k007"])
+    farm_results = algo.calc_farm()
 
-print(farm_results)
+    print(farm_results)
 ```
 
 ## Testing

{foxes-1.0 → foxes-1.6.1}/docs/source/conf.py

@@ -22,7 +22,7 @@ from foxes import __version__
 # -- Project information -----------------------------------------------------
 
 project = "foxes"
-copyright = "2024, Fraunhofer IWES"
+copyright = "2025, Fraunhofer IWES"
 author = "Fraunhofer IWES"
 
 # The short X.Y version
@@ -67,9 +67,8 @@ intersphinx_mapping = {
 # autosummary_generate = False
 
 # The suffix(es) of source filenames.
-# You can specify multiple suffix as a list of string:
 #
-source_suffix = [".rst", ".md"]
+source_suffix = {".rst": "restructuredtext", ".md": "restructuredtext"}
 
 # The master toctree document.
 master_doc = "index"
@@ -314,13 +313,15 @@ python_apigen_modules = {
     "foxes.algorithms.iterative.models": "_foxes/algorithms/iterative/models/",
     "foxes.algorithms.sequential": "_foxes/algorithms/sequential/",
     "foxes.algorithms.sequential.models": "_foxes/algorithms/sequential/models/",
+    "foxes.config": "_foxes/config/",
     "foxes.core": "_foxes/core/",
     "foxes.data": "_foxes/data/",
     "foxes.engines": "_foxes/engines/",
     "foxes.input.farm_layout": "_foxes/input/farm_layout/",
     "foxes.input.states": "_foxes/input/states/",
     "foxes.input.states.create": "_foxes/input/states/create/",
-    "foxes.input.windio": "_foxes/input/windio/",
+    "foxes.input.yaml": "_foxes/input/yaml/",
+    "foxes.input.yaml.windio": "_foxes/input/yaml/windio/",
     "foxes.output": "_foxes/output/",
     "foxes.output.flow_plots_2d": "_foxes/output/flow_plots_2d/",
     "foxes.output.seq_plugins": "_foxes/output/seq_plugins/",
@@ -335,6 +336,7 @@ python_apigen_modules = {
     "foxes.models.vertical_profiles": "_foxes/models/vertical_profiles/",
     "foxes.models.axial_induction": "_foxes/models/axial_induction",
     "foxes.models.ground_models": "_foxes/models/ground_models",
+    "foxes.models.wake_deflections": "_foxes/models/wake_deflections",
     "foxes.models.wake_frames": "_foxes/models/wake_frames/",
     "foxes.models.wake_models": "_foxes/models/wake_models/",
     "foxes.models.wake_models.induction": "_foxes/models/wake_models/induction/",
@@ -344,7 +346,6 @@ python_apigen_modules = {
     "foxes.utils": "_foxes/utils/",
     "foxes.utils.abl": "_foxes/utils/abl",
     "foxes.utils.geom2d": "_foxes/utils/geom2d/",
-    "foxes.utils.runners": "_foxes/utils/runners/",
     "foxes.utils.two_circles": "_foxes/utils/two_circles/",
     "foxes.utils.abl.neutral": "_foxes/utils/abl/neutral/",
     "foxes.utils.abl.stable": "_foxes/utils/abl/stable/",

{foxes-1.0 → foxes-1.6.1}/examples/abl_states/run.py

@@ -91,70 +91,72 @@ if __name__ == "__main__":
         wake_frame="rotor_wd",
         partial_wakes=args.pwakes,
         mbook=mbook,
-        engine=args.engine,
+    )
+
+    with foxes.Engine.new(
+        engine_type=args.engine,
         n_procs=args.n_cpus,
         chunk_size_states=args.chunksize_states,
         chunk_size_points=args.chunksize_points,
-    )
-
-    time0 = time.time()
-    farm_results = algo.calc_farm()
-    time1 = time.time()
+    ):
+        time0 = time.time()
+        farm_results = algo.calc_farm()
+        time1 = time.time()
 
-    print("\nCalc time =", time1 - time0, "\n")
+        print("\nCalc time =", time1 - time0, "\n")
 
-    print(farm_results)
+        print(farm_results)
 
-    fr = farm_results.to_dataframe()
-    print(fr[[FV.WD, FV.H, FV.AMB_REWS, FV.REWS, FV.AMB_P, FV.P]])
+        fr = farm_results.to_dataframe()
+        print(fr[[FV.WD, FV.H, FV.AMB_REWS, FV.REWS, FV.AMB_P, FV.P]])
 
-    o = foxes.output.FarmResultsEval(farm_results)
-    o = foxes.output.FarmResultsEval(farm_results)
-    o.add_capacity(algo)
-    o.add_capacity(algo, ambient=True)
-    o.add_efficiency()
+        o = foxes.output.FarmResultsEval(farm_results)
+        o = foxes.output.FarmResultsEval(farm_results)
+        o.add_capacity(algo)
+        o.add_capacity(algo, ambient=True)
+        o.add_efficiency()
 
-    # state-turbine results
-    farm_df = farm_results.to_dataframe()
-    print("\nFarm results data:\n")
-    print(
-        farm_df[
-            [
-                FV.X,
-                FV.WD,
-                FV.AMB_REWS,
-                FV.REWS,
-                FV.AMB_TI,
-                FV.TI,
-                FV.AMB_P,
-                FV.P,
-                FV.EFF,
+        # state-turbine results
+        farm_df = farm_results.to_dataframe()
+        print("\nFarm results data:\n")
+        print(
+            farm_df[
+                [
+                    FV.X,
+                    FV.WD,
+                    FV.AMB_REWS,
+                    FV.REWS,
+                    FV.AMB_TI,
+                    FV.TI,
+                    FV.AMB_P,
+                    FV.P,
+                    FV.EFF,
+                ]
             ]
-        ]
-    )
-    print()
+        )
+        print()
 
-    # results by turbine
-    turbine_results = o.reduce_states(
-        {
-            FV.AMB_P: "mean",
-            FV.P: "mean",
-            FV.AMB_CAP: "mean",
-            FV.CAP: "mean",
-            FV.EFF: "mean",
-        }
-    )
-    turbine_results[FV.AMB_YLD] = o.calc_turbine_yield(
-        algo=algo, annual=True, ambient=True
-    )
-    turbine_results[FV.YLD] = o.calc_turbine_yield(algo=algo, annual=True)
-    print("\nResults by turbine:\n")
-    print(turbine_results)
+        # results by turbine
+        turbine_results = o.reduce_states(
+            {
+                FV.AMB_P: "weights",
+                FV.P: "weights",
+                FV.AMB_CAP: "weights",
+                FV.CAP: "weights",
+            }
+        )
+        turbine_results[FV.AMB_YLD] = o.calc_turbine_yield(
+            algo=algo, annual=True, ambient=True
+        )
+        turbine_results[FV.YLD] = o.calc_turbine_yield(algo=algo, annual=True)
+        turbine_results[FV.EFF] = turbine_results[FV.P] / turbine_results[FV.AMB_P]
+        print("\nResults by turbine:\n")
+        print(turbine_results)
 
-    # power results
-    P0 = o.calc_mean_farm_power(ambient=True)
-    P = o.calc_mean_farm_power()
-    print(f"\nFarm power        : {P/1000:.1f} MW")
-    print(f"Farm ambient power: {P0/1000:.1f} MW")
-    print(f"Farm efficiency   : {o.calc_farm_efficiency():.2f}")
-    print(f"Annual farm yield : {turbine_results[FV.YLD].sum():.2f} GWh.")
+        # power results
+        P0 = o.calc_mean_farm_power(ambient=True)
+        P = o.calc_mean_farm_power()
+        print(f"\nFarm power        : {P / 1000:.1f} MW")
+        print(f"Farm ambient power: {P0 / 1000:.1f} MW")
+        print(f"Farm efficiency   : {o.calc_farm_efficiency():.2f}")
+        print(f"Annual farm yield : {turbine_results[FV.YLD].sum():.2f} GWh.")

{foxes-1.0 → foxes-1.6.1}/examples/compare_rotors_pwakes/run.py

@@ -203,7 +203,7 @@ if __name__ == "__main__":
 
         else:
             raise ValueError(
-                f"Please either give one rotor, or one pwake, or same number of both"
+                "Please either give one rotor, or one pwake, or same number of both"
             )
 
     if args.title is not None:

{foxes-1.0 → foxes-1.6.1}/examples/compare_wakes/run.py

@@ -7,7 +7,6 @@ import foxes.variables as FV
 
 
 def calc(mbook, farm, states, wakes, points, args):
-
     algo = foxes.algorithms.Downwind(
         farm,
         states,
@@ -232,7 +231,7 @@ if __name__ == "__main__":
                 ax.plot(xlist / D, results[0], label=wake)
                 ax.set_ylabel(args.var)
 
-            ax.set_title(f"y = 0")
+            ax.set_title("y = 0")
             ax.set_xlabel("x/D")
             ax.legend(loc="best")
             ax.grid()