diff --git a/.buildinfo b/.buildinfo
index 0d1cd27..1651d68 100644
--- a/.buildinfo
+++ b/.buildinfo
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 724438fc8258c7ea37fb6a37cf731147
+config: c49c331cc3bf202d58dda2c63b9dd08a
tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/_autosummary/wcomp.base_interface.html b/_autosummary/wcomp.base_interface.html
index 1663114..1f6e8cc 100644
--- a/_autosummary/wcomp.base_interface.html
+++ b/_autosummary/wcomp.base_interface.html
@@ -188,8 +188,6 @@
WCompBase is an abstract base class that defines the interfaces required
to conform to the wcomp framework. This class cannot be used directly. Instead,
it should be used to create a subclass, and all attributes and functions
@@ -450,14 +448,7 @@
Virtual property to get the characteristic rotor diameter for use throughout the
-post processing and plotting functions. While every turbine may not have the same
-rotor diameter, one should be chosen as a reference value to set relative distances.
-
-
Raises:
-
NotImplementedError -- This function must be implemented in a subclass
Virtual property to get the characteristic hub height for use throughout the
-post processing and plotting functions. While every turbine may not have the same
-hub height, one should be chosen as a reference value to set relative distances.
-
-
Raises:
-
NotImplementedError -- This function must be implemented in a subclass
Computes the annual energy production (AEP) for the current case.
-This is typically implemented in the corresponding software, so
-it should not be computed here.
-
-
Raises:
-
NotImplementedError -- This function must be implemented in a subclass
-
-
Returns:
-
Annual energy production (AEP) for the current case in megawatts-hours (MWh).
This function produces a 1D plot of the velocity profile in the z-x plane
-where z is normal to the ground and x is streamwise. A sample line is produced
-from the ground to the height zmax at the location (x_coordinate, y_coordinate)
-to sample the velocities.
-
To implement this function, the subclass should produce a line of the u-component of
-velocities at the specified location and height. The {py:class}`wcomp.plotting.WakeProfile`
-class should be used to store the data. Then, the {py:meth}`wcomp.plotting.plot_profile`
-function should be used to produce the plot. A sample implementation is shown below.
-
-
Parameters:
-
-
wind_direction (float) -- Incoming wind direction in degrees with West at 270 degrees.
-
x_coordinate (float) -- X-coordinate of the line to sample.
-
y_coordinate (float) -- Y-coordinate of the line to sample.
-
zmax (float) -- The end-point of the sample line in the vertical direction.
-The line starts at the ground.
-
-
-
Raises:
-
NotImplementedError -- This function must be implemented in a subclass
# Call the wake model to produce the velocities at the sample line
-u,v,w=wake_model(...)# Note v and w are not used
-x,y,z=wake_model.get_points()# Get the coordinates of the sample points
-
-# Create a WakeProfile object to store the data
-profile=WakeProfile(z,u)
-
-# Plot the profile
-ax=plt.gca()# Get the current pyplot axis to place the plot
-plot_profile(
- profile,
- ax=ax,
- color=self.LINE_PLOT_COLOR,
- marker=self.LINE_PLOT_MARKER,
- linestyle=self.LINE_PLOT_LINESTYLE,
- label=self.LEGEND
-)
-
This function produces a 1D plot of the velocity profile in the y-z plane
-where z is normal to the ground and y is normal to z and the streamwise direction.
-A sample line is produced from ymin to ymax at the hub height and x_coordinate
-to sample the velocities.
-
To implement this function, the subclass should produce a line of the u-component of
-velocities at the specified location and height. The {py:class}`wcomp.plotting.WakeProfile`
-class should be used to store the data. Then, the {py:meth}`wcomp.plotting.plot_profile`
-function should be used to produce the plot. A sample implementation is shown below.
-
-
Parameters:
-
-
wind_direction (float) -- Incoming wind direction in degrees with West at 270 degrees.
-
x_coordinate (float) -- X-coordinate of the line to sample.
-
ymin (float) -- Starting point of the sample line in the lateral direction.
-
ymax (float) -- End point of the sample line in the lateral direction.
-
-
-
Raises:
-
NotImplementedError -- This function must be implemented in a subclass
# Call the wake model to produce the velocities at the sample line
-u,v,w=wake_model(...)# Note v and w are not used
-x,y,z=wake_model.get_points()# Get the coordinates of the sample points
-
-# Create a WakeProfile object to store the data
-profile=WakeProfile(y,u)
-
-# Plot the profile
-ax=plt.gca()# Get the current pyplot axis to place the plot
-plot_profile(
- profile,
- ax=ax,
- color=self.LINE_PLOT_COLOR,
- marker=self.LINE_PLOT_MARKER,
- linestyle=self.LINE_PLOT_LINESTYLE,
- label=self.LEGEND
-)
-
This routine creates a 2D horizontal contour of all turbines in the farm.
-NOTE: the get_mean_fig_xy routine requires a single resolution setting
-and uses this for both directions in the plot. This is distinct from the
-other interfaces where a resolution is supported for each direction
-of the plot.
This function produces a contour plot of the velocity in the y-z plane where
-y is lateral and z is vertical. The contour is located in the streamwise direction at the
-given x_coordinate. The extent of the sample plane should be:
-
-
y min,max: 2 rotor diameters outside the most lateral turbines
-
z min: z=0.0
-
z max: 6 * hub height
-
-
To implement this function, the subclass should produce a plane of the u-component of
-velocities with the required bounds. The {py:class}`wcomp.plotting.WakePlane`
-class should be used to store the data. Then, the {py:meth}`wcomp.plotting.plot_plane`
-function should be used to produce the plot. A sample implementation is shown below.
-
-
Parameters:
-
-
wind_direction (float) -- Wind direction to align the plot in the visualization in
-degrees with West being 270 degrees and North being 0 degrees
-
resolution (tuple) -- Grid resolution for the contour plot;
-element 0 is the resolution in y and element 1 is the resolution in z
-
x_coordinate (float) -- The streamwise location for the extracted plane
-
-
-
Raises:
-
NotImplementedError -- This function must be implemented in a subclass
# Call the wake model to produce the velocities at the sample line
-u,v,w=wake_model(...)# Note v and w are not used
-x,y,z=wake_model.get_points()# Get the coordinates of the sample points
-
-# Create a WakePlane object to store the data
-plane=WakePlane(
- y,# If 2d array, use x.flatten()
- z,# ^ ^ ^
- u,
- "x",
- resolution,
-)
-
-# Plot the plane
-ax=plt.gca()# Get the current pyplot axis to place the plot
-plot_plane(
- plane,
- ax=ax,
- color=self.LINE_PLOT_COLOR,
- marker=self.LINE_PLOT_MARKER,
- linestyle=self.LINE_PLOT_LINESTYLE,
- label=self.LEGEND
-)
-
-returnplane
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Contents
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/_autosummary/wcomp.output_struct.html b/_autosummary/wcomp.output_struct.html
index ea1ea3b..aa48e4b 100644
--- a/_autosummary/wcomp.output_struct.html
+++ b/_autosummary/wcomp.output_struct.html
@@ -74,7 +74,7 @@
-
+
@@ -188,8 +188,6 @@
Virtual property to get the characteristic rotor diameter for use throughout the
-post processing and plotting functions. While every turbine may not have the same
-rotor diameter, one should be chosen as a reference value to set relative distances.
-
-
Raises:
-
NotImplementedError -- This function must be implemented in a subclass
Virtual property to get the characteristic hub height for use throughout the
-post processing and plotting functions. While every turbine may not have the same
-hub height, one should be chosen as a reference value to set relative distances.
-
-
Raises:
-
NotImplementedError -- This function must be implemented in a subclass
Computes the annual energy production (AEP) for the current case.
-This is typically implemented in the corresponding software, so
-it should not be computed here.
-
-
Raises:
-
NotImplementedError -- This function must be implemented in a subclass
-
-
Returns:
-
Annual energy production (AEP) for the current case in megawatts-hours (MWh).
This function produces a 1D plot of the velocity profile in the y-z plane
-where z is normal to the ground and y is normal to z and the streamwise direction.
-A sample line is produced from ymin to ymax at the hub height and x_coordinate
-to sample the velocities.
-
To implement this function, the subclass should produce a line of the u-component of
-velocities at the specified location and height. The {py:class}`wcomp.plotting.WakeProfile`
-class should be used to store the data. Then, the {py:meth}`wcomp.plotting.plot_profile`
-function should be used to produce the plot. A sample implementation is shown below.
-
-
Parameters:
-
-
wind_direction (float) -- Incoming wind direction in degrees with West at 270 degrees.
-
x_coordinate (float) -- X-coordinate of the line to sample.
-
ymin (float) -- Starting point of the sample line in the lateral direction.
-
ymax (float) -- End point of the sample line in the lateral direction.
-
-
-
Raises:
-
NotImplementedError -- This function must be implemented in a subclass
# Call the wake model to produce the velocities at the sample line
-u,v,w=wake_model(...)# Note v and w are not used
-x,y,z=wake_model.get_points()# Get the coordinates of the sample points
-
-# Create a WakeProfile object to store the data
-profile=WakeProfile(y,u)
-
-# Plot the profile
-ax=plt.gca()# Get the current pyplot axis to place the plot
-plot_profile(
- profile,
- ax=ax,
- color=self.LINE_PLOT_COLOR,
- marker=self.LINE_PLOT_MARKER,
- linestyle=self.LINE_PLOT_LINESTYLE,
- label=self.LEGEND
-)
-
This function produces a contour plot of the velocity in the y-z plane where
-y is lateral and z is vertical. The contour is located in the streamwise direction at the
-given x_coordinate. The extent of the sample plane should be:
-
-
y min,max: 2 rotor diameters outside the most lateral turbines
-
z min: z=0.0
-
z max: 6 * hub height
-
-
To implement this function, the subclass should produce a plane of the u-component of
-velocities with the required bounds. The {py:class}`wcomp.plotting.WakePlane`
-class should be used to store the data. Then, the {py:meth}`wcomp.plotting.plot_plane`
-function should be used to produce the plot. A sample implementation is shown below.
-
-
Parameters:
-
-
wind_direction (float) -- Wind direction to align the plot in the visualization in
-degrees with West being 270 degrees and North being 0 degrees
-
resolution (tuple) -- Grid resolution for the contour plot;
-element 0 is the resolution in y and element 1 is the resolution in z
-
x_coordinate (float) -- The streamwise location for the extracted plane
-
-
-
Raises:
-
NotImplementedError -- This function must be implemented in a subclass
# Call the wake model to produce the velocities at the sample line
-u,v,w=wake_model(...)# Note v and w are not used
-x,y,z=wake_model.get_points()# Get the coordinates of the sample points
-
-# Create a WakePlane object to store the data
-plane=WakePlane(
- y,# If 2d array, use x.flatten()
- z,# ^ ^ ^
- u,
- "x",
- resolution,
-)
-
-# Plot the plane
-ax=plt.gca()# Get the current pyplot axis to place the plot
-plot_plane(
- plane,
- ax=ax,
- color=self.LINE_PLOT_COLOR,
- marker=self.LINE_PLOT_MARKER,
- linestyle=self.LINE_PLOT_LINESTYLE,
- label=self.LEGEND
-)
-
-returnplane
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Contents
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/_modules/index.html b/_modules/index.html
index aa11ee4..90d0221 100644
--- a/_modules/index.html
+++ b/_modules/index.html
@@ -189,8 +189,6 @@
LINE_PLOT_COLOR="OVERWRITE"# Color to use for all line plots; use matplotlib color codesLEGEND="OVERWRITE"# Legend entry; typically should be the name of the corresponding software
- def__init__(
- self,
- input_file:str|Path,
- velocity_deficit:Any,
- velocity_deficit_p:dict,
- deflection:Any=None,
- deflection_p:dict=None,
- yaw_angles:list[float]=[0.0],
- ):
-
+ def__init__(self,input_file:str|Path):""" The initialization for all subclasses must create the results from the corresponding software, so that they are ready for post processing in
diff --git a/_modules/wcomp/floris_interface.html b/_modules/wcomp/floris_interface.html
index f8b0faa..52b6b46 100644
--- a/_modules/wcomp/floris_interface.html
+++ b/_modules/wcomp/floris_interface.html
@@ -189,8 +189,6 @@
-
-frompathlibimportPath
-
-importmatplotlib.pyplotasplt
-importfoxes.constantsasFC
-importfoxes.variablesasFV
-importmatplotlib.pyplotasplt
-importnumpyasnp
-importpandasaspd
-fromfoxes.algorithms.downwindimportDownwind
-fromfoxes.coreimportWindFarm,WakeModel
-fromfoxes.input.farm_layoutimportadd_from_df
-fromfoxes.input.statesimportStatesTable
-fromfoxes.models.turbine_typesimportCpCtFromTwo
-fromfoxes.outputimportFlowPlots2D
-fromfoxes.models.model_bookimportModelBook
-# from foxes.models.wake_models.wind import JensenWake
-
-fromwindIO.utils.yml_utilsimportload_yaml
-from.base_interfaceimportWCompBase
-from.output_structimportWakePlane,WakeProfile
-from.plottingimportplot_plane,plot_profile
-
-# This dictionary maps generic model names in the windIO input file
-# to the tool's specific name. It also maps parameter names from the
-# referenced papers to the parameters in the implementation.
-# WAKE_MODEL_MAPPING = {
-# "jensen": JensenWake,
-# "alpha": "k"
-# }
-
-