Realtime.plot_summary

Realtime.plot_summary(domain='all', ax=None, cartopy_proj=None, save_path=None, ssl_certificate=True, **kwargs)

Plot a summary map of ongoing tropical cyclone and potential development activity.

Parameters

• domain (str) – Domain for the plot. Default is “all”. Please refer to Map Domain Options for available domain options.

• ax (axes, optional) – Instance of axes to plot on. If none, one will be generated. Default is none.

• cartopy_proj (ccrs, optional) – Instance of a cartopy projection to use. If none, one will be generated. Default is none.

• save_path (str, optional) – Relative or full path of directory to save the image in. If none, image will not be saved.

• ssl_certificate (boolean, optional) – If a JTWC forecast, this determines whether to disable SSL certificate when retrieving data from JTWC. Default is True. Use False ONLY if True causes an SSL certification error.

Other Parameters

• two_prop (dict) – Customization properties of NHC Tropical Weather Outlook (TWO). Please refer to Realtime Summary for available options.

• invest_prop (dict) – Customization properties of active invests. Please refer to Realtime Summary for available options.

• storm_prop (dict) – Customization properties of active storms. Please refer to Realtime Summary for available options.

• cone_prop (dict) – Customization properties of cone of uncertainty. Please refer to Realtime Summary for available options.

• map_prop (dict) – Customization properties of Cartopy map. Please refer to Map prop for available options.

Returns

ax – Instance of axes containing the plot is returned.

Notes

The following properties are available for plotting NHC Tropical Weather Outlook (TWO), via two_prop.

Property	Description
plot	Boolean to determine whether to plot NHC TWO. Default is True.
days	Number of days for TWO. Can be either 2 or 5. Default is 5.
fontsize	Font size for text label. Default is 12.
ms	Marker size for area location, if applicable. Default is 15.

The following properties are available for plotting invests, via invest_prop.

Property	Description
plot	Boolean to determine whether to plot active invests. Default is True.
linewidth	Line width for past track. Default is 0.8. Set to zero to not plot line.
linecolor	Line color for past track. Default is black.
linestyle	Line style for past track. Default is dotted.
fontsize	Font size for invest name label. Default is 12.
ms	Marker size for invest location. Default is 14.

The following properties are available for plotting storms, via storm_prop.

Property	Description
plot	Boolean to determine whether to plot active storms. Default is True.
linewidth	Line width for past track. Default is 0.8. Set to zero to not plot line.
linecolor	Line color for past track. Default is black.
linestyle	Line style for past track. Default is dotted.
fontsize	Font size for storm name label. Default is 12.
fillcolor	Fill color for storm location marker. Default is color by SSHWS category (“category”).
label_category	Boolean for whether to plot SSHWS category on top of storm location marker. Default is True.
ms	Marker size for storm location. Default is 14.

The following properties are available for plotting realtime cone of uncertainty, via cone_prop.

Property	Description
plot	Boolean to determine whether to plot cone of uncertainty & forecast track for active storms. Default is True.
linewidth	Line width for forecast track. Default is 1.5. Set to zero to not plot line.
alpha	Opacity for cone of uncertainty. Default is 0.6.
days	Number of days for cone of uncertainty, from 2 through 5. Default is 5.
fillcolor	Fill color for forecast dots. Default is color by SSHWS category (“category”).
label_category	Boolean for whether to plot SSHWS category on top of forecast dots. Default is True.
ms	Marker size for forecast dots. Default is 12.