gnuplot 2.3.4 → 2.3.5

data/AUTHORS.txt

@@ -1,5 +1,6 @@
 Gordon James Miller
 Ara T. Howard
 Roger Pack
-Mike Cahill (minor edits)
-jakobs
+Mike Cahill
+jakobs
+blambeau

data/ChangeLog

@@ -1,3 +1,6 @@
+2.3.5
+ * Cleanup readme, add examples as real code files (thanks blambeau!)
+
 2.3.4
  * Include more files in the gem by switching to Jeweler (thanks Jeweler guyz)!
 

data/README.textile

@@ -86,7 +86,8 @@ p. Send the Plot/Splot object to a Gnuplot instance for
     
 Gnuplot.open 
 
-
+
+bq. 
       Instantiates a new Gnuplot process.  The path to the executable is
       determined on a Unix or MacOSX system using the which command.  Windows
       users, I have no idea what to do.
@@ -95,7 +96,8 @@ Gnuplot.open
     
 Plot.new 
 
-
+
+SPlot.new
  
 bq. 
       Create a new Plot or Splot object.  DataSets are attached to the object
@@ -125,7 +127,8 @@ bq.
     
 h2.  Examples 
 
-
+
+h3.  Simple sin wave 
 
 bq. The following example simply plots the value of sin(x) between the
       ranges of -10 and 10.  A few points to notice:
@@ -153,7 +156,7 @@ p.  When the plot block ends, if an IO object is given to the Plot
 	  Any object can be passed to the constructor as long as it
 	  understands the << operator.
 	  
-<pre><code>
+<pre>
 Gnuplot.open do |gp|
   Gnuplot::Plot.new( gp ) do |plot|
   
@@ -170,13 +173,16 @@ Gnuplot.open do |gp|
   end
   
 end
+</pre>
 
-
+
+h3. Plotting discrete points
 
 Array data can be plotted quite easily since Arrays have a defined to_gplot method.
 
 Simply pass an array of data to the constructor of the DataSet object or set the data property of the DataSet. In this example, because there are two arrays, each array will be a single column of data to the gnuplot process.
 
+<pre>
 Gnuplot.open do |gp|
   Gnuplot::Plot.new( gp ) do |plot|
   
@@ -193,13 +199,15 @@ Gnuplot.open do |gp|
     end
   end
 end
+</pre>
     
-Multiple Data Sets
+h3. Multiple Data Sets
 
 As many data sets as are desired can be attached to a plot. Each of these can have their own plot modifiers. Notice in this example how the data array is explicitly set instead of using the << operator.
 
 Also in this example, the commands are not written to the Gnuplot process but are instead written to a File called gnuplot.dat. This file can later be run directly by a gnuplot process as it contains only the gnuplot commands.
 
+<pre>
 File.open( "gnuplot.dat", "w") do |gp|
   Gnuplot::Plot.new( gp ) do |plot|
   
@@ -225,10 +233,11 @@ File.open( "gnuplot.dat", "w") do |gp|
     ]
 
   end
-  
 end
-    
+</pre>    
 
-You can also add atribtrary lines to the output 
+You can also add arbitrary lines to the output 
 
+<pre>
 plot.arbitrary_lines << "set ylabel \"y label" font \"Helvetica,20\""
+</pre>

data/Rakefile

@@ -2,7 +2,7 @@ require 'jeweler'
 Jeweler::Tasks.new do |s|
   s.name = 'gnuplot'
   s.description = s.summary = "Utility library to aid in interacting with gnuplot"
-  s.version = "2.3.4"
+  s.version = "2.3.5"
   s.autorequire = 'gnuplot.rb'
   s.email = "rogerpack2005@gmail.com"
   s.homepage = "http://github.com/rdp/ruby_gnuplot/tree/master"

data/examples/.gitignore

@@ -0,0 +1 @@
+sin_wave.gif

data/examples/discrete_points.rb

@@ -0,0 +1,19 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require "gnuplot"
+Gnuplot.open do |gp|
+  Gnuplot::Plot.new( gp ) do |plot|
+  
+    plot.title  "Array Plot Example"
+    plot.ylabel "x"
+    plot.xlabel "x^2"
+    
+    x = (0..50).collect { |v| v.to_f }
+    y = x.collect { |v| v ** 2 }
+
+    plot.data << Gnuplot::DataSet.new( [x, y] ) do |ds|
+      ds.with = "linespoints"
+      ds.notitle
+    end
+
+  end
+end

data/examples/multiple_data_sets.rb

@@ -0,0 +1,28 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require "gnuplot"
+Gnuplot.open do |gp|
+  Gnuplot::Plot.new( gp ) do |plot|
+  
+    plot.xrange "[-10:10]"
+    plot.title  "Sin Wave Example"
+    plot.ylabel "x"
+    plot.xlabel "sin(x)"
+    
+    x = (0..50).collect { |v| v.to_f }
+    y = x.collect { |v| v ** 2 }
+
+    plot.data = [
+      Gnuplot::DataSet.new( "sin(x)" ) { |ds|
+        ds.with = "lines"
+        ds.title = "String function"
+    	  ds.linewidth = 4
+      },
+    
+      Gnuplot::DataSet.new( [x, y] ) { |ds|
+        ds.with = "linespoints"
+        ds.title = "Array data"
+      }
+    ]
+
+  end
+end

data/examples/output_image_file.rb

@@ -0,0 +1,32 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require "gnuplot"
+
+# See sin_wave.rb first
+Gnuplot.open do |gp|
+  Gnuplot::Plot.new( gp ) do |plot|
+  
+    # The following lines allow outputting the graph to an image file. 
+    # The first set the kind of image that you want, while the second
+    # redirects the output to a given file. 
+    #
+    # Typical terminals: gif, png, postscript, latex, texdraw
+    #
+    # See http://mibai.tec.u-ryukyu.ac.jp/~oshiro/Doc/gnuplot_primer/gptermcmp.html
+    # for a list of recognized terminals.
+    #
+    plot.terminal "gif"
+    plot.output   File.expand_path("../sin_wave.gif", __FILE__)
+  
+    # see sin_wave.rb
+    plot.xrange "[-10:10]"
+    plot.title  "Sin Wave Example"
+    plot.ylabel "x"
+    plot.xlabel "sin(x)"
+    
+    plot.data << Gnuplot::DataSet.new( "sin(x)" ) do |ds|
+      ds.with = "lines"
+      ds.linewidth = 4
+    end
+    
+  end
+end

data/examples/sin_wave.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require "gnuplot"
+Gnuplot.open do |gp|
+  Gnuplot::Plot.new( gp ) do |plot|
+  
+    plot.xrange "[-10:10]"
+    plot.title  "Sin Wave Example"
+    plot.ylabel "x"
+    plot.xlabel "sin(x)"
+    
+    plot.data << Gnuplot::DataSet.new( "sin(x)" ) do |ds|
+      ds.with = "lines"
+      ds.linewidth = 4
+    end
+    
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 2
   - 3
-  - 4
-  version: 2.3.4
+  - 5
+  version: 2.3.5
 platform: ruby
 authors: []
 
@@ -14,7 +14,7 @@ autorequire: gnuplot.rb
 bindir: bin
 cert_chain: []
 
-date: 2010-08-02 00:00:00 -06:00
+date: 2011-01-29 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -34,6 +34,11 @@ files:
 - LICENSE.txt
 - README.textile
 - Rakefile
+- examples/.gitignore
+- examples/discrete_points.rb
+- examples/multiple_data_sets.rb
+- examples/output_image_file.rb
+- examples/sin_wave.rb
 - lib/gnuplot.rb
 - test/arrtest.rb
 - test/histtest.rb
@@ -45,8 +50,8 @@ homepage: http://github.com/rdp/ruby_gnuplot/tree/master
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -73,6 +78,10 @@ signing_key:
 specification_version: 3
 summary: Utility library to aid in interacting with gnuplot
 test_files: 
+- examples/discrete_points.rb
+- examples/multiple_data_sets.rb
+- examples/output_image_file.rb
+- examples/sin_wave.rb
 - test/arrtest.rb
 - test/histtest.rb
 - test/multtest.rb