diff --git a/dev/advanced/index.html b/dev/advanced/index.html index aa51377..e3323a5 100644 --- a/dev/advanced/index.html +++ b/dev/advanced/index.html @@ -16,9 +16,9 @@ name = "\$MyDataSet1" a = gpexec("print a"), b = gpexec("print b"), c = gpexec("print c"))
┌ Info: Best fit values:
-│   a = "1.51303854468398"
-│   b = "0.360996772821728"
-└   c = "0.700373449674559"

A named dataset is available until the session is reset, i.e. as long as :- is used as first argument to @gp.

Multiplot

Gnuplot.jl can draw multiple plots in the same figure by exploiting the multiplot command. Each plot is identified by a positive integer number, which can be used as argument to @gp to redirect commands to the appropriate plot.

Continuing previous example we can plot both data and best fit model (in plot 1) and residuals (in plot 2):

@gp :- "set multiplot layout 2,1"
+│   a = "1.40227450305279"
+│   b = "0.296215599996585"
+└   c = "0.700772054919827"

A named dataset is available until the session is reset, i.e. as long as :- is used as first argument to @gp.

Multiplot

Gnuplot.jl can draw multiple plots in the same figure by exploiting the multiplot command. Each plot is identified by a positive integer number, which can be used as argument to @gp to redirect commands to the appropriate plot.

Continuing previous example we can plot both data and best fit model (in plot 1) and residuals (in plot 2):

@gp :- "set multiplot layout 2,1"
 @gp :- 1 "p $name w errorbars t 'Data'"
 @gp :-   "p $name u 1:(f(\$1)) w l t 'Best fit model'"
 @gp :- 2 "p $name u 1:((f(\$1)-\$2) / \$3):(1) w errorbars t 'Resid. [{/Symbol s}]'"
@@ -92,4 +92,4 @@ GNUPLOT (default) set output 'output.png'
 GNUPLOT (default) plot  \
   $data1 w l t 'Parabola'
 GNUPLOT (default) set output
-GNUPLOT (default) set term wxt 0 enhanced

Each line reports the package name (GNUPLOT), the session name (default), the command or string being sent to gnuplot process, and the returned response (line starting with ->). Default value is false;

+GNUPLOT (default) set term wxt 0 enhanced

Each line reports the package name (GNUPLOT), the session name (default), the command or string being sent to gnuplot process, and the returned response (line starting with ->). Default value is false;

diff --git a/dev/api/index.html b/dev/api/index.html index 7aa3427..e0b1386 100644 --- a/dev/api/index.html +++ b/dev/api/index.html @@ -1,29 +1,29 @@ -API · Gnuplot.jl
Edit on GitHub

API

Index

Exported symbols

The list of Gnuplot.jl exported symbols is as follows:

Gnuplot.@gp — Macro
@gp args...

The @gp macro, and its companion @gsp for 3D plots, allows to send data and commands to the gnuplot using an extremely concise syntax. The macros accepts any number of arguments, with the following meaning:

  • one, or a group of consecutive, array(s) build up a dataset. The different arrays are accessible as columns 1, 2, etc. from the gnuplot process. The number of required input arrays depends on the chosen plot style (see gnuplot documentation);

  • a string occurring before a dataset is interpreted as a gnuplot command (e.g. set grid);

  • a string occurring immediately after a dataset is interpreted as a plot element for the dataset, by which you can specify using clause, with clause, line styles, etc.. All keywords may be abbreviated following gnuplot conventions. Moreover, "plot" and "splot" can be abbreviated to "p" and "s" respectively;

  • the special symbol :-, whose meaning is to avoid starting a new plot (if given as first argument), or to avoid immediately running all commands to create the final plot (if given as last argument). Its purpose is to allow splitting one long statement into multiple (shorter) ones;

  • any other symbol is interpreted as a session ID;

  • an Int (>= 1) is interpreted as the plot destination in a multi-plot session (this specification applies to subsequent arguments, not previous ones);

  • an input in the form "\$name"=>(array1, array2, etc...) is interpreted as a named dataset. Note that the dataset name must always start with a "$";

  • an input in the form keyword=value is interpreted as a keyword/value pair. The accepted keywords and their corresponding gnuplot commands are as follows:

    • xrange=[low, high] => "set xrange [low:high];
    • yrange=[low, high] => "set yrange [low:high];
    • zrange=[low, high] => "set zrange [low:high];
    • cbrange=[low, high]=> "set cbrange[low:high];
    • key="..." => "set key ...";
    • title="..." => "set title "..."";
    • xlabel="..." => "set xlabel "..."";
    • ylabel="..." => "set ylabel "..."";
    • zlabel="..." => "set zlabel "..."";
    • xlog=true => set logscale x;
    • ylog=true => set logscale y;
    • zlog=true => set logscale z.

All Keyword names can be abbreviated as long as the resulting name is unambiguous. E.g. you can use xr=[1,10] in place of xrange=[1,10].

source
Gnuplot.@gsp — Macro
@gsp args...

This macro accepts the same syntax as @gp, but produces a 3D plot instead of a 2D one.

source
Gnuplot.contourlines — Function
contourlines(x::Vector{Float64}, y::Vector{Float64}, h::Matrix{Float64}; cntrparam="level auto 10")

Compute paths of contour lines for 2D data, and return a vector of IsoContourLines object.

Arguments:

  • x, y: Coordinates;
  • h: the levels on which iso contour lines are to be calculated
  • cntrparam: settings to compute contour line paths (see gnuplot documentation for cntrparam).

Example

x = randn(5000);
+API · Gnuplot.jl
Edit on GitHub
API
Index
Exported symbols
The list of Gnuplot.jl exported symbols is as follows:
Gnuplot.@gp — Macro
@gp args...
The @gp macro, and its companion @gsp for 3D plots, allows to send data and commands to the gnuplot using an extremely concise syntax.  The macros accepts any number of arguments, with the following meaning:
  • one, or a group of consecutive, array(s) build up a dataset.  The different arrays are accessible as columns 1, 2, etc. from the gnuplot process.  The number of required input arrays depends on the chosen plot style (see gnuplot documentation);
  • a string occurring before a dataset is interpreted as a gnuplot command (e.g. set grid);
  • a string occurring immediately after a dataset is interpreted as a plot element for the dataset, by which you can specify using clause, with clause, line styles, etc..  All keywords may be abbreviated following gnuplot conventions.  Moreover, "plot" and "splot" can be abbreviated to "p" and "s" respectively;
  • the special symbol :-, whose meaning is to avoid starting a new plot (if given as first argument), or to avoid immediately running all commands to create the final plot (if given as last argument).  Its purpose is to allow splitting one long statement into multiple (shorter) ones;
  • any other symbol is interpreted as a session ID;
  • an Int (>= 1) is interpreted as the plot destination in a multi-plot session (this specification applies to subsequent arguments, not previous ones);
  • an input in the form "\$name"=>(array1, array2, etc...) is interpreted as a named dataset.  Note that the dataset name must always start with a "$";
  • an input in the form keyword=value is interpreted as a keyword/value pair.  The accepted keywords and their corresponding gnuplot commands are as follows:
    • xrange=[low, high] => "set xrange [low:high];
    • yrange=[low, high] => "set yrange [low:high];
    • zrange=[low, high] => "set zrange [low:high];
    • cbrange=[low, high]=> "set cbrange[low:high];
    • key="..."  => "set key ...";
    • title="..."  => "set title "..."";
    • xlabel="..." => "set xlabel "..."";
    • ylabel="..." => "set ylabel "..."";
    • zlabel="..." => "set zlabel "..."";
    • xlog=true   => set logscale x;
    • ylog=true   => set logscale y;
    • zlog=true   => set logscale z.
All Keyword names can be abbreviated as long as the resulting name is unambiguous.  E.g. you can use xr=[1,10] in place of xrange=[1,10].
source
Gnuplot.@gsp — Macro
@gsp args...
This macro accepts the same syntax as @gp, but produces a 3D plot instead of a 2D one.
source
Gnuplot.contourlines — Function
contourlines(x::Vector{Float64}, y::Vector{Float64}, h::Matrix{Float64}; cntrparam="level auto 10")
Compute paths of contour lines for 2D data, and return a vector of IsoContourLines object.
Arguments:
  • x, y: Coordinates;
  • h: the levels on which iso contour lines are to be calculated
  • cntrparam: settings to compute contour line paths (see gnuplot documentation for cntrparam).
Example
x = randn(5000);
 y = randn(5000);
 h = hist(x, y, nbins1=20, nbins2=20);
 clines = contourlines(h.bins1, h.bins2, h.counts, cntrparam="levels discrete 15, 30, 45");
 @gp "set size ratio -1"
 for i in 1:length(clines)
     @gp :- clines[i].data "w l t '$(clines[i].z)' dt $i"
-end
source
Gnuplot.dataset_names — Function
dataset_names(sid::Symbol)
-dataset_names()
Return a vector with all dataset names for the sid session.  If sid is not provided the default session is considered.
source
Gnuplot.dataset_names — Function
dataset_names(sid::Symbol)
+dataset_names()
Return a vector with all dataset names for the sid session.  If sid is not provided the default session is considered.
source
Gnuplot.gpexec — Function
gpexec(sid::Symbol, command::String)
 gpexec(command::String)
Execute the gnuplot command command on the underlying gnuplot process of the sid session, and return the results as a Vector{String}.  If a gnuplot error arises it is propagated as an ErrorException.
The the sid argument is not provided, the default session is considered.
Examples:
gpexec("print GPVAL_TERM")
-gpexec("plot sin(x)")
source
Gnuplot.hist — Function
hist(v::Vector{T}; range=extrema(v), bs=NaN, nbins=0, pad=true) where T <: Number
Calculates the histogram of the values in v and returns a Histogram1D structure.
Arguments
  • v: a vector of values to compute the histogra;
  • range: values of the left edge of the first bin and of the right edge of the last bin;
  • bs: size of histogram bins;
  • nbins: number of bins in the histogram;
  • pad: if true add one dummy bins with zero counts before the first bin and after the last.
If bs is given nbins is ignored.
Example
v = randn(1000)
+gpexec("plot sin(x)")
source
Gnuplot.hist — Function
hist(v::Vector{T}; range=extrema(v), bs=NaN, nbins=0, pad=true) where T <: Number
Calculates the histogram of the values in v and returns a Histogram1D structure.
Arguments
  • v: a vector of values to compute the histogra;
  • range: values of the left edge of the first bin and of the right edge of the last bin;
  • bs: size of histogram bins;
  • nbins: number of bins in the histogram;
  • pad: if true add one dummy bins with zero counts before the first bin and after the last.
If bs is given nbins is ignored.
Example
v = randn(1000)
 h = hist(v, bs=0.5)
 @gp h  # preview
-@gp h.bins h.counts "w histep notit"
source
hist(v1::Vector{T1 <: Number}, v2::Vector{T2 <: Number}; range1=[NaN,NaN], bs1=NaN, nbins1=0, range2=[NaN,NaN], bs2=NaN, nbins2=0)
Calculates the 2D histogram of the values in v1 and v2 and returns a Histogram2D structure.
Arguments
  • v1: a vector of values along the first dimension;
  • v2: a vector of values along the second dimension;
  • range1: values of the left edge of the first bin and of the right edge of the last bin, along the first dimension;
  • range1: values of the left edge of the first bin and of the right edge of the last bin, along the second dimension;
  • bs1: size of histogram bins along the first dimension;
  • bs2: size of histogram bins along the second dimension;
  • nbins1: number of bins along the first dimension;
  • nbins2: number of bins along the second dimension;
If bs1 (bs2) is given nbins1 (nbins2) is ignored.
Example
v1 = randn(1000)
+@gp h.bins h.counts "w histep notit"
source
hist(v1::Vector{T1 <: Number}, v2::Vector{T2 <: Number}; range1=[NaN,NaN], bs1=NaN, nbins1=0, range2=[NaN,NaN], bs2=NaN, nbins2=0)
Calculates the 2D histogram of the values in v1 and v2 and returns a Histogram2D structure.
Arguments
  • v1: a vector of values along the first dimension;
  • v2: a vector of values along the second dimension;
  • range1: values of the left edge of the first bin and of the right edge of the last bin, along the first dimension;
  • range1: values of the left edge of the first bin and of the right edge of the last bin, along the second dimension;
  • bs1: size of histogram bins along the first dimension;
  • bs2: size of histogram bins along the second dimension;
  • nbins1: number of bins along the first dimension;
  • nbins2: number of bins along the second dimension;
If bs1 (bs2) is given nbins1 (nbins2) is ignored.
Example
v1 = randn(1000)
 v2 = randn(1000)
 h = hist(v1, v2, bs1=0.5, bs2=0.5)
 @gp h  # preview
