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

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"
@@ -337,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/",

examples/abl_states/run.py

@@ -154,7 +154,7 @@ if __name__ == "__main__":
     # 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"\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.")

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:

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()

examples/dyn_wakes/run.py

@@ -73,7 +73,6 @@ if __name__ == "__main__":
     parser.add_argument(
         "-p", "--pwakes", help="The partial wakes models", default=None, nargs="+"
     )
-    parser.add_argument("-sc", "--scheduler", help="The scheduler choice", default=None)
     parser.add_argument(
         "-w",
         "--wakes",
@@ -82,6 +81,16 @@ if __name__ == "__main__":
         nargs="+",
     )
     parser.add_argument("-f", "--frame", help="The wake frame", default="dyn_wakes")
+    parser.add_argument(
+        "-d", "--deflection", help="The wake deflection", default="no_deflection"
+    )
+    parser.add_argument(
+        "-y",
+        "--yawm",
+        help="The uniform yaw misalignment value",
+        type=float,
+        default=None,
+    )
     parser.add_argument(
         "-m", "--tmodels", help="The turbine models", default=[], nargs="+"
     )
@@ -121,6 +130,19 @@ if __name__ == "__main__":
         max_length_km=8
     )
 
+    # optionally set turbines in yaw:
+    N = int(args.n_turbines**0.5)
+    if args.yawm is None:
+        ymodels = []
+    else:
+        yawm = np.zeros((1, N * N), dtype=np.float64)
+        yawm[:, :N] = args.yawm
+        mbook.turbine_models["set_yawm"] = foxes.models.turbine_models.SetFarmVars(
+            pre_rotor=True
+        )
+        mbook.turbine_models["set_yawm"].add_var(FV.YAWM, yawm)
+        ymodels = ["set_yawm"]
+
     if args.background0:
         States = foxes.input.states.Timeseries
         kwargs = {}
@@ -147,13 +169,12 @@ if __name__ == "__main__":
     )
 
     farm = foxes.WindFarm()
-    N = int(args.n_turbines**0.5)
     foxes.input.farm_layout.add_grid(
         farm,
         xy_base=np.array([0.0, 0.0]),
         step_vectors=np.array([[1000.0, 0], [0, 800.0]]),
         steps=(N, N),
-        turbine_models=args.tmodels + [ttype.name],
+        turbine_models=ymodels + args.tmodels + [ttype.name],
     )
 
     if not args.nofig and args.show_layout:
@@ -175,6 +196,7 @@ if __name__ == "__main__":
         rotor_model=args.rotor,
         wake_models=args.wakes,
         wake_frame=args.frame,
+        wake_deflection=args.deflection,
         partial_wakes=args.pwakes,
         mbook=mbook,
         max_it=args.max_it,
@@ -221,9 +243,9 @@ if __name__ == "__main__":
     # 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()*100:.2f} %")
+    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() * 100:.2f} %")
 
     engine.finalize()
 
@@ -262,6 +284,7 @@ if __name__ == "__main__":
             title=None,
             animated=True,
             precalc=True,
+            rotor_color="red",
         )
         next(ofg)
 

examples/induction/run.py

@@ -147,9 +147,9 @@ if __name__ == "__main__":
     # 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()*100:.2f} %")
+    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() * 100:.2f} %")
     print(f"Annual farm yield : {turbine_results[FV.YLD].sum():.2f} GWh.")
 
     # horizontal flow plot

examples/multi_height/run.py

@@ -110,4 +110,4 @@ if __name__ == "__main__":
     o = foxes.output.FarmResultsEval(farm_results)
     P0 = o.calc_mean_farm_power(ambient=True)
     P = o.calc_mean_farm_power()
-    print(f"\nFarm power: {P/1000:.1f} MW, Efficiency = {P/P0*100:.2f} %")
+    print(f"\nFarm power: {P / 1000:.1f} MW, Efficiency = {P / P0 * 100:.2f} %")

examples/power_mask/run.py

@@ -162,7 +162,7 @@ if __name__ == "__main__":
         o = foxes.output.FarmResultsEval(farm_results)
         P0 = o.calc_mean_farm_power(ambient=True)
         P = o.calc_mean_farm_power()
