document how to use Chart::Gnuplot on jupyter

titsuki · Mar 21, 2023 · c54b111 · c54b111
1 parent 81c342f
commit c54b111
Show file tree

Hide file tree

Showing 4 changed files with 429 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -9,3 +9,6 @@
 /gnuplot-*
 /example/*
 *.svg
+/notebooks/.ipynb_checkpoints/
+/notebooks/jupyter.log
+/notebooks/nohup.out
diff --git a/README.md b/README.md
@@ -709,6 +709,62 @@ Recall-Precision Curve
 
 <img src="recprec.png" alt="recall precision curve">
 
+How to use Chart::Gnuplot on jupyter?
+=====================================
+
+One way to do this is:
+
+1) Write a svg image as a tmp file. 2) Read this tmp file and remove the first superfluous line.
+
+If you haven't setup Raku kernel yet, use [Jupyter::Kernel](https://github.com/bduggan/raku-jupyter-kernel).
+
+### SOURCE
+
+    use Chart::Gnuplot;
+    use Chart::Gnuplot::Subset;
+    use File::Temp;
+
+    my ($filename, $filehandle);
+
+    # NOTE: Shouldn't remove both ENTER and LEAVE blocks. File::Temp's auto-unlink doesn't seem to work on jupyter.
+    ENTER {
+      ($filename, $filehandle) = tempfile(:tempdir("/tmp"), :suffix(".svg"));
+    }
+
+    LEAVE {
+      $filehandle.close;
+      $filename.IO.unlink;
+    }
+
+    my $gnu = Chart::Gnuplot.new(:terminal("svg"), :filename($filename));
+
+    my @data = (q:to/EOF/).split("\n", :skip-empty)>>.split(" ", :skip-empty);
+    Year Male Female
+    1950 100 90
+    1960 100 90
+    1970 80 70
+    1980 130 140
+    1990 140 120
+    2000 200 210
+    2010 240 230
+    2020 400 420
+    EOF
+
+    my ($header, *@body) = @data;
+
+    $gnu.command("set style histogram clustered");
+    $gnu.legend(:left);
+    my AnyTicsTic @tics = (@body>>.[0]).pairs.map(-> (:key($pos), :value($year)) { %(:label($year), :pos($pos)) });
+    $gnu.xtics(:tics(@tics));
+    $gnu.xlabel(:label($header[0]));
+    $gnu.plot(:vertices(@body), :using([2]), :style("histogram"), :title($header[1]), :fill("solid 1.0"));
+    $gnu.plot(:vertices(@body), :using([3]), :style("histogram"), :title($header[2]), :fill("solid 1.0"));
+    $gnu.dispose;
+
+    $filehandle.lines[1..*].join("\n");
+
+The example ipynb file is here: [/notebooks/synopsys.ipynb](/notebooks/synopsys.ipynb).
+
 AUTHOR
 ======
 

diff --git a/lib/Chart/Gnuplot.pm6 b/lib/Chart/Gnuplot.pm6
@@ -1041,6 +1041,62 @@ Runs a given C<$command>. If there are no appropriate interfaces, this method wi
 
 =end para
 
+=head1 How to use Chart::Gnuplot on jupyter?
+
+One way to do this is:
+
+1) Write a svg image as a tmp file.
+2) Read this tmp file and remove the first superfluous line.
+
+If you haven't setup Raku kernel yet, use L<Jupyter::Kernel|https://github.com/bduggan/raku-jupyter-kernel>.
+
+=head3 SOURCE
+
+    use Chart::Gnuplot;
+    use Chart::Gnuplot::Subset;
+    use File::Temp;
+
+    my ($filename, $filehandle);
+
+    # NOTE: Shouldn't remove both ENTER and LEAVE blocks. File::Temp's auto-unlink doesn't seem to work on jupyter.
+    ENTER {
+      ($filename, $filehandle) = tempfile(:tempdir("/tmp"), :suffix(".svg"));
+    }
+
+    LEAVE {
+      $filehandle.close;
+      $filename.IO.unlink;
+    }
+
+    my $gnu = Chart::Gnuplot.new(:terminal("svg"), :filename($filename));
+
+    my @data = (q:to/EOF/).split("\n", :skip-empty)>>.split(" ", :skip-empty);
+    Year Male Female
+    1950 100 90
+    1960 100 90
+    1970 80 70
+    1980 130 140
+    1990 140 120
+    2000 200 210
+    2010 240 230
+    2020 400 420
+    EOF
+
+    my ($header, *@body) = @data;
+
+    $gnu.command("set style histogram clustered");
+    $gnu.legend(:left);
+    my AnyTicsTic @tics = (@body>>.[0]).pairs.map(-> (:key($pos), :value($year)) { %(:label($year), :pos($pos)) });
+    $gnu.xtics(:tics(@tics));
+    $gnu.xlabel(:label($header[0]));
+    $gnu.plot(:vertices(@body), :using([2]), :style("histogram"), :title($header[1]), :fill("solid 1.0"));
+    $gnu.plot(:vertices(@body), :using([3]), :style("histogram"), :title($header[2]), :fill("solid 1.0"));
+    $gnu.dispose;
+
+    $filehandle.lines[1..*].join("\n");
+
+The example ipynb file is here: L</notebooks/synopsys.ipynb|/notebooks/synopsys.ipynb>.
+
 =head1 AUTHOR
 
 titsuki <titsuki@cpan.org>