-@gp "set size ratio -1" "set auto fix" h.bins1 h.bins2 h.counts "w image notit"
source
Gnuplot.linetypes — Function
linetypes(cmap::ColorScheme; rev=false)
-linetypes(s::Symbol; rev=false)
Convert a ColorScheme object into a string containing the gnuplot commands to set up linetype colors.
If the argument is a Symbol it is interpreted as the name of one of the predefined schemes in ColorSchemes. If rev=true the line colors are reversed.
source
Gnuplot.palette — Function
palette(cmap::ColorScheme; rev=false)
-palette(s::Symbol; rev=false)
Convert a ColorScheme object into a string containing the gnuplot commands to set up the corresponding palette.
If the argument is a Symbol it is interpreted as the name of one of the predefined schemes in ColorSchemes. If rev=true the palette is reversed.
source
Gnuplot.save — Function
save(sid::Symbol; term="", output="")
+@gp "set size ratio -1" "set auto fix" h.bins1 h.bins2 h.counts "w image notit"
source
Gnuplot.linetypes — Function
linetypes(cmap::ColorScheme; rev=false)
+linetypes(s::Symbol; rev=false)
Convert a ColorScheme object into a string containing the gnuplot commands to set up linetype colors.
If the argument is a Symbol it is interpreted as the name of one of the predefined schemes in ColorSchemes. If rev=true the line colors are reversed.
source
Gnuplot.palette — Function
palette(cmap::ColorScheme; rev=false)
+palette(s::Symbol; rev=false)
Convert a ColorScheme object into a string containing the gnuplot commands to set up the corresponding palette.
If the argument is a Symbol it is interpreted as the name of one of the predefined schemes in ColorSchemes. If rev=true the palette is reversed.
source
Gnuplot.save — Function
save(sid::Symbol; term="", output="")
 save(sid::Symbol, script_filename::String, ;term="", output="")
 save(; term="", output="")
-save(script_filename::String ;term="", output="")
Export a (multi-)plot into the external file name provided in the output= keyword.  The gnuplot terminal to use is provided through the term= keyword.
If the script_filename argument is provided a gnuplot script will be written in place of the output image.  The latter can then be used in a pure gnuplot session (Julia is no longer needed) to generate exactly the same original plot.
If the sid argument is provided the operation applies to the corresponding session.
source
Gnuplot.stats — Function
stats(sid::Symbol,name::String)
+save(script_filename::String ;term="", output="")
Export a (multi-)plot into the external file name provided in the output= keyword.  The gnuplot terminal to use is provided through the term= keyword.
If the script_filename argument is provided a gnuplot script will be written in place of the output image.  The latter can then be used in a pure gnuplot session (Julia is no longer needed) to generate exactly the same original plot.
If the sid argument is provided the operation applies to the corresponding session.
source
Gnuplot.stats — Function
stats(sid::Symbol,name::String)
 stats(name::String)
 stats(sid::Symbol)
-stats()
Print a statistical summary for the name dataset, belonging to sid session.  If name is not provdied a summary is printed for each dataset in the session.  If sid is not provided the default session is considered.
This function is actually a wrapper for the gnuplot command stats.
source
Gnuplot.terminals — Function
terminals()
Return a Vector{String} with the names of all the available gnuplot terminals.
source
Gnuplot.terminal — Function
terminal(sid::Symbol)
-terminal()
Return a String with the current gnuplot terminal (and its options) of the process associated to session sid, or to the default session (if sid is not provided).
source
Gnuplot.test_terminal — Function
test_terminal(term=nothing; linetypes=nothing, palette=nothing)
Run the test and test palette commands on a gnuplot terminal.
If no term is given it will use the default terminal. If lt and pal are given they are used as input to the linetypes and palette function repsetcively to load the associated color scheme.
Examples
test_terminal()
-test_terminal("wxt", lt=:rust, pal=:viridis)
source
Non-exported symbols
The following functions are not exported by the Gnuplot.jl package since they are typically not used in every day work, or aimed to debugging purposes.  Still, they can be useful in some case, hence they are documented here.
In order to call these functions you should add the Gnuplot. prefix to the function name.
Gnuplot.Histogram1D — Type
Histogram1D
A 1D histogram data.
Fields
  • bins::Vector{Float64}: bin center values;
  • counts::Vector{Float64}: counts in the bins;
  • binsize::Float64: size of each bin;
source
Gnuplot.Histogram2D — Type
Histogram2D
A 2D histogram data.
Fields
  • bins1::Vector{Float64}: bin center values along first dimension;
  • bins2::Vector{Float64}: bin center values along second dimension;
  • counts::Vector{Float64}: counts in the bins;
  • binsize1::Float64: size of each bin along first dimension;
  • binsize2::Float64: size of each bin along second dimension;
source
Gnuplot.IsoContourLines — Type
IsoContourLines
Coordinates of all contour lines of a given level.
Fields
  • paths::Vector{Path2d}: vector of Path2d objects, one for each continuous path;
  • data::Vector{String}: vector with string representation of all paths (ready to be sent to gnuplot);
  • z::Float64: level of the contour lines.
