HWRF  trunk@4391
Public Member Functions | Public Attributes | List of all members
pom.init.Oceanini Class Reference

Parent class of POM initialization classes. More...

Detailed Description

Parent class of POM initialization classes.

Definition at line 96 of file init.py.

Inheritance diagram for pom.init.Oceanini:
pom.init.Hwrf pom.init.fbtr pom.init.g3 pom.init.na pom.init.phase

Public Member Functions

def __init__ (self, ODIR, DOMAIN, ODATA, SSTASIM, STORMNAME, STORMID, STARTDATE, EXEChwrf, PARMhwrf, FIXhwrf, LCDIR, GFSDIR, CSTREAM, COMIN, sync_frequently=False, kwargs)
 Oceanini constructor. More...
 
def setpath
 Creates the ocean run path, whose subdirectory is SUBDIR. More...
 
- Public Member Functions inherited from pom.init.Hwrf
def __init__
 Hwrf constructor. More...
 

Public Attributes

 ODIR
 Ocean output directory in CSTREAM.
 
 DOMAIN
 Ocean domain. More...
 
 ODATA
 Type of ocean data. More...
 
 SSTASIM
 SST ASIM flag, True or False.
 
 conf
 A ConfigParser-like object to use for configuration information. More...
 
- Public Attributes inherited from pom.init.Hwrf
 STORMNAME
 Upper-case storm name for filenames (KATRINA)
 
 STORMID
 Three character storm number and basin, upper-case (12L)
 
 STARTDATE
 Simulation analysis time as a string, YYYYMMDDHH (2005082918)
 
 EXEChwrf
 Directory with HWRF executables. More...
 
 PARMhwrf
 Directory with HWRF parameter files. More...
 
 LCDIR
 Directory with loop current files.
 
 GFSDIR
 Directory with input files from GFS. More...
 
 FIXhwrf
 Directory with HWRF fixed files. More...
 
 CSTREAM
 Directory to place files for the POM forecast to read. More...
 
 COMIN
 HWRF final output directory. More...
 
 sync_frequently
 

Constructor & Destructor Documentation

def pom.init.Oceanini.__init__ (   self,
  ODIR,
  DOMAIN,
  ODATA,
  SSTASIM,
  STORMNAME,
  STORMID,
  STARTDATE,
  EXEChwrf,
  PARMhwrf,
  FIXhwrf,
  LCDIR,
  GFSDIR,
  CSTREAM,
  COMIN,
  sync_frequently = False,
  kwargs 
)

Oceanini constructor.

Parameters
ODIROcean output directory in CSTREAM
SSTASIMSST ASIM flag, True or False
DOMAINOcean domain.
ODATAType of ocean data.
STORMNAMEUpper-case storm name for filenames (KATRINA)
STORMIDThree character storm number and basin, upper-case (12L)
STARTDATESimulation analysis time as a string, YYYYMMDDHH (2005082918)
EXEChwrfDirectory with HWRF executables.
PARMhwrfDirectory with HWRF parameter files.
FIXhwrfDirectory with HWRF fixed files.
LCDIRDirectory with loop current files
GFSDIRDirectory with input files from GFS.
CSTREAMDirectory to place files for the POM forecast to read.
COMINHWRF final output directory.
sync_frequentlyif True, run "sync" frequently
kwargsCan optionally contain conf, which should point to a ConfigParser-like object to use for configuration information. An hwrf.config.HWRFConfig is acceptable for this.

Definition at line 100 of file init.py.

Member Function Documentation

def pom.init.Oceanini.setpath (   self,
  SUBDIR = "" 
)

Creates the ocean run path, whose subdirectory is SUBDIR.

Parameters
SUBDIRthe subdirectory to create
Returns
a tuple (rundir,finaldir) where rundir is CSTREAM+'/'+ODIR and finaldir is the SUBDIR subdirectory of that

Definition at line 147 of file init.py.

Member Data Documentation

pom.init.Oceanini.conf

A ConfigParser-like object to use for configuration information.

This may be a hwrf.config.HWRFConfig object.

Definition at line 129 of file init.py.

Referenced by scripts.exhwrf_output.Deliverer.deliver_file().

pom.init.Oceanini.DOMAIN

Ocean domain.

Definition at line 126 of file init.py.

Referenced by pom.init.g3.getinp(), pom.init.na.getinp(), and pom.init.fbtr.setrun().

pom.init.Oceanini.ODATA

The documentation for this class was generated from the following file: