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

examples/single_state/run.py

@@ -0,0 +1,201 @@
+import numpy as np
+import argparse
+import matplotlib.pyplot as plt
+
+import foxes
+import foxes.variables as FV
+
+if __name__ == "__main__":
+    # define arguments and options:
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        "-nt", "--n_t", help="The number of turbines", type=int, default=5
+    )
+    parser.add_argument(
+        "-l",
+        "--layout",
+        help="The wind farm layout file (path or static)",
+        default=None,
+    )
+    parser.add_argument("--ws", help="The wind speed", type=float, default=9.0)
+    parser.add_argument("--wd", help="The wind direction", type=float, default=270.0)
+    parser.add_argument("--ti", help="The TI value", type=float, default=0.08)
+    parser.add_argument("--rho", help="The air density", type=float, default=1.225)
+    parser.add_argument(
+        "-dx", "--deltax", help="The turbine distance in x", type=float, default=800.0
+    )
+    parser.add_argument(
+        "-dy", "--deltay", help="Turbine layout y step", type=float, default=0.0
+    )
+    parser.add_argument(
+        "-t",
+        "--turbine_file",
+        help="The P-ct-curve csv file (path or static)",
+        default="NREL-5MW-D126-H90.csv",
+    )
+    parser.add_argument(
+        "-m",
+        "--tmodels",
+        help="The turbine models",
+        default=[],
+        nargs="+",
+    )
+    parser.add_argument(
+        "-w",
+        "--wakes",
+        help="The wake models",
+        default=["Bastankhah2014_linear_k004", "CrespoHernandez_quadratic_ambka04"],
+        nargs="+",
+    )
+    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(
+        "-g", "--grounds", help="The ground models", default=None, nargs="+"
+    )
+    parser.add_argument("-f", "--frame", help="The wake frame", default="rotor_wd")
+    parser.add_argument("-v", "--var", help="The plot variable", default=FV.WS)
+    parser.add_argument("-e", "--engine", help="The engine", default=None)
+    parser.add_argument(
+        "-n", "--n_cpus", help="The number of cpus", default=None, type=int
+    )
+    parser.add_argument(
+        "-C",
+        "--chunksize_points",
+        help="The chunk size for points",
+        default=None,
+        type=int,
+    )
+    parser.add_argument(
+        "-it", "--iterative", help="Use iterative algorithm", action="store_true"
+    )
+    parser.add_argument(
+        "-nf", "--nofig", help="Do not show figures", action="store_true"
+    )
+    args = parser.parse_args()
+
+    # create model book
+    mbook = foxes.ModelBook()
+    ttype = foxes.models.turbine_types.PCtFile(args.turbine_file)
+    mbook.turbine_types[ttype.name] = ttype
+
+    # create states
+    states = foxes.input.states.SingleStateStates(
+        ws=args.ws,
+        wd=args.wd,
+        ti=args.ti,
+        rho=args.rho,
+    )
+
+    # create wind farm
+    print("\nCreating wind farm")
+    farm = foxes.WindFarm()
+    if args.layout is None:
+        foxes.input.farm_layout.add_row(
+            farm=farm,
+            xy_base=np.array([0.0, 0.0]),
+            xy_step=np.array([args.deltax, args.deltay]),
+            n_turbines=args.n_t,
+            turbine_models=args.tmodels + [ttype.name],
+        )
+    else:
+        foxes.input.farm_layout.add_from_file(
+            farm, args.layout, turbine_models=args.tmodels + [ttype.name]
+        )
+
+    # create algorithm
+    Algo = foxes.algorithms.Iterative if args.iterative else foxes.algorithms.Downwind
+    algo = Algo(
+        farm,
+        states,
+        rotor_model=args.rotor,
+        wake_models=args.wakes,
+        wake_frame=args.frame,
+        partial_wakes=args.pwakes,
+        ground_models=args.grounds,
+        mbook=mbook,
+        engine=args.engine,
+        n_procs=args.n_cpus,
+        chunk_size_points=args.chunksize_points,
+        verbosity=1,
+    )
+
+    farm_results = algo.calc_farm()
+    print("\nResults data:\n", farm_results)
+
+    # add capacity and efficiency to 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.ORDER,
+                FV.WD,
+                FV.AMB_REWS,
+                FV.REWS,
+                FV.AMB_TI,
+                FV.TI,
+                FV.AMB_P,
+                FV.P,
+                FV.CT,
+                FV.EFF,
+            ]
+        ]
+    )
+    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)
+
+    # 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"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(
+            args.var, resolution=10, rotor_color="red", figsize=(10, 3)
+        )
+        fig = next(g)
+        plt.show()
+        plt.close(fig)
+
+        # vertical flow plot
+        o = foxes.output.FlowPlots2D(algo, farm_results)
+        g = o.gen_states_fig_xz(
+            args.var,
+            resolution=10,
+            x_direction=np.mod(args.wd, 360.0),
+            rotor_color="red",
+            figsize=(10, 3),
+        )
+        fig = next(g)
+        plt.show()

examples/states_lookup_table/run.py

@@ -0,0 +1,137 @@
+import argparse
+
+import foxes
+import foxes.variables as FV
+
+if __name__ == "__main__":
+    # define arguments:
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        "-P",
+        "--P_percent",
+        help="Power percent choice, applied to all states",
+        type=float,
+        default=55.0,
+    )
+    parser.add_argument(
+        "-s",
+        "--states",
+        help="The states input file (path or static)",
+        default="wind_rose_bremen.csv",
+    )
+    parser.add_argument(
+        "-l",
+        "--layout",
+        help="The wind farm layout file (path or static)",
+        default="test_farm_67.csv",
+    )
+    parser.add_argument(
+        "-D",
+        help="The rotor diameter",
+        default=126.0,
+        type=float,
+    )
+    parser.add_argument(
+        "-H",
+        help="The hub height",
+        default=90.0,
+        type=float,
+    )
+    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(
+        "-w",
+        "--wakes",
+        help="The wake models",
+        default=["Bastankhah2014_linear_lim_k004"],
+        nargs="+",
+    )
+    parser.add_argument(
+        "-m", "--tmodels", help="The turbine models", default=[], nargs="+"
+    )
+    parser.add_argument("-e", "--engine", help="The engine", default=None)
+    parser.add_argument(
+        "-n", "--n_cpus", help="The number of cpus", default=None, type=int
+    )
+    parser.add_argument(
+        "-c",
+        "--chunksize_states",
+        help="The chunk size for states",
+        default=None,
+        type=int,
+    )
+    parser.add_argument(
+        "-C",
+        "--chunksize_points",
+        help="The chunk size for points",
+        default=None,
+        type=int,
+    )
+    parser.add_argument(
+        "-nf", "--nofig", help="Do not show figures", action="store_true"
+    )
+    args = parser.parse_args()
+
+    mbook = foxes.models.ModelBook()
+    mbook.turbine_types["ttypeDH"] = foxes.models.turbine_types.NullType(
+        D=args.D, H=args.H
+    )
+
+    mbook.turbine_models["lookup"] = foxes.models.turbine_models.LookupTable(
+        "curtail_to_power.csv",
+        input_vars=[FV.REWS, "P_percent"],
+        output_vars=[FV.P, FV.CT],
+        varmap={
+            FV.REWS: "wind",
+            "P_percent": "powerPercent",
+            FV.P: "GenPower",
+            FV.CT: "ct",
+        },
+        P_percent=args.P_percent,
+    )
+
+    states = foxes.input.states.StatesTable(
+        data_source=args.states,
+        output_vars=[FV.WS, FV.WD, FV.TI, FV.RHO],
+        var2col={FV.WS: "ws", FV.WD: "wd", FV.WEIGHT: "weight"},
+        fixed_vars={FV.RHO: 1.225, FV.TI: 0.05},
+    )
+
+    farm = foxes.WindFarm()
+    foxes.input.farm_layout.add_from_file(
+        farm,
+        args.layout,
+        col_x="x",
+        col_y="y",
+        col_H="H",
+        turbine_models=["ttypeDH", "lookup"] + args.tmodels,
+    )
+
+    algo = foxes.algorithms.Downwind(
+        farm,
+        states,
+        rotor_model=args.rotor,
+        wake_models=args.wakes,
+        wake_frame="rotor_wd",
+        partial_wakes=args.pwakes,
+        mbook=mbook,
+        engine=args.engine,
+        n_procs=args.n_cpus,
+        chunk_size_states=args.chunksize_states,
+        chunk_size_points=args.chunksize_points,
+    )
+
+    farm_results = algo.calc_farm()
+
+    fr = farm_results.to_dataframe()
+    print(fr[[FV.WD, FV.H, FV.AMB_REWS, FV.REWS, FV.AMB_P, FV.P, FV.CT, FV.WEIGHT]])
+
+    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"Annual farm yield : {o.calc_farm_yield(algo=algo):.2f} GWh")

examples/streamline_wakes/run.py

@@ -0,0 +1,138 @@
+import time
+import argparse
+import matplotlib.pyplot as plt
+import numpy as np
+
+import foxes
+import foxes.variables as FV
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        "-f",
+        "--file_pattern",
+        help="The search pattern for input *.nc files",
+        default="wind_rotation.nc",
+    )
+    parser.add_argument(
+        "-t",
+        "--turbine_file",
+        help="The P-ct-curve csv file (path or static)",
+        default="NREL-5MW-D126-H90.csv",
+    )
+    parser.add_argument("-r", "--rotor", help="The rotor model", default="centre")
+    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(
+        "-w",
+        "--wakes",
+        help="The wake models",
+        default=["Jensen_linear_k007"],
+        nargs="+",
+    )
+    parser.add_argument(
+        "-wf", "--wake_frame", help="The wake frame choice", default="streamlines_100"
+    )
+    parser.add_argument(
+        "-m", "--tmodels", help="The turbine models", default=[], nargs="+"
+    )
+    parser.add_argument(
+        "-nt", "--n_turbines", help="The number of turbines", default=9, type=int
+    )
+    parser.add_argument(
+        "-npl", "--no_pre_load", help="Pre-load the nc data", action="store_true"
+    )
+    parser.add_argument("-e", "--engine", help="The engine", default=None)
+    parser.add_argument(
+        "-n", "--n_cpus", help="The number of cpus", default=None, type=int
+    )
+    parser.add_argument(
+        "-c",
+        "--chunksize_states",
+        help="The chunk size for states",
+        default=None,
+        type=int,
+    )
+    parser.add_argument(
+        "-C",
+        "--chunksize_points",
+        help="The chunk size for points",
+        default=None,
+        type=int,
+    )
+    parser.add_argument(
+        "-nf", "--nofig", help="Do not show figures", action="store_true"
+    )
+    args = parser.parse_args()
+
+    mbook = foxes.models.ModelBook()
+    ttype = foxes.models.turbine_types.PCtFile(args.turbine_file)
+    mbook.turbine_types[ttype.name] = ttype
+
+    states = foxes.input.states.FieldDataNC(
+        args.file_pattern,
+        states_coord="state",
+        x_coord="x",
+        y_coord="y",
+        h_coord="h",
+        time_format=None,
+        output_vars=[FV.WS, FV.WD, FV.TI, FV.RHO],
+        var2ncvar={FV.WS: "ws", FV.WD: "wd"},
+        fixed_vars={FV.RHO: 1.225, FV.TI: 0.1},
+        pre_load=not args.no_pre_load,
+        bounds_error=False,
+    )
+
+    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],
+    )
+
+    algo = foxes.algorithms.Downwind(
+        farm,
+        states,
+        rotor_model=args.rotor,
+        wake_models=args.wakes,
+        wake_frame=args.wake_frame,
+        partial_wakes=args.pwakes,
+        mbook=mbook,
+        engine=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()
+
+    print("\nCalc time =", time1 - time0, "\n")
+
+    print(farm_results, "\n")
+
+    fr = farm_results.to_dataframe()
+    print(fr[[FV.X, FV.Y, FV.WD, FV.AMB_REWS, FV.REWS, FV.AMB_P, FV.P]])
+
+    if not args.nofig:
+        o = foxes.output.FlowPlots2D(algo, farm_results)
+        for fig in o.gen_states_fig_xy(
+            FV.WS,
+            resolution=10,
+            figsize=(8, 8),
+            quiver_pars=dict(angles="xy", scale_units="xy", scale=0.07),
+            quiver_n=15,
+            xmin=0,
+            xmax=2500,
+            ymin=0,
+            ymax=2500,
+        ):
+            plt.show()
+            plt.close(fig)

examples/tab_file/run.py

@@ -0,0 +1,142 @@
+import time
+import argparse
+import matplotlib.pyplot as plt
+
+import foxes
+import foxes.variables as FV
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        "-l",
+        "--layout",
+        help="The wind farm layout file (path or static)",
+        default="test_farm_67.csv",
+    )
+    parser.add_argument(
+        "-s",
+        "--states",
+        help="The states input file (path or static)",
+        default="winds100.tab",
+    )
+    parser.add_argument(
+        "-t",
+        "--turbine_file",
+        help="The P-ct-curve csv file (path or static)",
+        default="NREL-5MW-D126-H90.csv",
+    )
+    parser.add_argument("-r", "--rotor", help="The rotor model", default="centre")
+    parser.add_argument(
+        "-p", "--pwakes", help="The partial wakes models", default={}, nargs="+"
+    )
+    parser.add_argument(
+        "-w",
+        "--wakes",
+        help="The wake models",
+        default=["CrespoHernandez_quadratic", "Bastankhah2014_linear"],
+        nargs="+",
+    )
+    parser.add_argument(
+        "-m", "--tmodels", help="The turbine models", default=[], nargs="+"
+    )
+    parser.add_argument(
+        "-sl",
+        "--show_layout",
+        help="Flag for showing layout figure",
+        action="store_true",
+    )
+    parser.add_argument(
+        "-cm", "--calc_mean", help="Calculate states mean", 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
+    )
+    parser.add_argument(
+        "-c",
+        "--chunksize_states",
+        help="The chunk size for states",
+        default=None,
+        type=int,
+    )
+    parser.add_argument(
+        "-C",
+        "--chunksize_points",
+        help="The chunk size for points",
+        default=5000,
+        type=int,
+    )
+    parser.add_argument(
+        "-nf", "--nofig", help="Do not show figures", action="store_true"
+    )
+    args = parser.parse_args()
+
+    mbook = foxes.models.ModelBook()
+    ttype = foxes.models.turbine_types.PCtFile(args.turbine_file)
+    mbook.turbine_types[ttype.name] = ttype
+
+    states = foxes.input.states.TabStates(
+        data_source=args.states,
+        output_vars=[FV.WS, FV.WD, FV.TI, FV.RHO],
+        fixed_vars={FV.RHO: 1.225, FV.TI: 0.05},
+    )
+
+    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,
+    ):
+        if not args.nofig:
+            o = foxes.output.StatesRosePlotOutput(states, point=[0.0, 0.0, 100.0])
+            fig = o.get_figure(12, FV.AMB_WS, [0, 3.5, 6, 10, 15, 20])
+            plt.show()
+
+        farm = foxes.WindFarm()
+        foxes.input.farm_layout.add_from_file(
+            farm,
+            args.layout,
+            col_x="x",
+            col_y="y",
+            col_H="H",
+            turbine_models=[ttype.name, "kTI_02"] + args.tmodels,
+        )
+
+        if not args.nofig and args.show_layout:
+            ax = foxes.output.FarmLayoutOutput(farm).get_figure()
+            plt.show()
+            plt.close(ax.get_figure())
+
+        algo = foxes.algorithms.Downwind(
+            farm,
+            states,
+            mbook=mbook,
+            rotor_model=args.rotor,
+            wake_models=args.wakes,
+            wake_frame="rotor_wd",
+            partial_wakes=args.pwakes,
+        )
+
+        time0 = time.time()
+        farm_results = algo.calc_farm()
+        time1 = time.time()
+
+        print("\nCalc time =", time1 - time0, "\n")
+
+        print(farm_results)
+
+        fr = farm_results.to_dataframe()
+        print(fr[[FV.WD, FV.H, FV.AMB_REWS, FV.REWS, FV.AMB_P, FV.P, FV.WEIGHT]])
+
+        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"Annual farm yield : {o.calc_farm_yield(algo=algo):.2f} GWh")
+
+        if not args.nofig and args.calc_mean:
+            o = foxes.output.FlowPlots2D(algo, farm_results)
+            fig = o.get_mean_fig_xy(FV.WS, resolution=30)
+            plt.show()