source
Gnuplot.Options — Type
Options
Structure containing the package global options, accessible through Gnuplot.options.
Fields
  • dry::Bool: whether to use dry sessions, i.e. without an underlying Gnuplot process (default: false)
  • cmd::String: command to start the Gnuplot process (default: "gnuplot")
  • default::Symbol: default session name (default: :default)
  • init::Vector{String}: commands to initialize the gnuplot session (e.g., to set default terminal)
  • verbose::Bool: verbosity flag (default: false)
  • preferred_format::Symbol: preferred format to send data to gnuplot.  Value must be one of:
    • bin: fastest solution for large datasets, but uses temporary files;
    • text: may be slow for large datasets, but no temporary file is involved;
    • auto (default) automatically choose the best strategy.
source
Gnuplot.gpversion — Function
Gnuplot.gpversion()
Return the gnuplot application version.
Raise an error if version is < 5.0 (required to use data blocks).
source
Gnuplot.quit — Function
Gnuplot.quit(sid::Symbol)
Quit the session identified by sid and the associated gnuplot process (if any).
source
Gnuplot.quitall — Function
Gnuplot.quitall()
Quit all the sessions and the associated gnuplot processes.
source

+stats()

Print a statistical summary for the name dataset, belonging to sid session. If name is not provdied a summary is printed for each dataset in the session. If sid is not provided the default session is considered.

This function is actually a wrapper for the gnuplot command stats.

source
Gnuplot.terminals — Function
terminals()

Return a Vector{String} with the names of all the available gnuplot terminals.

source
Gnuplot.terminal — Function
terminal(sid::Symbol)
+terminal()

Return a String with the current gnuplot terminal (and its options) of the process associated to session sid, or to the default session (if sid is not provided).

source
Gnuplot.test_terminal — Function
test_terminal(term=nothing; linetypes=nothing, palette=nothing)

Run the test and test palette commands on a gnuplot terminal.

If no term is given it will use the default terminal. If lt and pal are given they are used as input to the linetypes and palette function repsetcively to load the associated color scheme.

Examples

test_terminal()
+test_terminal("wxt", lt=:rust, pal=:viridis)
source

Non-exported symbols

The following functions are not exported by the Gnuplot.jl package since they are typically not used in every day work, or aimed to debugging purposes. Still, they can be useful in some case, hence they are documented here.

In order to call these functions you should add the Gnuplot. prefix to the function name.

Gnuplot.Histogram1D — Type
Histogram1D

A 1D histogram data.

Fields

  • bins::Vector{Float64}: bin center values;
  • counts::Vector{Float64}: counts in the bins;
  • binsize::Float64: size of each bin;
source
Gnuplot.Histogram2D — Type
Histogram2D

A 2D histogram data.

Fields

  • bins1::Vector{Float64}: bin center values along first dimension;
  • bins2::Vector{Float64}: bin center values along second dimension;
  • counts::Vector{Float64}: counts in the bins;
  • binsize1::Float64: size of each bin along first dimension;
  • binsize2::Float64: size of each bin along second dimension;
source
Gnuplot.IsoContourLines — Type
IsoContourLines

Coordinates of all contour lines of a given level.

Fields

  • paths::Vector{Path2d}: vector of Path2d objects, one for each continuous path;
  • data::Vector{String}: vector with string representation of all paths (ready to be sent to gnuplot);
  • z::Float64: level of the contour lines.
source
Gnuplot.Options — Type
Options

Structure containing the package global options, accessible through Gnuplot.options.

Fields

  • dry::Bool: whether to use dry sessions, i.e. without an underlying Gnuplot process (default: false)
  • cmd::String: command to start the Gnuplot process (default: "gnuplot")
  • default::Symbol: default session name (default: :default)
  • init::Vector{String}: commands to initialize the gnuplot session (e.g., to set default terminal)
  • verbose::Bool: verbosity flag (default: false)
  • preferred_format::Symbol: preferred format to send data to gnuplot. Value must be one of:
    • bin: fastest solution for large datasets, but uses temporary files;
    • text: may be slow for large datasets, but no temporary file is involved;
    • auto (default) automatically choose the best strategy.
source
Gnuplot.gpversion — Function
Gnuplot.gpversion()

Return the gnuplot application version.

Raise an error if version is < 5.0 (required to use data blocks).

source
Gnuplot.quit — Function
Gnuplot.quit(sid::Symbol)

Quit the session identified by sid and the associated gnuplot process (if any).

source
Gnuplot.quitall — Function
Gnuplot.quitall()

Quit all the sessions and the associated gnuplot processes.

