Skip to content

Commit 90f500d

Browse files
authored
add plots to docs (#433)
* add plots to docs * update description of plotting
1 parent a8745f3 commit 90f500d

File tree

2 files changed

+38
-1
lines changed

2 files changed

+38
-1
lines changed

docs/src/lib/plotting.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,38 @@ Pages = ["plotting.jl"]
1010
Order = [:function]
1111
Private = false
1212
```
13+
14+
## Examples
15+
`bode`
16+
![bode](https://github.com/JuliaControl/ControlExamplePlots.jl/blob/master/src/figures/bode.png?raw=true)
17+
18+
`sigma`
19+
![sigma](https://github.com/JuliaControl/ControlExamplePlots.jl/blob/master/src/figures/sigma.png?raw=true)
20+
21+
`margin`
22+
![margin](https://github.com/JuliaControl/ControlExamplePlots.jl/blob/master/src/figures/margin.png?raw=true)
23+
24+
`gangoffour`
25+
![gangoffour](https://github.com/JuliaControl/ControlExamplePlots.jl/blob/master/src/figures/gangoffour.png?raw=true)
26+
27+
`nyquist`
28+
![nyquist](https://github.com/JuliaControl/ControlExamplePlots.jl/blob/master/src/figures/nyquist.png?raw=true)
29+
30+
`nichols`
31+
![nichols](https://github.com/JuliaControl/ControlExamplePlots.jl/blob/master/src/figures/nichols.png?raw=true)
32+
33+
`pzmap`
34+
![pzmap](https://github.com/JuliaControl/ControlExamplePlots.jl/blob/master/src/figures/pzmap.png?raw=true)
35+
36+
`rlocus`
37+
![rlocus](https://github.com/JuliaControl/ControlExamplePlots.jl/blob/master/src/figures/rlocus.png?raw=true)
38+
39+
`lsim`
40+
![lsim](https://github.com/JuliaControl/ControlExamplePlots.jl/blob/master/src/figures/lsim.png?raw=true)
41+
42+
`impulse`
43+
![impulse](https://github.com/JuliaControl/ControlExamplePlots.jl/blob/master/src/figures/impulse.png?raw=true)
44+
45+
`step`
46+
![step](https://github.com/JuliaControl/ControlExamplePlots.jl/blob/master/src/figures/step.png?raw=true)
47+

docs/src/man/introduction.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ TransferFunction{Continuous,ControlSystems.SisoRational{Float64}}
4949
Continuous-time transfer function model
5050
```
5151
## Plotting
52-
Plotting requires some extra care. The ControlSystems package is using `Plots.jl` ([link](https://github.com/tbreloff/Plots.jl)) as interface to generate all the plots. This means that the user is able to freely choose back-end. The plots in this manual are generated using `PyPlot`. If you have several back-ends for plotting then you can select the one you want to use with the corresponding `Plots` call (for `PyPlot` this is `Plots.pyplot()`, some alternatives are `gr(), plotly(), pgfplots()`). A simple example where we generate a plot and save it to a file is
52+
Plotting requires some extra care. The ControlSystems package is using `Plots.jl` ([link](https://github.com/tbreloff/Plots.jl)) as interface to generate all the plots. This means that the user is able to freely choose back-end. The plots in this manual are generated using `GR`. If you have several back-ends for plotting then you can select the one you want to use with the corresponding `Plots` call (for `GR` this is `Plots.gr()`, some alternatives are `pyplot(), plotly(), pgfplots()`). A simple example where we generate a plot and save it to a file is
5353
```jldoctest; output=false
5454
5555
fig = bodeplot(tf(1,[1,2,1]))
@@ -63,3 +63,5 @@ save_docs_plot(fig, "intro_bode.svg") # hide
6363
```
6464

6565
![](../../plots/intro_bode.svg)
66+
67+
More examples of plots are provided in [Plotting](@ref).

0 commit comments

Comments
 (0)