Skip to content

API Reference Overview

Welcome to the ctrlpy API reference documentation.

ctrlpy is organized into focused, modular subpackages:

Module Description
ctrlpy.models Linear Time-Invariant (LTI) base classes, TransferFunction, and StateSpace.
ctrlpy.core.discrete Discrete-time LTI systems, z-domain transfer functions, and discretization methods.
ctrlpy.algebra Block diagram algebra (series, parallel, feedback).
ctrlpy.time_domain Step, impulse, and forced response solvers and TimeResponseData.
ctrlpy.freq_domain Frequency responses (bode_data, nyquist_data, root_locus_data, margin).
ctrlpy.controllers PID, PI, PD controller constructors and Ziegler-Nichols tuning.
ctrlpy.plotting Matplotlib static plots and Plotly interactive visualizations.
ctrlpy.pedagogy Routh-Hurwitz table, analytical Root Locus rules, and steady-state error analysis.
ctrlpy.exceptions Custom exception and warning hierarchy.