source
diff --git a/dev/assets/ex007a.png b/dev/assets/ex007a.png index 0ab3442..063fb5d 100644 Binary files a/dev/assets/ex007a.png and b/dev/assets/ex007a.png differ diff --git a/dev/assets/ex011.png b/dev/assets/ex011.png index 33cb578..149585f 100644 Binary files a/dev/assets/ex011.png and b/dev/assets/ex011.png differ diff --git a/dev/assets/ex013a.png b/dev/assets/ex013a.png index a5bd5e9..e973e45 100644 Binary files a/dev/assets/ex013a.png and b/dev/assets/ex013a.png differ diff --git a/dev/assets/ex013b.png b/dev/assets/ex013b.png index 379a784..95290c4 100644 Binary files a/dev/assets/ex013b.png and b/dev/assets/ex013b.png differ diff --git a/dev/assets/ex014a.png b/dev/assets/ex014a.png index e6ac284..65c95bf 100644 Binary files a/dev/assets/ex014a.png and b/dev/assets/ex014a.png differ diff --git a/dev/assets/ex014b.png b/dev/assets/ex014b.png index bddb2f9..ca78118 100644 Binary files a/dev/assets/ex014b.png and b/dev/assets/ex014b.png differ diff --git a/dev/assets/ex014c.png b/dev/assets/ex014c.png index 9589e48..0b77f71 100644 Binary files a/dev/assets/ex014c.png and b/dev/assets/ex014c.png differ diff --git a/dev/assets/ex014d.png b/dev/assets/ex014d.png index 1f8a782..cb8a68c 100644 Binary files a/dev/assets/ex014d.png and b/dev/assets/ex014d.png differ diff --git a/dev/basic/index.html b/dev/basic/index.html index 6d3cf44..30f8086 100644 --- a/dev/basic/index.html +++ b/dev/basic/index.html @@ -87,4 +87,4 @@ set size square set autoscale fix plot \ './script2_data/jl_vH8X4k' binary array=(512, 768) rotate=-90deg with rgbimage notit -set output

The above scripts can be loaded into a pure gnuplot session (Julia is no longer needed) as follows:

gunplot> load 'script1.gp'

to generate a plot identical to the original one.

The purpose of gnuplot scripts is to allow sharing all data, alongside a plot, in order to foster collaboration among scientists and replicability of results. Moreover, a script can be used at any time to change the details of a plot, without the need to re-run the Julia code used to generate it the first time.