-        print(f"\nFarm power: {P/1000:.1f} MW, Efficiency = {P/P0*100:.2f} %")
+        print(f"\nFarm power: {P / 1000:.1f} MW, Efficiency = {P / P0 * 100:.2f} %")
 
         o1 = foxes.output.StateTurbineMap(farm_results)
 
@@ -180,7 +180,7 @@ if __name__ == "__main__":
         o = foxes.output.FarmResultsEval(farm_results)
         P0 = o.calc_mean_farm_power(ambient=True)
         P = o.calc_mean_farm_power()
-        print(f"\nFarm power: {P/1000:.1f} MW, Efficiency = {P/P0*100:.2f} %")
+        print(f"\nFarm power: {P / 1000:.1f} MW, Efficiency = {P / P0 * 100:.2f} %")
 
         if not args.nofig:
             o0 = foxes.output.StateTurbineMap(farm_results)

examples/quickstart/run.py

@@ -0,0 +1,16 @@
+import foxes
+
+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"]
+    )
+
+    algo = foxes.algorithms.Downwind(farm, states, ["Jensen_linear_k007"])
+    farm_results = algo.calc_farm()
+
+    print(farm_results)

examples/random_timeseries/run.py

@@ -99,7 +99,6 @@ if __name__ == "__main__":
         chunk_size_states=args.chunksize_states,
         chunk_size_points=args.chunksize_points,
     ):
-
         if not args.nofig:
             fig = plt.figure(figsize=(14.5, 7))
             ax1 = fig.add_subplot(121)
@@ -204,7 +203,7 @@ if __name__ == "__main__":
         # 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()*100:.2f} %")
+        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() * 100:.2f} %")
         print(f"Annual farm yield : {turbine_results[FV.YLD].sum():.2f} GWh")

examples/scan_row/run.py

@@ -161,9 +161,9 @@ if __name__ == "__main__":
     # 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()*100:.2f} %")
+    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() * 100:.2f} %")
     print(f"Annual farm yield : {turbine_results[FV.YLD].sum():.2f} GWh.")
     print()
 

examples/sequential/run.py

@@ -24,9 +24,7 @@ if __name__ == "__main__":
         type=int,
         default=4,
     )
-    parser.add_argument(
-        "-d", "--debug", help="Switch on wake debugging", action="store_true"
-    )
+    parser.add_argument("--debug", help="Switch on wake debugging", action="store_true")
     parser.add_argument(
         "-S",
         "--n_states",
@@ -83,6 +81,16 @@ if __name__ == "__main__":
         type=float,
     )
     parser.add_argument("-e", "--engine", help="The engine", default="NumpyEngine")
+    parser.add_argument(
+        "-d", "--deflection", help="The wake deflection", default="no_deflection"
+    )
+    parser.add_argument(
+        "-y",
+        "--yawm",
+        help="The uniform yaw misalignment value",
+        type=float,
+        default=None,
+    )
     parser.add_argument(
         "-n", "--n_cpus", help="The number of cpus", default=None, type=int
     )
@@ -109,21 +117,34 @@ if __name__ == "__main__":
     ttype = foxes.models.turbine_types.PCtFile(args.turbine_file)
     mbook.turbine_types[ttype.name] = ttype
 
+    # optionally set turbines in yaw:
+    N = 3
+    if args.yawm is None:
+        ymodels = []
+    else:
+        yawm = np.zeros((args.n_states, N * N), dtype=np.float64)
+        yawm[:, :N] = args.yawm
+        mbook.turbine_models["set_yawm"] = foxes.models.turbine_models.SetFarmVars(
+            pre_rotor=True
+        )
+        mbook.turbine_models["set_yawm"].add_var(FV.YAWM, yawm)
+        ymodels = ["set_yawm"]
+
     states = foxes.input.states.Timeseries(
         data_source="timeseries_3000.csv.gz",
         output_vars=[FV.WS, FV.WD, FV.TI, FV.RHO],
-        var2col={FV.WS: "WS", FV.WD: "WD", FV.TI: "TI", FV.RHO: "RHO"},
+        # fixed_vars={FV.WD: 270},
+        var2col={FV.WD: "WD", FV.WS: "WS", FV.TI: "TI", FV.RHO: "RHO"},
         states_sel=range(240, 240 + args.n_states),
     )
 
     farm = foxes.WindFarm()
