Module: Cdo

Defined in:

lib/cdo_lib.rb

Overview

CDO calling mechnism

Constant Summary

VERSION =

"1.2.5"

State =

{
  :debug       => false,
  :returnCdf   => false,
  :operators   => [],
  :forceOutput => true,
  :env         => {},
  :log         => false,
  :logger      => Logger.new(@@file),
}

@@file =

StringIO.new

@@CDO =

@@undocumentedOperators =

Since cdo-1.5.4 undocumented operators are given with the -h option. For earlier version, they have to be provided manually

%w[anomaly beta boxavg change_e5lsm change_e5mask
change_e5slm chisquare chvar cloudlayer cmd com command complextorect
covar0 covar0r daycount daylogs del29feb delday delete deltap deltap_fl
delvar diffv divcoslat dumplogo dumplogs duplicate eca_r1mm enlargegrid
ensrkhistspace ensrkhisttime eof3d eof3dspatial eof3dtime export_e5ml
export_e5res fc2gp fc2sp fillmiss fisher fldcovar fldrms fourier fpressure
gather gengrid geopotheight ggstat ggstats globavg gp2fc gradsdes
gridverify harmonic hourcount hpressure import_e5ml import_e5res
import_obs imtocomplex infos infov interpolate intgrid intgridbil
intgridtraj intpoint isosurface lmavg lmean lmmean lmstd log lsmean
meandiff2test mergegrid mod moncount monlogs mrotuv mrotuvb mulcoslat ncode
ncopy nmltest normal nvar outputbounds outputboundscpt outputcenter
outputcenter2 outputcentercpt outputkey outputtri outputvector outputvrml
pardup parmul pinfo pinfov pressure_fl pressure_hl read_e5ml remapcon1
remapdis1 retocomplex scalllogo scatter seascount select selgridname
seloperator selvar selzaxisname setrcaname setvar showvar sinfov smemlogo
snamelogo sort sortcode sortlevel sortname sorttaxis sorttimestamp sortvar
sp2fc specinfo spectrum sperclogo splitvar stimelogo studentt template1
template2 test test2 testdata thinout timcount timcovar tinfo transxy trms
tstepcount vardes vardup varmul varquot2test varrms vertwind write_e5ml
writegrid writerandom yearcount]

@@outputOperatorsPattern =

/(diff|info|output|griddes|zaxisdes|show|ncode|ndate|nlevel|nmon|nvar|nyear|ntime|npar|gradsdes|pardes)/

Class Method Summary

• .boundaryLevels(args) ⇒ Object

  Addional operotors: ——————————————————————.

• .checkCdo ⇒ Object

  test if @@CDO can be used.

• .debug ⇒ Object
• .debug=(value) ⇒ Object
• .forceOutput ⇒ Object
• .forceOutput=(value) ⇒ Object
• .getCdo ⇒ Object
• .hasCdo?(bin = @@CDO) ⇒ Boolean
• .hasLib?(lib) ⇒ Boolean
• .help(operator = nil) ⇒ Object
• .libs ⇒ Object
• .libsVersion(lib) ⇒ Object
• .log ⇒ Object
• .log=(value) ⇒ Object
• .openCdf(iFile) ⇒ Object
• .operators ⇒ Object
• .readArray(iFile, varname) ⇒ Object
• .readCdf(iFile) ⇒ Object
• .readMaArray(iFile, varname) ⇒ Object
• .returnCdf ⇒ Object
• .setCdo(cdo) ⇒ Object
• .setReturnCdf(value = true) ⇒ Object
• .showlog ⇒ Object
• .thicknessOfLevels(args) ⇒ Object
• .unsetReturnCdf ⇒ Object
• .version ⇒ Object

Class Method Details

.boundaryLevels(args) ⇒ Object

Addional operotors:

---

# File 'lib/cdo_lib.rb', line 324

def Cdo.boundaryLevels(args)
  ilevels         = Cdo.showlevel(:input => args[:input])[0].split.map(&:to_f)
  bound_levels    = Array.new(ilevels.size+1)
  bound_levels[0] = 0
  (1..ilevels.size).each {|i| 
    bound_levels[i] =bound_levels[i-1] + 2*(ilevels[i-1]-bound_levels[i-1])
  }
  bound_levels
end

.checkCdo ⇒ Object

test if @@CDO can be used

# File 'lib/cdo_lib.rb', line 266

def Cdo.checkCdo
  unless hasCdo?(@@CDO)
    warn "Testing application #@@CDO is not available!"
    exit 1
  else
    puts "Using CDO: #@@CDO"
    puts IO.popen(@@CDO + " -V").readlines
  end
  return true
end

.debug ⇒ Object

# File 'lib/cdo_lib.rb', line 218

def Cdo.debug
  State[:debug]
end

.debug=(value) ⇒ Object

# File 'lib/cdo_lib.rb', line 215

def Cdo.debug=(value)
  State[:debug] = value
end

.forceOutput ⇒ Object

# File 'lib/cdo_lib.rb', line 224

def Cdo.forceOutput
  State[:forceOutput]
end

.forceOutput=(value) ⇒ Object

# File 'lib/cdo_lib.rb', line 221

def Cdo.forceOutput=(value)
  State[:forceOutput] = value
end

.getCdo ⇒ Object

# File 'lib/cdo_lib.rb', line 284

def Cdo.getCdo
  @@CDO
end

.hasCdo?(bin = @@CDO) ⇒ Boolean

# File 'lib/cdo_lib.rb', line 258

def Cdo.hasCdo?(bin=@@CDO)
  return true if File.exists?(@@CDO) and File.executable?(@@CDO)
  ENV['PATH'].split(File::PATH_SEPARATOR).each {|path| 
    return true if File.exists?([path,bin].join(File::SEPARATOR))
  }
end

.hasLib?(lib) ⇒ Boolean

# File 'lib/cdo_lib.rb', line 298

def Cdo.hasLib?(lib)
  return Cdo.libs.has_key?(lib)
  return false
end

.help(operator = nil) ⇒ Object

# File 'lib/cdo_lib.rb', line 374

def Cdo.help(operator=nil)
  if operator.nil?
    puts Cdo.call([@@CDO,'-h'].join(' '))[:stderr]
  else
    operator = operator.to_s unless String == operator.class
    if Cdo.operators.include?(operator)
      puts Cdo.call([@@CDO,'-h',operator].join(' '))[:stdout]
    else
      puts "Unknown operator #{operator}"
    end
  end
end

.libs ⇒ Object

# File 'lib/cdo_lib.rb', line 293

def Cdo.libs
  getSupportedLibs
  State[:libs]
end

.libsVersion(lib) ⇒ Object

# File 'lib/cdo_lib.rb', line 303

def Cdo.libsVersion(lib)
  unless Cdo.hasLib?(lib)
    raise ArgumentError, "Cdo does NOT have support for '#{lib}'"
  else
    if State[:libs][lib].kind_of? String
      return State[:libs][lib]
    else
      warn "No version information available about '#{lib}'"
      return false
    end
  end
end

.log ⇒ Object

# File 'lib/cdo_lib.rb', line 231

def Cdo.log
  State[:log]
end

.log=(value) ⇒ Object

# File 'lib/cdo_lib.rb', line 227

def Cdo.log=(value)
  State[:log] = value
end

.openCdf(iFile) ⇒ Object

# File 'lib/cdo_lib.rb', line 349

def Cdo.openCdf(iFile)
  Cdo.loadCdf unless State[:returnCdf] 
  NetCDF.open(iFile,'r+')
end

.operators ⇒ Object

# File 'lib/cdo_lib.rb', line 288

def Cdo.operators
  Cdo.getOperators if State[:operators].empty?
  State[:operators]
end

.readArray(iFile, varname) ⇒ Object

# File 'lib/cdo_lib.rb', line 354

def Cdo.readArray(iFile,varname)
  filehandle = Cdo.readCdf(iFile)
  if filehandle.var_names.include?(varname)
    # return the data array
    filehandle.var(varname).get
  else
    raise ArgumentError, "Cannot find variable '#{varname}'"
  end
end

.readCdf(iFile) ⇒ Object

# File 'lib/cdo_lib.rb', line 344

def Cdo.readCdf(iFile)
  Cdo.loadCdf unless State[:returnCdf] 
  NetCDF.open(iFile)
end

.readMaArray(iFile, varname) ⇒ Object

# File 'lib/cdo_lib.rb', line 364

def Cdo.readMaArray(iFile,varname)
  filehandle = Cdo.readCdf(iFile)
  if filehandle.var_names.include?(varname)
    # return the data array
    filehandle.var(varname).get_with_miss
  else
    raise ArgumentError,"Cannot find variable '#{varname}'"
  end
end

.returnCdf ⇒ Object

# File 'lib/cdo_lib.rb', line 254

def Cdo.returnCdf
  State[:returnCdf]
end

.setCdo(cdo) ⇒ Object

# File 'lib/cdo_lib.rb', line 277

def Cdo.setCdo(cdo)
  puts "Will use #{cdo} instead of #@@CDO" if Cdo.debug
  @@CDO = cdo
  Cdo.getOperators(true)
  Cdo.getSupportedLibs(true)
end

.setReturnCdf(value = true) ⇒ Object

# File 'lib/cdo_lib.rb', line 243

def Cdo.setReturnCdf(value=true)
  if value
    Cdo.loadCdf
  end
  State[:returnCdf] = value
end

.showlog ⇒ Object

# File 'lib/cdo_lib.rb', line 316

def Cdo.showlog
  @@file.rewind
  puts @@file.read
end

.thicknessOfLevels(args) ⇒ Object

# File 'lib/cdo_lib.rb', line 334

def Cdo.thicknessOfLevels(args)
  bound_levels = Cdo.boundaryLevels(args)
  delta_levels    = []
  bound_levels.each_with_index {|v,i| 
    next if 0 == i
    delta_levels << v - bound_levels[i-1]
  }
  delta_levels
end

.unsetReturnCdf ⇒ Object

# File 'lib/cdo_lib.rb', line 250

def Cdo.unsetReturnCdf
  setReturnCdf(false)
end

.version ⇒ Object

# File 'lib/cdo_lib.rb', line 235

def Cdo.version
  cmd     = @@CDO + ' 2>&1'
  help    = IO.popen(cmd).readlines.map {|l| l.chomp.lstrip}
  regexp  = %r{CDO version (\d.*), Copyright}
  line    = help.find {|v| v =~ regexp}
  version = regexp.match(line)[1]
end