Collect all layout visualization tools in FLORIS

examples/02_visualizations.py

@@ -2,7 +2,7 @@
 import matplotlib.pyplot as plt
 import numpy as np
 
-import floris.tools.visualization as wakeviz
+import floris.tools.flow_visualization as wakeviz
 from floris.tools import FlorisInterface
 
 
@@ -141,4 +141,4 @@
 )
 fig.suptitle("Rotor Plane Visualization, 10x10 Resolution")
 
-wakeviz.show_plots()
+plt.show()

examples/03_making_adjustments.py

@@ -2,7 +2,8 @@
 import matplotlib.pyplot as plt
 import numpy as np
 
-import floris.tools.visualization as wakeviz
+import floris.tools.flow_visualization as wakeviz
+import floris.tools.layout_visualization as lf
 from floris.tools import FlorisInterface
 
 
@@ -70,8 +71,8 @@
     min_speed=MIN_WS,
     max_speed=MAX_WS
 )
-wakeviz.add_turbine_id_labels(fi, axarr[3], color="w", backgroundcolor="k")
-wakeviz.plot_turbines_with_fi(fi, axarr[3])
+lf.plot_turbine_labels(fi, axarr[3],plotting_dict={'color':"w"})#, backgroundcolor="k")
+lf.plot_turbines_rotors(fi, axarr[3])
 
 # Change the yaw angles and configure the plot differently
 yaw_angles = np.zeros((1, N * N))
@@ -95,7 +96,7 @@
     min_speed=MIN_WS,
     max_speed=MAX_WS
 )
-wakeviz.plot_turbines_with_fi(fi, axarr[4], yaw_angles=yaw_angles, color="c")
+lf.plot_turbines_rotors(fi, axarr[4], yaw_angles=yaw_angles, color="c")
 
 
 # Plot the cross-plane of the 3x3 configuration
@@ -110,4 +111,4 @@
 axarr[5].invert_xaxis()
 
 
-wakeviz.show_plots()
+plt.show()

examples/16_heterogeneous_inflow.py

@@ -2,7 +2,7 @@
 import matplotlib.pyplot as plt
 
 from floris.tools import FlorisInterface
-from floris.tools.visualization import visualize_cut_plane
+from floris.tools.flow_visualization import visualize_cut_plane
 
 
 """

examples/16b_heterogeneity_multiple_ws_wd.py

@@ -3,7 +3,7 @@
 import numpy as np
 
 from floris.tools import FlorisInterface
-from floris.tools.visualization import visualize_cut_plane
+from floris.tools.flow_visualization import visualize_cut_plane
 
 
 """

examples/17_multiple_turbine_types.py

@@ -1,7 +1,7 @@
 
 import matplotlib.pyplot as plt
 
-import floris.tools.visualization as wakeviz
+import floris.tools.flow_visualization as wakeviz
 from floris.tools import FlorisInterface
 
 
@@ -28,4 +28,4 @@
 wakeviz.visualize_cut_plane(y_plane, ax=ax_list[1], title="Streamwise profile")
 wakeviz.visualize_cut_plane(cross_plane, ax=ax_list[2], title="Spanwise profile")
 
-wakeviz.show_plots()
+plt.show()

examples/23_layout_visualizations.py

@@ -0,0 +1,93 @@
+
+import matplotlib.pyplot as plt
+import numpy as np
+
+import floris.tools.layout_visualization as lf
+from floris.tools import FlorisInterface
+from floris.tools.flow_visualization import visualize_cut_plane
+
+
+"""
+This example shows a number of different ways to visualize a farm layout using FLORIS
+"""
+
+# Create the plotting objects using matplotlib
+fig, axarr = plt.subplots(3, 3, figsize=(16, 10), sharex=False)
+axarr = axarr.flatten()
+
+MIN_WS = 1.0
+MAX_WS = 8.0
+
+# Initialize FLORIS with the given input file via FlorisInterface
+fi = FlorisInterface("inputs/gch.yaml")
+
+# Change to 5-turbine layout with a wind direction from northwest
+fi.set(
+    layout_x=[0, 0, 1000, 1000, 1000], layout_y=[0, 500, 0, 500, 1000], wind_directions=[300]
+)
+
+# Plot 1: Visualize the flow
+ax = axarr[0]
+# Plot a horizatonal slice of the initial configuration
+horizontal_plane = fi.calculate_horizontal_plane(height=90.0)
+visualize_cut_plane(
+    horizontal_plane,
+    ax=ax,
+    min_speed=MIN_WS,
+    max_speed=MAX_WS,
+)
+# Plot the turbine points, setting the color to white
+lf.plot_turbine_points(fi, ax=ax, plotting_dict={"color": "w"})
+ax.set_title('Flow visualization and turbine points')
+
+# Plot 2: Show a particular flow case
+ax = axarr[1]
+turbine_names = [f"T{i}" for i in [10, 11, 12, 13, 22]]
+lf.plot_turbine_points(fi, ax=ax)
+lf.plot_turbine_labels(fi,
+                       ax=ax,
+                       turbine_names=turbine_names,
+                       show_bbox=True,
+                       bbox_dict={'facecolor':'r'})
+ax.set_title("Show turbine names with a red bounding box")
+
+
+# Plot 2: Show turbine rotors on flow
+ax = axarr[2]
+horizontal_plane = fi.calculate_horizontal_plane(height=90.0,
+                                                 yaw_angles=np.array([[0., 30., 0., 0., 0.]]))
+visualize_cut_plane(
+    horizontal_plane,
+    ax=ax,
+    min_speed=MIN_WS,
+    max_speed=MAX_WS
+)
+lf.plot_turbines_rotors(fi,ax=ax,yaw_angles=np.array([[0., 30., 0., 0., 0.]]))
+ax.set_title("Flow visualization with yawed turbine")
+
+# Plot 3: Show the layout, including wake directions
+ax = axarr[3]
+lf.plot_turbine_points(fi, ax=ax)
+lf.plot_turbine_labels(fi, ax=ax, turbine_names=turbine_names)
+lf.plot_waking_directions(fi, ax=ax)
+ax.set_title("Show turbine names and wake direction")
+
+# Plot 4: Plot a subset of the layout, and limit directions less than 7D
+ax = axarr[4]
+lf.plot_turbine_points(fi, ax=ax, turbine_indices=[0,1,2,3])
+lf.plot_turbine_labels(fi, ax=ax, turbine_names=turbine_names, turbine_indices=[0,1,2,3])
+lf.plot_waking_directions(fi, ax=ax, turbine_indices=[0,1,2,3], limit_dist_D=7)
+ax.set_title("Plot a subset and limit wake line distance")
+
+# Plot with a shaded region
+ax = axarr[5]
+lf.plot_turbine_points(fi, ax=ax)
+lf.shade_region(np.array([[0,0],[300,0],[300,1000],[0,700]]),ax=ax)
+ax.set_title("Plot with a shaded region")
+
+# Change hub heights and plot as a proxy for terrain
+ax = axarr[6]
+fi.floris.farm.hub_heights = np.array([110, 90, 100, 100, 95])
+lf.plot_farm_terrain(fi, ax=ax)
+
+plt.show()

examples/24_floating_turbine_models.py

@@ -3,7 +3,6 @@
 import numpy as np
 
 from floris.tools import FlorisInterface
-from floris.tools.layout_functions import visualize_layout
 
 
 """

examples/25_tilt_driven_vertical_wake_deflection.py

@@ -3,7 +3,7 @@
 import numpy as np
 
 from floris.tools import FlorisInterface
-from floris.tools.visualization import visualize_cut_plane
+from floris.tools.flow_visualization import visualize_cut_plane
 
 
 """

examples/26_empirical_gauss_velocity_deficit_parameters.py

@@ -5,7 +5,7 @@
 import numpy as np
 
 from floris.tools import FlorisInterface
-from floris.tools.visualization import plot_rotor_values, visualize_cut_plane
+from floris.tools.flow_visualization import plot_rotor_values, visualize_cut_plane
 
 
 """

examples/27_empirical_gauss_deflection_parameters.py

@@ -5,7 +5,7 @@
 import numpy as np
 
 from floris.tools import FlorisInterface
-from floris.tools.visualization import plot_rotor_values, visualize_cut_plane
+from floris.tools.flow_visualization import plot_rotor_values, visualize_cut_plane
 
 
 """

examples/29_floating_vs_fixedbottom_farm.py

@@ -4,7 +4,7 @@
 import pandas as pd
 from scipy.interpolate import NearestNDInterpolator
 
-import floris.tools.visualization as wakeviz
+import floris.tools.flow_visualization as wakeviz
 from floris.tools import FlorisInterface
 
 

examples/32_plot_velocity_deficit_profiles.py

@@ -3,9 +3,9 @@
 import numpy as np
 from matplotlib import ticker
 
-import floris.tools.visualization as wakeviz
+import floris.tools.flow_visualization as wakeviz
 from floris.tools import cut_plane, FlorisInterface
-from floris.tools.visualization import VelocityProfilesFigure
+from floris.tools.flow_visualization import VelocityProfilesFigure
 from floris.utilities import reverse_rotate_coordinates_rel_west
 
 

floris/tools/__init__.py

@@ -18,19 +18,18 @@
     ['__builtins__', '__cached__', '__doc__', '__file__', '__loader__',
     '__name__', '__package__', '__path__', '__spec__', 'cut_plane',
     'floris_interface',
-    'layout_functions', 'optimization', 'plotting', 'power_rose',
+    'layout_visualization', 'optimization', 'plotting', 'power_rose',
     'visualization']
 """
 
 from .floris_interface import FlorisInterface
-from .parallel_computing_interface import ParallelComputingInterface
-from .uncertainty_interface import UncertaintyInterface
-from .visualization import (
+from .flow_visualization import (
     plot_rotor_values,
-    plot_turbines_with_fi,
     visualize_cut_plane,
     visualize_quiver,
 )
+from .parallel_computing_interface import ParallelComputingInterface
+from .uncertainty_interface import UncertaintyInterface
 from .wind_data import (
     TimeSeries,
     WindRose,
@@ -42,7 +41,7 @@
 #     cut_plane,
 #     floris_interface,
 #     interface_utilities,
-#     layout_functions,
+#     layout_visualization,
 #     optimization,
 #     plotting,
 #     power_rose,

floris/tools/floris_interface.py

@@ -1279,13 +1279,13 @@ def get_turbine_layout(self, z=False):
 
     ### v3 functions that are removed - raise an error if used
 
-    def calculate_wake(self):
+    def calculate_wake(self, **_):
         raise NotImplementedError(
             "The calculate_wake method has been removed. Please use the run method. "
             "See https://nrel.github.io/floris/upgrade_guides/v3_to_v4.html for more information."
         )
 
-    def reinitialize(self):
+    def reinitialize(self, **_):
         raise NotImplementedError(
             "The reinitialize method has been removed. Please use the set method. "
             "See https://nrel.github.io/floris/upgrade_guides/v3_to_v4.html for more information."