ruby-netcdf 0.6.5

data/LICENSE.txt

@@ -0,0 +1,59 @@
+Ruby/NetCDF is copyrighted free software by Takeshi Horinouchi and the 
+GFD Dennou Club.
+You can redistribute it and/or modify it under either the terms of the
+GPL, or the conditions below, which is idential to Ruby's license
+(http://www.ruby-lang.org/en/LICENSE.txt):
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict
+	  with standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under this terms.
+
+     They are gc.c(partly), utils.c(partly), regex.[ch], st.[ch] and some
+     files under the ./missing directory.  See each file for the copying
+     condition.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/Rakefile

@@ -0,0 +1,40 @@
+require 'rake/gempackagetask'
+
+NAME = 'ruby-netcdf'
+VER = '0.6.5'
+
+PKG_FILES = FileList[
+  '**',
+  'lib/**/*',
+  'demo/**/*',
+  'doc/**/*',
+  'test/**/*'
+]
+
+spec = Gem::Specification.new do |s|
+  s.name             = NAME
+  s.version          = VER
+  s.authors           = ['T. Horinouchi','T. Sakakima',\
+                'GFD Dennou Club' ]
+  s.email            = 'eriko@gfd-dennou.org'
+  s.homepage         = 'http://www.gfd-dennou.org/arch/ruby/products/ruby-netcdf/'
+  s.licenses         = ["GFD Dennou Club"]
+  s.platform         = Gem::Platform::RUBY
+  s.summary          = 'Ruby interface to NetCDF'
+  s.description      = 'RubyNetCDF is the Ruby interface to the NetCDF library built on the NArray library, which is an efficient multi-dimensional numeric array class for Ruby.'
+  s.files            = PKG_FILES.to_a
+  s.require_paths    = ['lib']
+  s.test_files = Dir.glob("test/*")
+  s.has_rdoc         = true
+  s.required_ruby_version = Gem::Requirement.new(">= 1.6")
+  s.add_runtime_dependency(%q<narray>, [">= 0"])
+  s.add_runtime_dependency(%q<narray_miss>, [">= 0"])
+  #s.extra_rdoc_files = ['README']
+
+  s.extensions << "extconf.rb"
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+  pkg.need_tar = true
+end

data/ToDo

@@ -0,0 +1 @@
+* none currently

data/demo/README

@@ -0,0 +1,14 @@
+
+* demo1-create.rb	a basic test of file creation.
+			creates a file and prints its contents.
+* demo1-create-alt.rb	an alternative way to write demo1-create.rb
+* demo2-graphic.rb	creates a file and close it. Then reopens and
+			visualize it using AdvancedDCL
+			(AdvancedDCL at http://www.gfd-dennou.org/arch/ruby/
+			must have been installed)
+
+* demo3-ncepclim.rb	plots arbitrary 2D slices the 4D distribution of
+			global temperature climatology from
+			the NCEP reanalysis data. The data (8MB) is downloaded
+			by anonymous ftp if not found in the user's
+			run-time directory and he or she wants it.

data/demo/demo1-create-alt.rb

@@ -0,0 +1,35 @@
+require "numru/netcdf"
+include NumRu
+
+file = NetCDF.create("test.nc")
+nx, ny = 10, 5
+file.def_dim("x",nx)
+file.def_dim("y",ny)
+file.def_dim("t",0)
+require "date"
+file.put_att("history","created by #{$0}  #{Date.today}")
+
+x = file.def_var("x","sfloat",["x"])
+y = file.def_var("y","sfloat",["y"])
+t = file.def_var("t","sfloat",["t"])
+v1 = file.def_var("v1","sfloat",["x","y"])
+v1.put_att("long_name","test 1")
+v1.put_att("units","1")
+v2 = file.def_var("v2","sfloat",["x","y","t"])
+v2.put_att("long_name","test 2")
+v2.put_att("units","1")
+file.enddef
+
+x.put( NArray.float(nx).indgen! )
+y.put( NArray.float(ny).indgen! )
+
+z = NArray.float(nx,ny).indgen!*0.1
+v1.put(z)
+v1.put( NArray.float(nx).add!(20), "start"=>[0,2],"end"=>[-1,2])
+v2.put(z, "start"=>[0,0,0],"end"=>[-1,-1,0])
+t.put( 0, "index"=>[0])
+v2.put(-z, "start"=>[0,0,1],"end"=>[-1,-1,1])
+t.put( 1, "index"=>[1])
+
+file.close
+print `ncdump test.nc`

data/demo/demo1-create.rb

@@ -0,0 +1,35 @@
+require "numru/netcdf"
+include NumRu
+
+file = NetCDF.create("test.nc")
+nx, ny = 10, 5
+xdim = file.def_dim("x",nx)
+ydim = file.def_dim("y",ny)
+tdim = file.def_dim("t",0)
+require "date"
+file.put_att("history","created by #{$0}  #{Date.today}")
+
+x = file.def_var("x","sfloat",[xdim])
+y = file.def_var("y","sfloat",[ydim])
+t = file.def_var("t","sfloat",[tdim])
+v1 = file.def_var("v1","sfloat",[xdim,ydim])
+v1.put_att("long_name","test 1")
+v1.put_att("units","1")
+v2 = file.def_var("v2","sfloat",[xdim,ydim,tdim])
+v2.put_att("long_name","test 2")
+v2.put_att("units","1")
+file.enddef
+
+x.put( NArray.float(nx).indgen! )
+y.put( NArray.float(ny).indgen! )
+
+z = NArray.float(nx,ny).indgen!*0.1
+v1.put(z)
+v1.put( NArray.float(nx).add!(20), "start"=>[0,2],"end"=>[-1,2])
+v2.put(z, "start"=>[0,0,0],"end"=>[-1,-1,0])
+t.put( 0, "index"=>[0])
+v2.put(-z, "start"=>[0,0,1],"end"=>[-1,-1,1])
+t.put( 1, "index"=>[1])
+
+file.close
+print `ncdump test.nc`

data/demo/demo2-graphic.rb

@@ -0,0 +1,67 @@
+require "numru/dcl"
+require "numru/netcdf"
+include NumRu
+include NMath
+
+## < create a sample netcdf file >
+def write_file
+
+   file = NetCDF.create("test.nc")
+   nx, ny = 21, 21
+   xdim = file.def_dim("x",nx)
+   ydim = file.def_dim("y",ny)
+   
+   x = file.def_var("x","sfloat",["x"])
+   y = file.def_var("y","sfloat",["y"])
+   var = file.def_var("var","float",["x","y"])
+   var.put_att("long_name","test variable")
+   file.enddef
+
+   vx =  NArray.float(nx).indgen! * (2*(Math::PI)*1.5/(nx-1))
+   vy =  NArray.float(ny).indgen! * (2*(Math::PI)*1.0/(ny-1))
+   x.put( vx )
+   y.put( vy )
+
+   sx = sin( vx )
+   sy = sin( vy )
+   z = NArray.float(nx,ny)
+   for j in 0..ny-1
+      z[true,j] = sx * sy[j] + 0.00001
+   end
+
+   var.put(z)
+
+   file.close
+   print `ncdump -h test.nc`
+end
+
+## < read the file and plot >
+def draw_graph
+
+   file = NetCDF.open("test.nc")
+   vx = file.var("x")
+   vy = file.var("y")
+   vz = file.var("var")
+   x = vx.get
+   y = vy.get
+   z = vz.get
+   file.close
+
+   #DCL.swlset('ldump',1)
+   DCL.gropn(1)
+   DCL.grfrm
+   DCL.usspnt(x, y)
+   DCL.uspfit
+   DCL.usdaxs
+   DCL.sglset("lsoftf",false)
+   DCL.uegtlb(z, -20)  # set the number of levels
+   DCL.uelset("ltone",true)
+   DCL.uetone(z)
+   DCL.udcntz(z)
+   DCL.grcls
+end
+
+###(main)###
+write_file
+draw_graph
+###(main)###

data/demo/demo3-ncepclim.rb

@@ -0,0 +1,178 @@
+# Plot global climatological temperature distribution
+# from the NCEP reanalysis data.
+# The data is downloaded if not found and the users wants.
+
+######################################
+### local functions  ###
+def nearest_index(na,val)
+   # returns the element of na nearest to val
+   # na is assumed to be 1d and monotonic
+
+   if(na[0] > na[-1]) then
+      reversed = true
+      na = na[-1..0]
+   else
+      reversed = false
+   end
+
+   w = (na.lt(val)).where
+   idx = [ (w.length==0 ? 0 : w.max), na.length-2 ].min
+   if ( na[idx+1]-val < val-na[idx] ) then
+      idx = idx+1
+   end
+
+   if reversed then
+      na = na[-1..0]
+      idx = na.length-1-idx
+   end
+
+   idx
+end
+#####################################
+### main part ###
+require "numru/dcl"
+require "numru/netcdf"
+include NumRu
+
+filename = "air.mon.ltm.nc"
+
+# < download if not found and the users wants >
+
+if !(Dir.glob(filename)[0]) then
+   # file not found ==> download by ftp if the user wants
+   host = "ftp.cdc.noaa.gov"
+   path = "/Datasets/ncep.reanalysis.derived/pressure/"+filename
+   print "\n*** question ***\n",
+         "  File "+filename+" is not in the current directory.\n",
+         "  Would you like to download (ftp) it from "+host+"?\n",
+         "  (y, n)> "
+   ans = gets
+   if ans =~ /^y/ then
+      print "  What is your email address? (needed for anonymous ftp) > "
+      email = gets.chop!
+      require "net/ftp"
+      print "  connecting...\n"
+      ftp = Net::FTP.open(host, "anonymous", email, nil) 
+      size = ftp.size(path)
+      print "  Size of the file is #{(size/1000)} kb. Would you really like to download?\n  (y, n)> "
+      ans = gets
+      if ans =~ /^y/ then
+	 print "  now downloading...\n"
+	 ftp.getbinaryfile(path, filename)
+      else
+	 print "  exit\n"
+	 exit
+      end
+   else
+      print "  exit\n"
+      exit
+   end
+end
+
+# < open the file and read axes >
+
+file = NetCDF.open(filename)
+var = file.var("air")      # temperature
+
+lon = file.var("lon")
+lat = file.var("lat")
+level = file.var("level")
+time = file.var("time")     # in hours
+t = (time.get/720).round + 1     # --> in months
+axes = [ lon, lat, level, time ]
+axvals = [ lon.get, lat.get, level.get, t ]
+axunits = [ lon.att("units").get.gsub("_",""), 
+            lat.att("units").get.gsub("_",""), 
+            level.att("units").get.gsub("_",""),
+            "months" ]
+# < graphics >
+
+#DCL.sglset('lbuff',false)
+DCL.swlset('lwait',false)
+DCL.gropn(1)
+
+first = true
+while true do
+   begin
+
+      ## / select a 2D slice /
+
+      if (first) then
+	 print <<-EOS
+	 ** select a slice **
+	 List desired grid numbers of lonigutede, latitude, level, time
+	 (set only two of them)
+
+	 Example: 
+	   , , 850, 1
+		   -- horizontal slice at 850hPa and January
+	   135, , , 2
+		   -- vertical slice at 135E and Feburary
+	 EOS
+	 DCL.grfrm
+      else
+	 DCL.grfrm
+	 print "Input next slice (C-d to quit)\n"
+      end
+      print "> "
+      slice = gets.chop!.split(",")
+      if slice.length!=4 then
+	 raise("Slice must be 4 comma-split numerics")
+      end
+      slice.collect!{|e|    # "collect!" replaces elements
+	 if e =~ /^ *$/ then
+	    nil
+	 else
+	    e.to_f
+	 end
+      }
+
+      iax = [] 
+      start=[] ; last=[]
+      slice.each_index{|i|
+	 if slice[i] == nil then
+	    iax.push(i)
+	    start.push(0) ; last.push(-1)   # from the beginning to the end
+	 else
+	    idx = nearest_index( axvals[i], slice[i] )
+	    start.push( idx ) ; last.push( idx )
+	 end
+      }
+
+      if iax.length != 2 then
+	 raise("Specify a 2D slice")
+      else
+	 x = axvals[iax[0]]
+	 iax[0]==2 ? xr=[x.max, x.min] : xr=[x.min, x.max]
+	 xttl = axes[iax[0]].att("long_name").get
+	 xunits = axunits[iax[0]]
+	 y = axvals[iax[1]]
+	 iax[1]==2 ? yr=[y.max, y.min] : yr=[y.min, y.max]
+	 yttl = axes[iax[1]].att("long_name").get
+	 yunits = axunits[iax[1]]
+      end
+
+      ## / read the slice and plot /
+
+      v = var.get("start"=>start, "end"=>last)
+      shp=v.shape; shp.delete(1); v.reshape!(*shp)  # delete dims of length==1
+
+      #Fig.inclpoint(x, y)
+      DCL.grswnd( xr[0], xr[1], yr[0], yr[1] )
+      DCL.grsvpt(0.2,0.9,0.2,0.9)
+      DCL.grstrf
+      DCL.ussttl(xttl," ",yttl," ")
+      DCL.usdaxs
+      DCL.uwsgxa(x)
+      DCL.uwsgya(y)
+      DCL.uelset("ltone",true)
+      DCL.uetone(v)
+      DCL.udcntz(v)
+
+      first = false
+   rescue
+      print "*Error*  ", $!,"\n"     # show the error message in ($!)
+   end
+end
+
+DCL.grcls

data/demo/demo4-copy.rb

@@ -0,0 +1,32 @@
+=begin
+
+=demo4-copy.rb
+
+Make a copy of a NetCDF file
+
+==Usage
+
+% ruby demo4-copy.rb filename_from filename_to
+
+=end
+
+def usage
+"\n\nUSAGE:\n% ruby #{$0} filename_from filename_to\n"
+end
+
+require "numru/netcdf"
+include NumRu
+raise usage if ARGV.length != 2
+filename_from, filename_to = ARGV
+from = NetCDF.open(filename_from)
+to = NetCDF.create(filename_to)
+from.each_dim{|dim| to.def_dim( dim.name, dim.length_ul0 )}
+from.each_att{|att| to.put_att( att.name, att.get )}    ## global attributes
+from.each_var{|var|
+  newvar = to.def_var( var.name, var.ntype, var.dim_names )
+  var.each_att{|att| newvar.put_att( att.name, att.get )}
+}
+to.enddef
+from.each_var{|var| to.var(var.name).put(var.get)}
+to.close
+