dss.plot#
This module provides a work-in-progress implementation of the original OpenDSS plots using the new features from DSS C-API v0.12+ and common Python modules such as matplotlib.
This is not a complete implementation and there are known limitations, but should suffice for many use-cases. We’d like to add another backend later.
Module Contents#
Classes#
Functions#
Enables the plotting subsystem from DSS-Extensions. |
|
Data#
API#
- dss.plot.Colors#
[‘#000000’, ‘#FF0000’, ‘#0000FF’, ‘#FF00FF’, ‘#008000’, ‘#80FF00’, ‘#FF8040’, ‘#DADE21’, ‘#B56AFF’, …
- dss.plot.DSS_MARKER_20#
‘Path(…)’
- dss.plot.DSS_MARKER_21#
‘Path(…)’
- dss.plot.DSS_MARKER_22#
‘Path(…)’
- dss.plot.DSS_MARKER_23#
‘Path(…)’
- dss.plot.DSS_MARKER_37#
‘Path(…)’
- dss.plot.DSS_MARKER_38#
‘Path(…)’
- dss.plot.LINES_STYLE_CODE#
None
- dss.plot.MARKER_MAP#
None
- dss.plot.MARKER_SEQ#
(5, 15, 2, 8, 26, 36, 39, 19, 18)
- dss.plot.PROFILE3PH#
None
- dss.plot.PROFILEALL#
None
- dss.plot.PROFILEALLPRI#
None
- dss.plot.PROFILELL3PH#
None
- dss.plot.PROFILELLALL#
None
- dss.plot.PROFILELLPRI#
None
- class dss.plot.ToggleAdvancedTypes(dss: dss.IDSS.IDSS, value: bool)#
- __enter__()#
- __exit__(exc_type, exc_val, exc_tb)#
- __init__(dss: dss.IDSS.IDSS, value: bool)#
- dss.plot.disable()#
- dss.plot.dss_circuit_plot(DSS: dss.IDSS.IDSS, params={}, fig=None, ax=None, is3d=False)#
- dss.plot.dss_comparecases_plot(DSS: dss.IDSS.IDSS, params)#
- dss.plot.dss_daisy_plot(DSS, params)#
- dss.plot.dss_di_plot(DSS: dss.IDSS.IDSS, params)#
- dss.plot.dss_general_data_plot(DSS, params)#
- dss.plot.dss_loadshape_plot(DSS, params)#
- dss.plot.dss_matrix_plot(DSS, params)#
- dss.plot.dss_monitor_plot(DSS: dss.IDSS.IDSS, params)#
- dss.plot.dss_plot(DSS, params)#
- dss.plot.dss_plot_funcs#
None
- dss.plot.dss_priceshape_plot(DSS, params)#
- dss.plot.dss_profile_plot(DSS, params)#
- dss.plot.dss_python_cb_plot(ctx, paramsStr)#
- dss.plot.dss_python_cb_write(ctx, message_str, message_type: int, message_size: int, message_subtype: int)#
- dss.plot.dss_scatter_plot(DSS, params)#
- dss.plot.dss_tshape_plot(DSS, params)#
- dss.plot.dss_visualize_plot(DSS, params)#
- dss.plot.dss_yearly_curve_plot(DSS: dss.IDSS.IDSS, params)#
- dss.plot.dss_zone_plot(DSS: dss.IDSS.IDSS, params)#
- dss.plot.enable(plot3d: bool = False, plot2d: bool = True, show: bool = True)#
Enables the plotting subsystem from DSS-Extensions.
Set plot3d to
Trueto try to reproduce some of the plots from the alternative OpenDSS Visualization Tool / OpenDSS Viewer addition to OpenDSS.Use
showto control whether this backend should callpyplot.show()or leave that to the system or the user. If the user plans to customize the figure, it is better to setshow=Falsein order to preserve the figures, sincepyplot.show()discards them.
- dss.plot.get_branch_data(DSS, branch_objects, bus_coords, do_values=pqNone, do_switches=False, idxs=None, single_ph_line_style=1, three_ph_line_style=1)#
- dss.plot.get_gic_line_data(DSS: dss.IDSS.IDSS, bus_coords, single_ph_line_style=1, three_ph_line_style=1)#
- dss.plot.get_marker_dict(dss_code)#
- dss.plot.get_point_data(DSS: dss.IDSS.IDSS, point_objects, bus_coords, do_values=False)#
- dss.plot.include_3d#
‘2d’
- dss.plot.node_re#
‘compile(…)’
- dss.plot.nodot(b)#
- dss.plot.quantity_str#
None
- dss.plot.remove_nodes(bus)#
- dss.plot.sizes#
None
- dss.plot.str_to_pq#
None
- dss.plot.unquote(field: str)#