API Reference#

sysplot.SysplotConfig([figure_size, ...])

Global configuration container for sysplot visual defaults.

sysplot.PlotStyle

Type Hint for a style entry from get_style().

sysplot.add_origin([ax])

Ensure the origin is included in axes autoscaling.

sysplot.add_tick_line(value, label[, axis, ...])

Draw a dotted reference line and label at a specific axis value.

sysplot.apply_config([config])

Apply sysplot styling globally via seaborn and Matplotlib rcParams.

sysplot.emphasize_coord_lines([fig])

Draw coordinate axes lines at the origin on all 2D axes in a figure.

sysplot.get_config()

Return the active global sysplot configuration.

sysplot.get_figsize([nrows, ncols, nmax])

Calculate figure dimensions for a subplot grid.

sysplot.get_style([index, ax])

Return a style entry from the sysplot custom cycler PlotStyle.

sysplot.heaviside(x[, default_value])

Evaluate the Heaviside step function.

sysplot.plot_angle(center, point1, point2, text)

Draw and label the angle between two vectors.

sysplot.plot_bode(mag, phase, omega[, axes, ...])

Plot a two-panel Bode magnitude and phase diagram.

sysplot.plot_filter_tolerance(ax, bands, ...)

Draw a filter power tolerance mask on an existing axes.

sysplot.plot_nyquist(real, imag[, ax, ...])

Plot a Nyquist diagram with a directional arrow and optional mirror curve.

sysplot.plot_poles_zeros([poles, zeros, ...])

Plot poles and zeros on the complex plane.

sysplot.plot_stem(x, y[, ax, label, bottom, ...])

Plot vertical stems with optional outward-pointing markers.

sysplot.plot_unit_circle([ax, origin, ...])

Draw a unit circle on the axes.

sysplot.restore_tick_labels([fig])

Show tick labels on all axes of a figure.

sysplot.reset_config()

Reset global configuration to library defaults.

sysplot.save_current_figure(chapter, number, ...)

Save the current Matplotlib figure with a standardized filename.

sysplot.set_major_ticks(label[, unit, axis, ...])

Set major tick labels as reduced fractions of a unit.

sysplot.set_minor_log_ticks([axis, ...])

Add unlabeled minor ticks between decades of a logarithmic axis and styles them to match the grid color.

sysplot.set_xmargin([ax, use_margin])

Toggle x-axis margins for an axes.