desc.plotting.plot_coils

desc.plotting.plot_coils(coils, grid=None, fig=None, return_data=False, **kwargs)Source

Create 3D plot of coil geometry.

Parameters:

• coils (Coil, CoilSet, Curve, or iterable) – Coil or coils to plot

• grid (Grid, optional) – Grid to use for evaluating geometry

• fig (plotly.graph_objs._figure.Figure, optional) – Figure to plot on

• return_data (bool) – if True, return the data plotted as well as fig,ax

• **kwargs (dict, optional) –

  Specify properties of the figure, axis, and plot appearance e.g.:

  plot_X(figsize=(4,6), color="darkgrey")
  

  Valid keyword arguments are:

  • figsize: tuple of length 2, the size of the figure in inches

  • lw: float, linewidth of plotted coils

  • ls: str, linestyle of plotted coils

  • color: str, color of plotted coils

Returns:

• fig (plotly.graph_objs._figure.Figure) – Figure being plotted to

• plot_data (dict) – dictionary of the data plotted, only returned if return_data=True