update documentation (and plots)

Author: murrayrm

control/phaseplot.py

@@ -451,6 +451,10 @@ def streamplot(
 
     Other Parameters
     ----------------
+    cmap : str or Colormap, optional
+        Colormap to use for varying the color of the streamlines.
+    norm : `matplotlib.colors.Normalize`, optional
+        Normalization map to use for scaling the colormap and linewidths.
     rcParams : dict
         Override the default parameters used for generating plots.
         Default is set by `config.default['ctrlplot.rcParams']`.
@@ -462,10 +466,6 @@ def streamplot(
     vary_linewidth : bool, optional.
         If set to True, vary the linewidth of the streamlines based on the
         magnitude of the vector field.
-    cmap : str or Colormap, optional
-        Colormap to use for varying the color of the streamlines.
-    norm : `matplotlib.colors.Normalize`, optional
-        Normalization map to use for scaling the colormap and linewidths.
     zorder : float, optional
         Set the zorder for the separatrices.  In not specified, it will be
         automatically chosen by `matplotlib.axes.Axes.streamplot`.

doc/figures/phaseplot-dampedosc-default.png

@@ -76,17 +76,17 @@ an inverted pendulum system, which is created using a mesh grid:
 
 This figure shows several features of more complex phase plane plots:
 multiple equilibrium points are shown, with saddle points showing
-separatrices, and streamlines generated generated from a rectangular 25x25
-grid (default) of function evaluations. Together, the multiple features in
-the phase plane plot give a good global picture of the topological structure
-of solutions of the dynamical system.
-
-Phase plots can be built up by hand using a variety of helper functions that
-are part of the :mod:`phaseplot` (pp) module. For more precise control, the
-streamlines can also generated by integrating the system forwads or backwards
-in time from a set of initial conditions. The initial conditions can be chosen
-on a rectangular grid, rectangual boundary, circle or from an arbitrary set of
-points.
+separatrices, and streamlines generated generated from a rectangular
+25x25 grid (default) of function evaluations. Together, the multiple
+features in the phase plane plot give a good global picture of the
+topological structure of solutions of the dynamical system.
+
+Phase plots can be built up by hand using a variety of helper
+functions that are part of the :mod:`phaseplot` (pp) module. For more
+precise control, the streamlines can also generated by integrating the
+system forwards or backwards in time from a set of initial
+conditions. The initial conditions can be chosen on a rectangular
+grid, rectangual boundary, circle or from an arbitrary set of points.
 
 .. testcode:: phaseplot
     :hide:
@@ -127,8 +127,8 @@ The following helper functions are available:
    phaseplot.equilpoints
    phaseplot.separatrices
    phaseplot.streamlines
-   phaseplot.vectorfield
    phaseplot.streamplot
+   phaseplot.vectorfield
 
 The :func:`phase_plane_plot` function calls these helper functions
 based on the options it is passed.

doc/figures/phaseplot-invpend-meshgrid.png

@@ -102,7 +102,6 @@ def invpend_update(t, x, u, params):
     invpend = ct.nlsys(invpend_update, states=2, inputs=1, name='invpend')
     ct.phase_plane_plot(
         invpend, [-2*pi, 2*pi, -2, 2], 5,
-        gridtype='meshgrid', gridspec=[5, 8], arrows=3,
         plot_separatrices={'gridspec': [12, 9]},
         params={'m': 1, 'l': 1, 'b': 0.2, 'g': 1})