gnuplotr 0.1 → 0.2

data/README.markdown

@@ -11,24 +11,60 @@ Here's a quick example:
 	# Instantiate
 	gp = GNUPlotr.new
 
-	# add an empty data series
-	gp.new_series :parabola
-
-	# fill the series with pairs. This creates the parabola.dat file
+	# Create and fill a new series with pairs. This creates the parabola.dat file
+	# Block-based way to do it:
 	gp.fill_series(:parabola) do |series|
 	  (0..99).each do |i|
 	    series << [i, i**2]
 	  end
 	end
 
+	# conventional way:
+	gp.new_series(:parabola_2)
+	(0..99).each do |i|
+	  gp.series[:parabola_2] << [i, i**2]
+	end
+	gp.series[:parabola_2].close  # Remember to call this!
+
+
 	# enable command history recording
 	gp.record = true
 
+	# Issue raw gnuplot commands
+	gp.raw "set grid"
+
+	# Some magic mapping works too:
+	gp.set_grid
+	gp.set_title 'GNUPlotr example'
+	gp.set_xlabel 'x', :offset => 3, :font => "Times New Roman,26"
+	gp.set_ylabel "f(x)"
+
 	# issue plotting commands, either with named data series
-	gp.plot :parabola, "using 1:2 with points"
+	gp.plot :parabola, "using 1:2 with points axes x1y1"
 
 	# or with formulas. Options are collected in a string passed as second optional argument
 	gp.replot "x**2", "with lines"
 
+
 	# command history can be dumper and possibly saved on file to be edited or loaded again later on.
-	puts gp.dump_input
+	puts gp.dump_input
+	
+Installation
+------------
+
+As usual, use the gem:
+
+	% [sudo] gem install gnuplotr
+
+Needless to say, you probably have to install a GNUPlot version in order to use gnuplotr. At the moment, gnuplotr is not too smart in detecting your GNUPlot installation path: it simply assumes that you are on MAC OS X and that you installed it via port, so that the executable is on /opt/local/bin/gnuplot.
+
+If that is not your case, you must specify GNUPlot path as argument when you instantiate gnuplotr:
+
+	gp = GNUPlotr.new("/path/to/your/gnuplot")
+	
+**Please Note**: on Mac OS X, it seems that GNUPlot fails plotting on AquaTerm the first time you use it. To overcome this problem, do like that:
+
+1. launch GNUPlot in Terminal and type some plotting command (*e.g.* plot sin(x)). Most probably nothing will happen.
+2. Manually launch AquaTerm (it is in Applications)
+3. Exit GNUPlot and launch it again, then try again to plot. Now it should work fine.
+4. From now on, gnuplotr should work fine too, and you even don't need to pre-launch AquaTerm (it will open automatically).

data/lib/gnuplotr.rb

@@ -49,9 +49,17 @@ class GNUPlotr
   
   def fill_series(name)
     raise "Need a block" unless block_given?
+    new_series(name) unless @series[name]
     yield @series[name]
     @series[name].close
   end
+  
+  def method_missing(name, *args, &block)
+    options = args.inject("") {|s, t|
+      s + " " + parse_tokens(t)
+    }
+    raw "#{name.to_s.sub(/_/, " ")} #{options}"
+  end
     
   def raw(message)
     @record_list << message if @record
@@ -93,13 +101,29 @@ class GNUPlotr
       yield line if line =~ /^\s*\w+/ 
     end
   end
+  
+  def parse_tokens(t)
+    case t
+    when Symbol
+      t.to_s
+    when String
+      "'#{t}'"
+    when Hash
+      r = ""
+      t.each {|k,v|
+        r += " #{k.to_s} #{parse_tokens(v)}"
+      }
+      r
+    else
+      t.to_s
+    end
+  end
 end
 
 
 
 if $0 == __FILE__
   gp = GNUPlotr.new
-  gp.new_series :parabola
   gp.fill_series(:parabola) do |s|
     (0..99).each do |i|
       s << [i, i**2]

data/test.rb

@@ -9,24 +9,40 @@ require './lib/gnuplotr'
 # Instantiate
 gp = GNUPlotr.new
 
-# add an empty data series
-gp.new_series :parabola
-
-# fill the series with pairs. This creates the parabola.dat file
+# Create and fill a new series with pairs. This creates the parabola.dat file
+# Block-based way to do it:
 gp.fill_series(:parabola) do |series|
   (0..99).each do |i|
     series << [i, i**2]
   end
 end
 
+# conventional way:
+gp.new_series(:parabola_2)
+(0..99).each do |i|
+  gp.series[:parabola_2] << [i, i**2]
+end
+gp.series[:parabola_2].close  # Remember to call this!
+
+
 # enable command history recording
 gp.record = true
 
+# Issue raw gnuplot commands
+gp.raw "set grid"
+
+# Some magic mapping works too:
+gp.set_grid
+gp.set_title 'GNUPlotr example'
+gp.set_xlabel 'x', :offset => 3, :font => "Times New Roman,26"
+gp.set_ylabel "f(x)"
+
 # issue plotting commands, either with named data series
-gp.plot :parabola, "using 1:2 with points"
+gp.plot :parabola, "using 1:2 with points axes x1y1"
 
 # or with formulas. Options are collected in a string passed as second optional argument
 gp.replot "x**2", "with lines"
 
+
 # command history can be dumper and possibly saved on file to be edited or loaded again later on.
 puts gp.dump_input

metadata

@@ -2,7 +2,7 @@
 name: gnuplotr
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: "0.1"
+  version: "0.2"
 platform: ruby
 authors: 
 - Paolo Bosetti
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-23 00:00:00 -08:00
+date: 2011-02-24 00:00:00 -08:00
 default_executable: 
 dependencies: []