mantao/Gnuplot.jl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: Suggest using Requires.jl for automatic settings of package options

Browse Source 
Using the @gnuplotrc macro for collecting user's preferred setup works
well, but it is a bit annoying when Julia needs to be restarted
often (e.g. due to crashes). Using Requires.jl allows the user to
forget about calling @gnuplotrc; the initialization happens
automatically, whenever the Gnuplot package is loaded.
This commit is contained in:
Michal Sojka 2021-05-25 15:01:45 +02:00
parent 9327492aa1
commit 658e5f422c
1 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/src/options.md
View File

@ -70,12 +70,11 @@ Each line reports the package name (`GNUPLOT`), the session name (`default`), th
## Package initialization ## Package initialization
If you use **Gnuplot.jl** frequently you may find convenient to collect all the package settings ([Options](@ref)) in a single place, to quickly recall them in a Julia session. A possibility is to put the following code in the `~/.julia/config/startup.jl` initialization file (further info [here](https://docs.julialang.org/en/v1/stdlib/REPL/)): If you use **Gnuplot.jl** frequently you may find convenient to automatically apply the package settings ([Options](@ref)) whenever the package is loaded. A possibility is to use [Requires.jl](https://github.com/JuliaPackaging/Requires.jl) and put the following code in the `~/.julia/config/startup.jl` initialization file (further info [here](https://docs.julialang.org/en/v1/stdlib/REPL/)):
```julia ```julia
macro gnuplotrc() using Requires
return :( @require Gnuplot="dc211083-a33a-5b79-959f-2ff34033469d" begin
using Gnuplot; @info "Custom Gnuplot initialization"
# Uncomment the following if you don't have the gnuplot # Uncomment the following if you don't have the gnuplot
# executable installed on your platform: # executable installed on your platform:
#Gnuplot.options.dry = true; #Gnuplot.options.dry = true;
@ -103,13 +102,12 @@ macro gnuplotrc()
# Set the default linetypes # Set the default linetypes
empty!(Gnuplot.options.init); empty!(Gnuplot.options.init);
push!(Gnuplot.options.init, linetypes(:Set1_5, lw=1.5, ps=1.5)); push!(Gnuplot.options.init, Gnuplot.linetypes(:Set1_5, lw=1.5, ps=1.5));
# Initialize the gnuplot REPL using the provided `start_key`. # Initialize the gnuplot REPL using the provided `start_key`.
if Gnuplot.options.gpviewer; if Gnuplot.options.gpviewer;
Gnuplot.repl_init(start_key='>'); Gnuplot.repl_init(start_key='>');
end; end;
)
end end
``` ```
At the Julia prompt you may load the package and the associated settings by typing: At the Julia prompt you may load the package and the associated settings by typing: