ard.viz.layout

ard.viz.layout#

Functions

get_limits(windIOdict[, lim_buffer])

generate plot limits based on the expected values found in the windIO file

plot_layout(ard_prob, input_dict[, ax, ...])

plot the layout of a farm
ard.viz.layout.get_limits(windIOdict, lim_buffer=0.05)[source]#

generate plot limits based on the expected values found in the windIO file

Parameters:

  • windIOplant (dict) -- a full, presumed validated, windIO plant specification file

  • lim_buffer (float, optional) -- a percent buffer for plot edges, by default 0.05 (5%)

  • windIOdict (dict)

Returns:

  • x_lim (np.ndarray) -- the two-valued limits for the x-axis based on the windIO

  • y_lim (np.ndarray) -- the two-valued limits for the y-axis based on the windIO

ard.viz.layout.plot_layout(ard_prob, input_dict, ax=None, show_image=False, save_path=None, save_kwargs={}, include_cable_routing=False, include_mooring_system=False)[source]#

plot the layout of a farm

Parameters:

  • ard_prob (openmdao.api.Problem) -- the active Ard/OpenMDAO problem

  • input_dict (dict) -- the active Ard input dictionary

  • ax (matplotlib.axes.Axes, optional) -- an already-active pyplot Axes, by default None

  • show_image (bool, optional) -- to show the image, rather than just saving, by default False

  • save_path (os.PathLike, optional) -- location where the image be saved, by default None

  • save_kwargs (dict, optional) -- optional keyword arguments for plt.savefig, by default {}

  • include_cable_routing (bool, optional) -- should the collection system routing be plotted also, by default False

  • include_mooring_system (bool)

Returns:

the matplotlib Axes that have been generated (or modified)

Return type:

matplotlib.axes.Axes

Contents