-    N = 3
     foxes.input.farm_layout.add_grid(
         farm,
         xy_base=np.array([0.0, 0.0]),
         step_vectors=np.array([[1000.0, 0], [0, 800.0]]),
         steps=(N, N),
-        turbine_models=args.tmodels + [ttype.name],
+        turbine_models=ymodels + args.tmodels + [ttype.name],
     )
 
     if not args.nofig and args.show_layout:
@@ -143,6 +164,7 @@ if __name__ == "__main__":
             rotor_model=args.rotor,
             wake_models=args.wakes,
             wake_frame=args.frame,
+            wake_deflection=args.deflection,
             partial_wakes=args.pwakes,
             mbook=mbook,
             verbosity=0,
@@ -157,14 +179,15 @@ if __name__ == "__main__":
                 levels=None,
                 quiver_pars=dict(scale=0.01),
                 quiver_n=307,
-                xmin=-5000,
-                ymin=-5000,
-                xmax=7000,
-                ymax=7000,
+                xmin=-1000,
+                ymin=-1000,
+                xmax=4000,
+                ymax=3000,
                 vmin=0,
                 vmax=args.max_variable,
                 title=None,
                 animated=True,
+                rotor_color="red",
             )
             algo.plugins.append(anigen)
 

examples/single_state/run.py

@@ -172,13 +172,12 @@ if __name__ == "__main__":
     # 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()*100:.2f} %")
+    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() * 100:.2f} %")
     print(f"Annual farm yield : {turbine_results[FV.YLD].sum():.2f} GWh.")
 
     if not args.nofig:
-
         # horizontal flow plot
         o = foxes.output.FlowPlots2D(algo, farm_results)
         g = o.gen_states_fig_xy(

examples/states_lookup_table/run.py

@@ -131,7 +131,7 @@ if __name__ == "__main__":
     o = foxes.output.FarmResultsEval(farm_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()*100:.2f} %")
+    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() * 100:.2f} %")
     print(f"Annual farm yield : {o.calc_farm_yield(algo=algo):.2f} GWh")

examples/streamline_wakes/run.py

@@ -25,7 +25,16 @@ if __name__ == "__main__":
     parser.add_argument(
         "-p", "--pwakes", help="The partial wakes models", default="centre", nargs="+"
     )
-    parser.add_argument("-sc", "--scheduler", help="The scheduler choice", default=None)
+    parser.add_argument(
+        "-d", "--deflection", help="The wake deflection", default="no_deflection"
+    )
+    parser.add_argument(
+        "-y",
+        "--yawm",
+        help="The uniform yaw misalignment value",
+        type=float,
+        default=None,
+    )
     parser.add_argument(
         "-w",
         "--wakes",
@@ -45,7 +54,7 @@ if __name__ == "__main__":
     parser.add_argument(
         "-lm",
         "--load_mode",
-        help="Do load mode",
+        help="Dataset load mode",
         default="preload",
     )
     parser.add_argument("-e", "--engine", help="The engine", default="process")
@@ -75,6 +84,19 @@ if __name__ == "__main__":
     ttype = foxes.models.turbine_types.PCtFile(args.turbine_file)
     mbook.turbine_types[ttype.name] = ttype
 
+    # optionally set turbines in yaw:
+    N = int(args.n_turbines**0.5)
+    if args.yawm is None:
+        ymodels = []
+    else:
+        yawm = np.zeros((1, N * N), dtype=np.float64)
+        yawm[:, :N] = args.yawm
+        mbook.turbine_models["set_yawm"] = foxes.models.turbine_models.SetFarmVars(
+            pre_rotor=True
+        )
+        mbook.turbine_models["set_yawm"].add_var(FV.YAWM, yawm)
+        ymodels = ["set_yawm"]
+
     states = foxes.input.states.FieldDataNC(
         args.file_pattern,
         states_coord="state",
@@ -90,13 +112,12 @@ if __name__ == "__main__":
     )
 
     farm = foxes.WindFarm()
-    N = int(args.n_turbines**0.5)
     foxes.input.farm_layout.add_grid(
         farm,
         xy_base=np.array([500.0, 500.0]),
         step_vectors=np.array([[500.0, 0], [0, 500.0]]),
         steps=(N, N),
-        turbine_models=args.tmodels + [ttype.name],
+        turbine_models=ymodels + args.tmodels + [ttype.name],
     )
 
     algo = foxes.algorithms.Downwind(
@@ -105,6 +126,7 @@ if __name__ == "__main__":
         rotor_model=args.rotor,
         wake_models=args.wakes,
         wake_frame=args.wake_frame,
+        wake_deflection=args.deflection,
         partial_wakes=args.pwakes,
         mbook=mbook,
         engine=args.engine,
@@ -136,6 +158,7 @@ if __name__ == "__main__":
             xmax=2500,
             ymin=0,
             ymax=2500,
+            rotor_color="red",
         ):
             plt.show()
             plt.close(fig)

examples/tab_file/run.py

@@ -131,9 +131,9 @@ if __name__ == "__main__":
         o = foxes.output.FarmResultsEval(farm_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()*100:.2f} %")
+        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() * 100:.2f} %")
         print(f"Annual farm yield : {o.calc_farm_yield(algo=algo):.2f} GWh")
 
         if not args.nofig and args.calc_mean:

examples/timelines/run.py

@@ -66,7 +66,6 @@ if __name__ == "__main__":
     parser.add_argument(
         "-p", "--pwakes", help="The partial wakes models", default=None, nargs="+"
     )
-    parser.add_argument("-sc", "--scheduler", help="The scheduler choice", default=None)
     parser.add_argument(
         "-w",
         "--wakes",
@@ -75,6 +74,16 @@ if __name__ == "__main__":
         nargs="+",
     )
     parser.add_argument("-f", "--frame", help="The wake frame", default="timelines")
+    parser.add_argument(
+        "-d", "--deflection", help="The wake deflection", default="no_deflection"
+    )
+    parser.add_argument(
+        "-y",
+        "--yawm",
+        help="The uniform yaw misalignment value",
+        type=float,
+        default=None,
+    )
     parser.add_argument(
         "-m", "--tmodels", help="The turbine models", default=[], nargs="+"
     )
@@ -111,6 +120,19 @@ if __name__ == "__main__":
     ttype = foxes.models.turbine_types.PCtFile(args.turbine_file)
     mbook.turbine_types[ttype.name] = ttype
 
+    # optionally set turbines in yaw:
+    N = int(args.n_turbines**0.5)
+    if args.yawm is None:
+        ymodels = []
+    else:
+        yawm = np.zeros((1, N * N), dtype=np.float64)
+        yawm[:, :N] = args.yawm
+        mbook.turbine_models["set_yawm"] = foxes.models.turbine_models.SetFarmVars(
+            pre_rotor=True
+        )
+        mbook.turbine_models["set_yawm"].add_var(FV.YAWM, yawm)
+        ymodels = ["set_yawm"]
+
     if not args.background:
         States = foxes.input.states.Timeseries
         kwargs = {}
@@ -134,7 +156,7 @@ if __name__ == "__main__":
         xy_base=np.array([0.0, 0.0]),
         step_vectors=np.array([[1000.0, 0], [0, 800.0]]),
         steps=(N, N),
-        turbine_models=args.tmodels + [ttype.name],
+        turbine_models=ymodels + args.tmodels + [ttype.name],
     )
 
     if not args.nofig and args.show_layout:
@@ -148,6 +170,7 @@ if __name__ == "__main__":
         rotor_model=args.rotor,
         wake_models=args.wakes,
         wake_frame=args.frame,
+        wake_deflection=args.deflection,
         partial_wakes=args.pwakes,
         mbook=mbook,
         engine=args.engine,
@@ -196,9 +219,9 @@ if __name__ == "__main__":
     # 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()*100:.2f} %")
