RHESSysWorkflows  1.33
Classes | Functions | Variables
rhessysworkflows.worldfileio Namespace Reference

Classes

class  WorldfileParseError
 

Functions

def getClimateBaseStationFilenames
 Read climate base station paths from the header of a worldfile. More...
 

Variables

tuple NUM_BASE_STATION_RE = re.compile('^(\d+)\s+num_base_stations$')
 
tuple BASE_STATION_RE = re.compile('^(\S+)\s+base_station_filename$')
 
tuple WORLD_RE = re.compile('^(\d+)\s+world_ID$')
 

Function Documentation

def rhessysworkflows.worldfileio.getClimateBaseStationFilenames (   worldfileHeader,
  strict = True 
)

Read climate base station paths from the header of a worldfile.

Parameters
worldfileHeaderString representing path of worldfile header from which to read climate base stations
strictTrue if strict parsing should be used
Returns
list representing climate base stations paths found in the worldfile header

IOError if unable to read worldfile header WorldfileParseError if there appears to be an error in the worldfile header structure

Variable Documentation

tuple rhessysworkflows.worldfileio.BASE_STATION_RE = re.compile('^(\S+)\s+base_station_filename$')
tuple rhessysworkflows.worldfileio.NUM_BASE_STATION_RE = re.compile('^(\d+)\s+num_base_stations$')
tuple rhessysworkflows.worldfileio.WORLD_RE = re.compile('^(\d+)\s+world_ID$')