add/cleanup documentation on simulation functions · python-control/python-control@f0a34df
@@ -11,7 +11,6 @@ way that different types of standard information used by the library.
1111Throughout this manual, we assume the `control` package has been
1212imported as `ct`.
131314-1514LTI system representation
1615=========================
1716@@ -132,11 +131,40 @@ constructor for the desired data type using the original system as the sole
132131argument or using the explicit conversion functions :func:`ss2tf` and
133132:func:`tf2ss`.
134133134+Simulating LTI systems
135+======================
136+137+A number of functions are available for computing the output (and
138+state) response of an LTI systems:
139+140+.. autosummary::
141+:toctree: generated/
142+:template: custom-class-template.rst
143+144+ initial_response
145+ step_response
146+ impulse_response
147+ forced_response
148+149+Each of these functions returns a :class:`TimeResponseData` object
150+that contains the data for the time response (described in more detail
151+in the next section).
152+153+The :func:`forced_response` system is the most general and allows by
154+the zero initial state response to be simulated as well as the
155+response from a non-zero intial condition.
156+157+In addition the :func:`input_output_response` function, which handles
158+simulation of nonlinear systems and interconnected systems, can be
159+used. For an LTI system, results are generally more accurate using
160+the LTI simulation functions above. The :func:`input_output_response`
161+function is described in more detail in the :ref:`iosys-module` section.
162+135163.. currentmodule:: control
136164.. _time-series-convention:
137165138166Time series data
139-================
167+----------------
140168A variety of functions in the library return time series data: sequences of
141169values that change over time. A common set of conventions is used for
142170returning such data: columns represent different points in time, rows are
@@ -262,16 +290,16 @@ Selected variables that can be configured, along with their default values:
262290263291 * freqplot.dB (False): Bode plot magnitude plotted in dB (otherwise powers
264292 of 10)
265-293+266294 * freqplot.deg (True): Bode plot phase plotted in degrees (otherwise radians)
267-295+268296 * freqplot.Hz (False): Bode plot frequency plotted in Hertz (otherwise
269297 rad/sec)
270-298+271299 * freqplot.grid (True): Include grids for magnitude and phase plots
272-300+273301 * freqplot.number_of_samples (1000): Number of frequency points in Bode plots
274-302+275303 * freqplot.feature_periphery_decade (1.0): How many decades to include in
276304 the frequency range on both sides of features (poles, zeros).
277305