+    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() * 100:.2f} %")
 
     if not args.nofig:
         sts = np.arange(farm_results.sizes["state"])
@@ -232,6 +255,7 @@ if __name__ == "__main__":
                 ret_im=True,
                 title=None,
                 animated=True,
+                rotor_color="red",
             )
         )
         anim.add_generator(

examples/timeseries/run.py

@@ -177,9 +177,9 @@ if __name__ == "__main__":
     # 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()*100:.2f} %")
+    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() * 100:.2f} %")
     print(f"Annual farm yield : {turbine_results[FV.YLD].sum():.2f} GWh")
 
     engine.finalize()

examples/timeseries_slurm/run.py

@@ -179,7 +179,7 @@ if __name__ == "__main__":
         # 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()*100:.2f} %")
+        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() * 100:.2f} %")
         print(f"Annual farm yield : {turbine_results[FV.YLD].sum():.2f} GWh")

examples/wind_rose/run.py

@@ -130,9 +130,9 @@ if __name__ == "__main__":
     o = foxes.output.FarmResultsEval(farm_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()*100:.2f} %")
+    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() * 100:.2f} %")
     print(f"Annual farm yield : {o.calc_farm_yield(algo=algo):.2f} GWh")
 
     if not args.nofig and args.calc_mean:

examples/yawed_wake/run.py

@@ -34,18 +34,24 @@ if __name__ == "__main__":
         "-w",
         "--wakes",
         help="The wake models",
-        default=["Bastankhah2016_linear_ka02", "CrespoHernandez_quadratic_ka04"],
+        default=["TurbOPark_vector_ambka004", "CrespoHernandez_quadratic_ambka04"],
         nargs="+",
     )
+    parser.add_argument(
+        "-d", "--deflection", help="The wake deflection", default="Jimenez"
+    )
     parser.add_argument("-r", "--rotor", help="The rotor model", default="centre")
     parser.add_argument(
         "-p", "--pwakes", help="The partial wakes models", default=None, nargs="+"
     )
-    parser.add_argument("-f", "--frame", help="The wake frame", default="yawed")
+    parser.add_argument("-f", "--frame", help="The wake frame", default="rotor_wd")
     parser.add_argument(
         "-m", "--tmodels", help="The turbine models", default=[], nargs="+"
     )
     parser.add_argument("-v", "--var", help="The plot variable", default=FV.WS)
+    parser.add_argument(
+        "-it", "--iterative", help="Use iterative algorithm", action="store_true"
+    )
     parser.add_argument("-e", "--engine", help="The engine", default="process")
     parser.add_argument(
         "-n", "--n_cpus", help="The number of cpus", default=None, type=int
@@ -96,12 +102,14 @@ if __name__ == "__main__":
     )
 
     # create algorithm
-    algo = foxes.algorithms.Downwind(
+    Algo = foxes.algorithms.Iterative if args.iterative else foxes.algorithms.Downwind
+    algo = Algo(
         farm,
         states=states,
         rotor_model=args.rotor,
         wake_models=args.wakes,
         wake_frame=args.frame,
+        wake_deflection=args.deflection,
         partial_wakes=args.pwakes,
         mbook=mbook,
         engine=args.engine,
@@ -119,7 +127,7 @@ if __name__ == "__main__":
         print("\nHorizontal flow figure output:")
         o = foxes.output.FlowPlots2D(algo, farm_results)
         g = o.gen_states_fig_xy(
-            args.var, resolution=10, xmin=-100, xmax=3000, rotor_color="red"
+            args.var, resolution=10, xmin=-500, xmax=3000, rotor_color="red"
         )
         fig = next(g)
         plt.show()
@@ -130,7 +138,7 @@ if __name__ == "__main__":
         o = foxes.output.FlowPlots2D(algo, farm_results)
         g = o.gen_states_fig_yz(
             args.var,
-            resolution=10,
+            resolution=5,
             x=750,
             ymin=-200,
             ymax=200,
@@ -190,7 +198,7 @@ if __name__ == "__main__":
     # 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()*100:.2f} %")
+    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() * 100:.2f} %")
     print(f"Annual farm yield : {turbine_results[FV.YLD].sum():.2f} GWh.")