Finally, the scripts are the only possible output when Dry sessions are used (i.e. when gnuplot is not available in the user platform.

+set output

The above scripts can be loaded into a pure gnuplot session (Julia is no longer needed) as follows:

gunplot> load 'script1.gp'

to generate a plot identical to the original one.

The purpose of gnuplot scripts is to allow sharing all data, alongside a plot, in order to foster collaboration among scientists and replicability of results. Moreover, a script can be used at any time to change the details of a plot, without the need to re-run the Julia code used to generate it the first time.

Finally, the scripts are the only possible output when Dry sessions are used (i.e. when gnuplot is not available in the user platform.

diff --git a/dev/examples/index.html b/dev/examples/index.html index aea901d..271b6e1 100644 --- a/dev/examples/index.html +++ b/dev/examples/index.html @@ -1,2 +1,2 @@ -Examples · Gnuplot.jl
Edit on GitHub

Examples

The official gallery of high quality examples is maintained in a separate repository:

https://lazarusa.github.io/gnuplot-examples/

The examples in this documentation are intentionally very simple, in order to focus on the package functionalities. The only relatively complex, publication-quality plot, is discussed in The cairolatex terminal section.

Keep in mind that Gnuplot.jl is just an interface to gnuplot, so everything you can do with the latter is achievable from Julia. Further gnuplot examples can be found here:

+Examples · Gnuplot.jl
Edit on GitHub

Examples

The official gallery of high quality examples is maintained in a separate repository:

https://lazarusa.github.io/gnuplot-examples/

The examples in this documentation are intentionally very simple, in order to focus on the package functionalities. The only relatively complex, publication-quality plot, is discussed in The cairolatex terminal section.

Keep in mind that Gnuplot.jl is just an interface to gnuplot, so everything you can do with the latter is achievable from Julia. Further gnuplot examples can be found here:

diff --git a/dev/index.html b/dev/index.html index 870e35f..00c9942 100644 --- a/dev/index.html +++ b/dev/index.html @@ -1,2 +1,2 @@ -Home · Gnuplot.jl
Edit on GitHub

Gnuplot.jl

A Julia interface to gnuplot.

The Gnuplot.jl package allows easy and fast use of gnuplot as a data visualization tool in Julia. Have a look at Basic usage and Examples for a quick overview. The package main features are:

  • fast time-to-first-plot (~1 sec);

  • extremely concise yet meaningful syntax, makes it ideal for interactive data exploration;

  • no need to learn new API functions or keywords: only two macros (@gp for 2D plots, @gsp for 3D plots) and a basic knowledge of gnuplot are enough to generate most plots;

  • transparent interface between Julia and gnuplot to exploit all functionalities of the latter, both present and future ones;

  • availability of all the palettes from ColorSchemes;

  • support for multiple plots in one window, multiple plotting windows, as well as ASCII and Sixel plots (to plot directly in a terminal);

  • support for histograms (both 1D and 2D);

  • enhanced support for contour plots;

  • export to a huge number of formats such as pdf, png, $\LaTeX$, svg, etc. (actually all those supported by gnuplot);

  • save sessions into gnuplot scripts enables easy plot reproducibility and modifications.

If you're unfamiliar with gnuplot have a look at:

Yet another plotting package?

A powerful plotting framework is among the most important tool in the toolbox of any modern scientist and engineer. As such, it is hard to find a single package to fit all needs, and many solutions are indeed available in the Julia ecosystem.

Gnuplot.jl package fills the niche of users who needs:

  1. publication-quality plots, by exploiting the capabilities of a widely used tool such as gnuplot, and its many output formats available;
  2. a well-documented framework, by taking advantage of all the gnuplot documentation, tutorials and examples available on the web;
  3. a fast response, by relying on an external program (rather than on a large Julia code base);
  4. an interactive data exploration framework, by exposing a carefully designed, extremely concise and easy to remember syntax (at least for users with minimal gnuplot knowledge);
  5. a procedure to foster plot reproducibility by sharing just the data and commands in the form of gnuplot scripts, rather than the original Julia code.

Unlike other packages Gnuplot.jl is not a pure Julia solution as it depends on an external package to actually generate plots. However, if gnuplot is not available on a given platform, the package could still be used in "dry" mode, and no error for a missing dependency will be raised (see Dry sessions).

The Gnuplot.jl package development follows a minimalistic approach: it is essentially a thin layer to send data and commands to gnuplot. This way all underlying capabilities, both present and future ones, are automatically exposed to Julia user, with no need to implement dedicated wrappers.

The functionalities 1, 2 and 3 listed above are similar to those provided by the Gaston package. Gnuplot.jl also provides features 4 and 5, as well as the minimalistic approach.

Do Gnuplot.jl suits my needs?

Any modern plotting package is able to produce a simple scatter plot, with custom symbols, line styles, colors and axis labels. Indeed, this is exactly the example that is reported in every package documentation (also here: see 2D plots). Still, producing complex and publication-quality plots is not an easy task. As a consequence is also not easy to determine whether a package can cope with the most difficult cases (unless you actually try it out) and a reasonable choice is typically to rely on the size of the user base, the availability of documentation / tutorials, and the possibility to preview complex examples.

Gnuplot.jl aims to be ready for even the most challenging plots by relying on the widely and long lasting used gnuplot application, and by allowing each native feature (both present and future ones) to be immediately available in the Julia language. Moreover, Gnuplot.jl provides a unique syntax specifically aimed to increase productivity while performing interactive data exploration.

Last but not least, have a look at the Gnuplot.jl Examples page.

Notation

In this documentation:

  • Gnuplot.jl refers to the Julia package;
  • gnuplot refers to the gnuplot application.

Table of Contents

+Home · Gnuplot.jl
Edit on GitHub

Gnuplot.jl

A Julia interface to gnuplot.

The Gnuplot.jl package allows easy and fast use of gnuplot as a data visualization tool in Julia. Have a look at Basic usage and Examples for a quick overview. The package main features are:

  • fast time-to-first-plot (~1 sec);

  • extremely concise yet meaningful syntax, makes it ideal for interactive data exploration;

  • no need to learn new API functions or keywords: only two macros (@gp for 2D plots, @gsp for 3D plots) and a basic knowledge of gnuplot are enough to generate most plots;

  • transparent interface between Julia and gnuplot to exploit all functionalities of the latter, both present and future ones;

  • availability of all the palettes from ColorSchemes;

  • support for multiple plots in one window, multiple plotting windows, as well as ASCII and Sixel plots (to plot directly in a terminal);

  • support for histograms (both 1D and 2D);

  • enhanced support for contour plots;

  • export to a huge number of formats such as pdf, png, $\LaTeX$, svg, etc. (actually all those supported by gnuplot);

  • save sessions into gnuplot scripts enables easy plot reproducibility and modifications.

If you're unfamiliar with gnuplot have a look at:

Yet another plotting package?

A powerful plotting framework is among the most important tool in the toolbox of any modern scientist and engineer. As such, it is hard to find a single package to fit all needs, and many solutions are indeed available in the Julia ecosystem.

Gnuplot.jl package fills the niche of users who needs:

  1. publication-quality plots, by exploiting the capabilities of a widely used tool such as gnuplot, and its many output formats available;
  2. a well-documented framework, by taking advantage of all the gnuplot documentation, tutorials and examples available on the web;
  3. a fast response, by relying on an external program (rather than on a large Julia code base);
  4. an interactive data exploration framework, by exposing a carefully designed, extremely concise and easy to remember syntax (at least for users with minimal gnuplot knowledge);
  5. a procedure to foster plot reproducibility by sharing just the data and commands in the form of gnuplot scripts, rather than the original Julia code.

Unlike other packages Gnuplot.jl is not a pure Julia solution as it depends on an external package to actually generate plots. However, if gnuplot is not available on a given platform, the package could still be used in "dry" mode, and no error for a missing dependency will be raised (see Dry sessions).

The Gnuplot.jl package development follows a minimalistic approach: it is essentially a thin layer to send data and commands to gnuplot. This way all underlying capabilities, both present and future ones, are automatically exposed to Julia user, with no need to implement dedicated wrappers.

The functionalities 1, 2 and 3 listed above are similar to those provided by the Gaston package. Gnuplot.jl also provides features 4 and 5, as well as the minimalistic approach.

Do Gnuplot.jl suits my needs?

Any modern plotting package is able to produce a simple scatter plot, with custom symbols, line styles, colors and axis labels. Indeed, this is exactly the example that is reported in every package documentation (also here: see 2D plots). Still, producing complex and publication-quality plots is not an easy task. As a consequence is also not easy to determine whether a package can cope with the most difficult cases (unless you actually try it out) and a reasonable choice is typically to rely on the size of the user base, the availability of documentation / tutorials, and the possibility to preview complex examples.

Gnuplot.jl aims to be ready for even the most challenging plots by relying on the widely and long lasting used gnuplot application, and by allowing each native feature (both present and future ones) to be immediately available in the Julia language. Moreover, Gnuplot.jl provides a unique syntax specifically aimed to increase productivity while performing interactive data exploration.

Last but not least, have a look at the Gnuplot.jl Examples page.

Notation

In this documentation:

  • Gnuplot.jl refers to the Julia package;
  • gnuplot refers to the gnuplot application.

Table of Contents

diff --git a/dev/install/index.html b/dev/install/index.html index 044f7b3..65078ca 100644 --- a/dev/install/index.html +++ b/dev/install/index.html @@ -2,4 +2,4 @@ Installation · Gnuplot.jl
Edit on GitHub

Installation

Prerequisite

In order to use the Gnuplot.jl package you'll need gnuplot (ver. >= 5.0) installed on your system, and its executable available in your path.

If gnuplot is not available in your platform you can still use Gnuplot.jl in "dry" mode (see Dry sessions). In this case a plot can not be generated, but you may still generate Gnuplot scripts.

Package installation

In the Julia REPL type:

julia> ]add Gnuplot

Then hit backspace key to return to Julia REPL.

Check installation

Check execution and version of the underlying gnuplot process:

julia> using Gnuplot
 
 julia> Gnuplot.gpversion()
-v"5.2.0"

Generate the first plot:

julia> @gp 1:9

Test default terminal capabilities:

test_terminal()
+v"5.2.0"

Generate the first plot:

julia> @gp 1:9

Test default terminal capabilities:

test_terminal()
diff --git a/dev/search/index.html b/dev/search/index.html index fa2ba45..4837810 100644 --- a/dev/search/index.html +++ b/dev/search/index.html @@ -1,2 +1,2 @@ -Search · Gnuplot.jl

Loading search...

    +Search · Gnuplot.jl

    Loading search...

      diff --git a/dev/terminals/index.html b/dev/terminals/index.html index 9e1d953..1a9f2ae 100644 --- a/dev/terminals/index.html +++ b/dev/terminals/index.html @@ -24,4 +24,4 @@ save(term="cairolatex pdf input color dashed size 5in,3.3in", output=& \begin{figure} \input{test.tex} \end{figure} -\end{document}

      And the output is:

      +\end{document}

      And the output is: