Skip to content

Commit bc6f934

Browse files
committed
Docu improved
1 parent 514af2e commit bc6f934

File tree

3 files changed

+32
-25
lines changed

3 files changed

+32
-25
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -112,11 +112,14 @@ generate the following plot:
112112
- [PyPlot](https://github.com/JuliaPy/PyPlot.jl) (plots with [Matplotlib](https://matplotlib.org/stable/) from Python;
113113
via [SignalTablesInterface_PyPlot.jl](https://github.com/ModiaSim/SignalTablesInterface_PyPlot.jl)),
114114

115-
Planned implementations (basically adapting from [ModiaResult.jl](https://github.com/ModiaSim/ModiaResult.jl)):
116-
117-
- [GLMakie](https://github.com/JuliaPlots/GLMakie.jl) (interactive plots in an OpenGL window),
118-
- [WGLMakie](https://github.com/JuliaPlots/WGLMakie.jl) (interactive plots in a browser window),
119-
- [CairoMakie](https://github.com/JuliaPlots/CairoMakie.jl) (static plots on file with publication quality).
115+
- [GLMakie](https://github.com/JuliaPlots/GLMakie.jl) (interactive plots in an OpenGL window;
116+
via [SignalTablesInterface_GLMakie.jl](https://github.com/ModiaSim/SignalTablesInterface_GLMakie.jl)),
117+
118+
- [WGLMakie](https://github.com/JuliaPlots/WGLMakie.jl) (interactive plots in a browser window;
119+
via [SignalTablesInterface_WGLMakie.jl](https://github.com/ModiaSim/SignalTablesInterface_WGLMakie.jl)),
120+
121+
- [CairoMakie](https://github.com/JuliaPlots/CairoMakie.jl) (static plots on file with publication quality;
122+
via [SignalTablesInterface_CairoMakie.jl](https://github.com/ModiaSim/SignalTablesInterface_CairoMakie.jl)).
120123

121124
Furthermore, there is a dummy implementation included in SignalTables that is useful when performing tests with runtests.jl,
122125
in order that no plot package needs to be loaded during the tests:
@@ -130,7 +133,7 @@ in order that no plot package needs to be loaded during the tests:
130133
julia> ]add SignalTables
131134
add SignalTablesInterface_PyPlot # if plotting with PyPlot desired
132135

133-
# once registered
136+
# once registration processs finished
134137
add SignalTablesInterface_GLMakie # if plotting with GLMakie desired
135138
add SignalTablesInterface_WGLMakie # if plotting with WGLMakie desired
136139
add SignalTablesInterface_CairoMakie # if plotting with CairoMakie desired

docs/src/Functions/PlotPackages.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,25 @@
44
CurrentModule = SignalTables
55
```
66

7-
The plot package `XXX` to be used can be defined by:
7+
Example to define the plot package to be used:
88

9-
- `ENV["SignalTablesPlotPackage"] = XXX`\
10-
(e.g. in .julia/config/startup.jl file: `ENV["SignalTablesPlotPackage"] = "PyPlot"`), or
11-
- by calling [`usePlotPackage`](@ref)(XXX) (e.g. `usePlotPackage("PyPlot")`).
12-
13-
Supported values for `XXX`:
14-
15-
- `"PyPlot"` ([PyPlot](https://github.com/JuliaPy/PyPlot.jl) plots with Matplotlib from Python),
16-
- `"GLMakie"` ([GLMakie](https://github.com/JuliaPlots/GLMakie.jl) provides interactive plots in an OpenGL window),
17-
- `"WGLMakie"` ([WGLMakie](https://github.com/JuliaPlots/WGLMakie.jl) provides interactive plots in a browser window),
18-
- `"CairoMakie"` ([CairoMakie](https://github.com/JuliaPlots/CairoMakie.jl) provides static plots on file with publication quality).
9+
```julia
10+
using SignalTables
11+
usePlotPackage("PyPlot") # or ENV["SignalTablesPlotPackage"] = "PyPlot"
12+
```
1913

20-
Furthermore, there is a dummy implementation included in SignalTables that is useful when performing tests with runtests.jl,
21-
in order that no plot package needs to be loaded during the tests:
14+
The following plot packages are supported:
2215

16+
- `"PyPlot"` ([PyPlot](https://github.com/JuliaPy/PyPlot.jl) plots with Matplotlib from Python;
17+
via [SignalTablesInterface_PyPlot.jl](https://github.com/ModiaSim/SignalTablesInterface_PyPlot.jl)),
18+
- `"GLMakie"` ([GLMakie](https://github.com/JuliaPlots/GLMakie.jl) provides interactive plots in an OpenGL window;
19+
via [SignalTablesInterface_GLMakie.jl](https://github.com/ModiaSim/SignalTablesInterface_GLMakie.jl)),
20+
- `"WGLMakie"` ([WGLMakie](https://github.com/JuliaPlots/WGLMakie.jl) provides interactive plots in a browser window;
21+
via [SignalTablesInterface_WGLMakie.jl](https://github.com/ModiaSim/SignalTablesInterface_WGLMakie.jl)),
22+
- `"CairoMakie"` ([CairoMakie](https://github.com/JuliaPlots/CairoMakie.jl) provides static plots on file with publication quality;
23+
via [SignalTablesInterface_CairoMakie.jl](https://github.com/ModiaSim/SignalTablesInterface_CairoMakie.jl)).
2324
- `"SilentNoPlot"` (= all plot calls are silently ignored).
2425

25-
2626
Typically, runtests.jl is defined as:
2727

2828
```julia

docs/src/index.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -112,11 +112,15 @@ generate the following plot:
112112
- [PyPlot](https://github.com/JuliaPy/PyPlot.jl) (plots with [Matplotlib](https://matplotlib.org/stable/) from Python;
113113
via [SignalTablesInterface_PyPlot.jl](https://github.com/ModiaSim/SignalTablesInterface_PyPlot.jl)),
114114

115-
Planned implementations (basically adapting from [ModiaResult.jl](https://github.com/ModiaSim/ModiaResult.jl)):
115+
- [GLMakie](https://github.com/JuliaPlots/GLMakie.jl) (interactive plots in an OpenGL window;
116+
via [SignalTablesInterface_GLMakie.jl](https://github.com/ModiaSim/SignalTablesInterface_GLMakie.jl)),
117+
118+
- [WGLMakie](https://github.com/JuliaPlots/WGLMakie.jl) (interactive plots in a browser window;
119+
via [SignalTablesInterface_WGLMakie.jl](https://github.com/ModiaSim/SignalTablesInterface_WGLMakie.jl)),
120+
121+
- [CairoMakie](https://github.com/JuliaPlots/CairoMakie.jl) (static plots on file with publication quality;
122+
via [SignalTablesInterface_CairoMakie.jl](https://github.com/ModiaSim/SignalTablesInterface_CairoMakie.jl)).
116123

117-
- [GLMakie](https://github.com/JuliaPlots/GLMakie.jl) (interactive plots in an OpenGL window),
118-
- [WGLMakie](https://github.com/JuliaPlots/WGLMakie.jl) (interactive plots in a browser window),
119-
- [CairoMakie](https://github.com/JuliaPlots/CairoMakie.jl) (static plots on file with publication quality).
120124

121125
Furthermore, there is a dummy implementation included in SignalTables.jl that is useful when performing tests with runtests.jl,
122126
in order that no plot package needs to be loaded during the tests:
@@ -130,7 +134,7 @@ in order that no plot package needs to be loaded during the tests:
130134
julia> ]add SignalTables
131135
add SignalTablesInterface_PyPlot # if plotting with PyPlot desired
132136

133-
# once registered
137+
# once registration processs finished
134138
add SignalTablesInterface_GLMakie # if plotting with GLMakie desired
135139
add SignalTablesInterface_WGLMakie # if plotting with WGLMakie desired
136140
add SignalTablesInterface_CairoMakie # if plotting with CairoMakie desired

0 commit comments

Comments
 (0)