Skip to content

Use matplotlibs streamplot function for phase_plane_plot #1112

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
murrayrm merged 15 commits into from
Feb 16, 2025
Merged

Use matplotlibs streamplot function for phase_plane_plot #1112

Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
a94f6ca
add plot_streamplot option to phase_plane_plot to use matplotlibs str…
lkies Feb 1, 2025
03c3b35
fixed documentation
lkies Feb 2, 2025
ad40832
added soft exclusion logic for streamlines, vectorfield and streamplo…
lkies Feb 4, 2025
c806ed5
added automatic zordering and set streamplot as default, added tests
lkies Feb 7, 2025
7a0c8f2
dont plot equilpoints in separatrices()
lkies Feb 9, 2025
1f702f6
check for legacy usage of phase_plane_plot that expects plot_streamli…
lkies Feb 9, 2025
cf8303b
added explicit plot_streamlines=True in examples
lkies Feb 9, 2025
1282ec0
fixed legacy usage check
lkies Feb 9, 2025
81d9c1e
updated documentation for phaseplot module
lkies Feb 9, 2025
4724e5a
fixed phaseplot test to use system which will always have separatrices
lkies Feb 9, 2025
4ba37c8
update examples to show streamplots
murrayrm Feb 15, 2025
0e0b907
update code style + docstrings to match standard usage
murrayrm Feb 16, 2025
c23a88d
update documentation (and plots)
murrayrm Feb 16, 2025
76965e1
Merge pull request #2 from murrayrm/lkies-streamplot
lkies Feb 16, 2025
fc1854e
fixed documentation
lkies Feb 16, 2025
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
Prev Previous commit
fixed documentation
  • Loading branch information
@lkies
lkies committed Feb 16, 2025
commit fc1854e73f3cb91d7fde61c5212e51a377f7d6ed
10 changes: 5 additions & 5 deletions control/phaseplot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,7 @@ def vectorfield(
suppress_warnings : bool, optional
If set to True, suppress warning messages in generating trajectories.
zorder : float, optional
Set the zorder for the separatrices. In not specified, it will be
Set the zorder for the vectorfield. In not specified, it will be
automatically chosen by `matplotlib.axes.Axes.quiver`.

"""
Expand Down Expand Up @@ -467,7 +467,7 @@ def streamplot(
If set to True, vary the linewidth of the streamlines based on the
magnitude of the vector field.
zorder : float, optional
Set the zorder for the separatrices. In not specified, it will be
Set the zorder for the streamlines. In not specified, it will be
automatically chosen by `matplotlib.axes.Axes.streamplot`.

"""
Expand Down Expand Up @@ -594,7 +594,7 @@ def streamlines(
suppress_warnings : bool, optional
If set to True, suppress warning messages in generating trajectories.
zorder : float, optional
Set the zorder for the separatrices. In not specified, it will be
Set the zorder for the streamlines. In not specified, it will be
automatically chosen by `matplotlib.axes.Axes.plot`.

"""
Expand Down Expand Up @@ -707,8 +707,8 @@ def equilpoints(
Override the default parameters used for generating plots.
Default is set by `config.defaults['ctrlplot.rcParams']`.
zorder : float, optional
Set the zorder for the separatrices. In not specified, it will be
automatically chosen by `matplotlib.axes.Axes.plot`.
Set the zorder for the equilibrium points. In not specified, it will
be automatically chosen by `matplotlib.axes.Axes.plot`.

"""
# Process keywords
Expand Down