Skip to content

Small user documentation fixes #1042

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 17, 2024
Merged

Small user documentation fixes #1042

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d44bc84
DOC: box_grid -> boxgrid + fix module path refs
murrayrm Aug 17, 2024
7b9664c
fix up a few referencs in optimal documentation
murrayrm Aug 17, 2024
d176201
fix additional broken links (from @slivingston review)
murrayrm Aug 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions doc/iosys.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ a :class:`~control.StateSpace` linear system. Use the
ss_sys = ct.linearize(io_sys, xeq, ueq)

Input/output systems are automatically created for state space LTI systems
when using the :func:`ss` function. Nonlinear input/output systems can be
created using the :func:`~control.nlsys` function, which requires
the definition of an update function (for the right hand side of the
differential or different equation) and an output function (computes the
outputs from the state)::
when using the :func:`~control.ss` function. Nonlinear input/output
systems can be created using the :func:`~control.nlsys` function, which
requires the definition of an update function (for the right hand side of
the differential or different equation) and an output function (computes
the outputs from the state)::

io_sys = ct.nlsys(updfcn, outfcn, inputs=M, outputs=P, states=N)

Expand Down Expand Up @@ -434,8 +434,8 @@ of an individual system are used in a given specification::
inplist=['sum.r', 'P.v'], outlist=['P', 'C.u']
)

And finally, since we have named the signals throughout the system in
a consistent way, we could let :func:`ct.interconnect` do all of the
And finally, since we have named the signals throughout the system in a
consistent way, we could let :func:`~control.interconnect` do all of the
work::

clsys5 = ct.interconnect(
Expand Down
6 changes: 5 additions & 1 deletion doc/optimal.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ state and/or input, either along the trajectory and at the terminal time.
The optimal control module operates by converting the optimal control
problem into a standard optimization problem that can be solved by
:func:`scipy.optimize.minimize`. The optimal control problem can be solved
by using the :func:`~control.obc.solve_ocp` function::
by using the :func:`~control.optimal.solve_ocp` function::

res = obc.solve_ocp(sys, timepts, X0, cost, constraints)

Expand Down Expand Up @@ -467,6 +467,10 @@ formulations.

Module classes and functions
============================

The following classes and functions are defined in the
``optimal`` module:

.. autosummary::
:toctree: generated/
:template: custom-class-template.rst
Expand Down
25 changes: 13 additions & 12 deletions doc/plotting.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
.. _plotting-module:

.. currentmodule:: control

*************
Plotting data
*************
Expand Down Expand Up @@ -213,8 +215,8 @@ plot, use `plot_type='nichols'`::

.. image:: freqplot-siso_nichols-default.png

Another response function that can be used to generate Bode plots is
the :func:`~control.gangof4` function, which computes the four primary
Another response function that can be used to generate Bode plots is the
:func:`~control.gangof4_response` function, which computes the four primary
sensitivity functions for a feedback control system in standard form::

proc = ct.tf([1], [1, 1, 1], name="process")
Expand Down Expand Up @@ -408,10 +410,10 @@ are part of the :mod:`~control.phaseplot` (pp) module::
The following helper functions are available:

.. autosummary::
~control.phaseplot.equilpoints
~control.phaseplot.separatrices
~control.phaseplot.streamlines
~control.phaseplot.vectorfield
phaseplot.equilpoints
phaseplot.separatrices
phaseplot.streamlines
phaseplot.vectorfield

The :func:`~control.phase_plane_plot` function calls these helper functions
based on the options it is passed.
Expand Down Expand Up @@ -653,10 +655,10 @@ Plotting functions
~control.nichols_plot
~control.nyquist_plot
~control.phase_plane_plot
~control.phaseplot.equilpoints
~control.phaseplot.separatrices
~control.phaseplot.streamlines
~control.phaseplot.vectorfield
phaseplot.equilpoints
phaseplot.separatrices
phaseplot.streamlines
phaseplot.vectorfield
~control.pole_zero_plot
~control.root_locus_plot
~control.singular_values_plot
Expand All @@ -665,15 +667,14 @@ Plotting functions

Utility functions
-----------------

These additional functions can be used to manipulate response data or
carry out other operations in creating control plots.


.. autosummary::
:toctree: generated/

~control.box_grid
phaseplot.boxgrid
~control.combine_time_responses
~control.pole_zero_subplots
~control.reset_rcParams
Expand Down
Loading