cdp 0.0.2 → 0.0.4

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2009-2012, Ralf Mueller (stark.dreamdetective@googlemail.com)
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+
+    * The names of its contributors may not be used to endorse or promote
+      products derived from this software without specific prior written
+      permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.textile

@@ -0,0 +1,23 @@
+h2. Climate Data Processing
+ 
+The developement target of Cdp is a collection of Ruby methods for easy Climate data file processing.
+
+h2. installation
+
+<pre>gem install cdp</pre> or
+<pre>gem install cdp --user-install</pre> for non-system-wide installation
+
+h2. changelog
+
+At this early stage, please look at the commits. The release number are only used for charing the gems.
+
+|0.0.x |                               |
+|      ||
+
+h2. license
+
+cdp uses BSD license, see file: LICENSE
+
+h2. contact
+
+stark.dreamdetective@gmail.com or via github

data/gemspec

@@ -3,7 +3,7 @@ $:.unshift File.join(File.dirname(__FILE__),"..","lib")
 
 spec = Gem::Specification.new do |s|
   s.name              = "cdp"
-  s.version           = '0.0.2'
+  s.version           = '0.0.4'
   s.platform          = Gem::Platform::RUBY
   s.files             = ["lib/cdp.rb"] + ["gemspec"]
   s.test_file         = "test/test_cdp.rb"
@@ -11,8 +11,8 @@ spec = Gem::Specification.new do |s|
   s.summary           = "---"
   s.author            = "Ralf Mueller"
   s.email             = "stark.dreamdetective@gmail.com"
-#  s.homepage          = "https://code.zmaw.de/projects/cdo/wiki/Cdo%7Brbpy%7D"
-#  s.extra_rdoc_files  = ["README.rdoc","COPYING"]
+  s.homepage          = "https://github.com/Try2Code/cdp"
+  s.extra_rdoc_files  = ["README.textile","LICENSE"]
   s.license           = "BSD"
   s.has_rdoc          = false
   s.required_ruby_version = ">= 1.9"

data/lib/cdp.rb

@@ -2,9 +2,11 @@ require 'cdo'
 require 'socket'
 module Cdp
 
+  @@debug = false
+
+
+  # setup of CDO on different machines based on the hostname
   def Cdp.setCDO
-    #=============================================================================== 
-    # setup of CDO on different machines
     hostname = Socket.gethostname
     case hostname
     when /thingol/
@@ -18,12 +20,15 @@ module Cdp
     end
   end
 
-  def Cdp.setDEBUG
+  def Cdp.setDebug(value=true)
     Cdo.checkCdo
     Cdo.debug = true unless ENV['DEBUG'].nil?
+    @@debug   = value
+  end
+  def Cdp.debug
+    @@debug
   end
 
-  #=============================================================================== 
   # compute the experiments from the data directories and link the corresponding files
   def Cdp.splitFilesIntoExperiments(files)
     gridFile = files.pop
@@ -53,21 +58,42 @@ module Cdp
     [gridFile,experimentFiles,experimentAnalyzedData]
   end
 
-  def Cdp.manualAreaWeights(areaVarname,areaFile,ofile=nil)
+  # compute area weights from an area variable
+  def Cdp.areaWeights(areaVarname,areaFile,ofile=nil,force=false)
     area    = Cdo.selname(areaVarname,:in => areaFile)
     areaSum = Cdo.enlarge(area,:in => "-fldsum #{area}")
     if ofile.nil?
       weights = Cdo.setname("area_weight",:in => " -div #{area} #{areaSum}")
     else
-                Cdo.setname("area_weight",:in => " -div #{area} #{areaSum}", :out => ofile)
+      unless force
+        unless File.exist?(ofile)
+          Cdo.setname("area_weight",:in => " -div #{area} #{areaSum}", :out => ofile)
+        else
+          puts "Resuse existing file #{ofile}" if @@debug
+          return ofile
+        end
+      else
+        Cdo.setname("area_weight",:in => " -div #{area} #{areaSum}", :out => ofile)
+      end
     end
   end
-  def Cdp.manualMaskedAreaWeights(areaVarname,areaFile,maskVarname,maskFile,ofile=nil)
+
+  # compute area weights from an area variable with a mask from another file
+  def Cdp.maskedAreaWeights(areaVarname,areaFile,maskVarname,maskFile,ofile=nil,force=false)
     maskedArea    = Cdo.div(:in    => " -selname,#{areaVarname} #{areaFile} -selname,#{maskVarname} #{maskFile}")
     if ofile.nil?
       maskedAreaSum = Cdo.setname("area_weight", :in => " -div  #{maskedArea}  -enlarge,#{maskedArea} -fldsum #{maskedArea}")
     else
-                      Cdo.setname("area_weight", :in => " -div  #{maskedArea}  -enlarge,#{maskedArea} -fldsum #{maskedArea}", :out => ofile)
+      unless force
+        unless File.exist?(ofile)
+          Cdo.setname("area_weight", :in => " -div  #{maskedArea}  -enlarge,#{maskedArea} -fldsum #{maskedArea}", :out => ofile)
+        else
+          puts "Resuse existing file #{ofile}" if @@debug
+          return ofile
+        end
+      else
+        Cdo.setname("area_weight", :in => " -div  #{maskedArea}  -enlarge,#{maskedArea} -fldsum #{maskedArea}", :out => ofile)
+      end
     end
   end
 end

data/test/test_cdp.rb

@@ -6,17 +6,42 @@ require 'pp'
 DATADIR  = ENV['HOME'] + "/data/icon"
 ICONGRID = DATADIR     + "/icon-R2B04-grid-etopo.nc"
 ICONMASK = DATADIR     + "/mask.nc"
+WEIGHTS  = File.dirname(__FILE__) + "/weights.nc"
 
 class TestCdp < Test::Unit::TestCase
+  def teardown
+    FileUtils.rm(WEIGHTS) if File.exist?(WEIGHTS)
+  end
+  def test_set_debug
+    Cdp.setDebug
+    assert_equal(Cdp::debug,true)
+    Cdp.setDebug(false)
+    assert_equal(Cdp::debug,false)
+  end
   def test_area_weight
-    Cdo.debug = true
-    weights = Cdp.manualAreaWeights("cell_area",ICONGRID)
+    Cdp.setDebug
+    weights = Cdp.areaWeights("cell_area",ICONGRID)
+    # global sum over all weights should be 1
     assert_equal("1",Cdo.outputkey("value", :in => Cdo.fldsum(:in => weights)).first)
+    weights = Cdp.areaWeights("cell_area",ICONGRID,weights)
+    weights = Cdp.areaWeights("cell_area",ICONGRID,WEIGHTS)
+    assert_equal(WEIGHTS,weights)
+    weights = Cdp.areaWeights("cell_area",ICONGRID,WEIGHTS)
+    assert_equal(WEIGHTS,weights)
   end
   def test_masked_area_weight
-    Cdo.debug = true
+    Cdo.debug = false
     Cdp.setCDO
-    weights = Cdp.manualMaskedAreaWeights("cell_area",ICONGRID,"wet_c",ICONMASK)
+    Cdp.setDebug
+    weights = Cdp.maskedAreaWeights("cell_area",ICONGRID,"wet_c",ICONMASK)
+    # global sum over all weights should be 1
     assert_equal("1",Cdo.outputkey("value", :in => Cdo.fldsum(:in => weights)).uniq.first)
+
+    weights = Cdp.maskedAreaWeights("cell_area",ICONGRID,"wet_c",ICONMASK,WEIGHTS)
+    assert_equal(WEIGHTS,weights)
+    weights = Cdp.maskedAreaWeights("cell_area",ICONGRID,"wet_c",ICONMASK,WEIGHTS)
+    assert_equal(WEIGHTS,weights)
+    weights = Cdp.maskedAreaWeights("cell_area",ICONGRID,"wet_c",ICONMASK,WEIGHTS,true)
+    assert_equal(WEIGHTS,weights)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cdp
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-29 00:00:00.000000000 Z
+date: 2012-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cdo
@@ -31,12 +31,16 @@ description: Climate Data Processing helpers
 email: stark.dreamdetective@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.textile
+- LICENSE
 files:
 - lib/cdp.rb
 - gemspec
+- README.textile
+- LICENSE
 - test/test_cdp.rb
-homepage: 
+homepage: https://github.com/Try2Code/cdp
 licenses:
 - BSD
 post_install_message: