rhessysworkflows.rhessys.RHESSysPaths Class Reference

Inheritance diagram for rhessysworkflows.rhessys.RHESSysPaths:

Public Member Functions
def	relpath (self, path)
	Return the portion of path relative to self.basedir. More...
def	getReclassRulesDirectory (self)
	Get path to directory, within the project directory, for storing raster reclass rules in. More...
def	__init__
	Verify that RHESSys directory structure is present, creating directories as needed. More...
def	relpath (self, path)
	Return the portion of path relative to self.basedir. More...
def	getReclassRulesDirectory (self)
	Get path to directory, within the project directory, for storing raster reclass rules in. More...
def	__init__
	Verify that RHESSys directory structure is present, creating directories as needed. More...

Public Attributes
	basedir
	rhessysDir
	RHESSYS_DIR
	DB_DIR
	RHESSYS_SRC
	RHESSYS_TEMPLATES
	RHESSYS_BIN
	RHESSYS_WORLD
	RHESSYS_WORLD_ACTIVE
	RHESSYS_FLOW
	RHESSYS_TEC
	RHESSYS_TEC_ACTIVE
	RHESSYS_DEF
	RHESSYS_CLIM
	RHESSYS_OUT
	RHESSYS_OBS

Constructor & Destructor Documentation

def rhessysworkflows.rhessys.RHESSysPaths.__init__	(		self,
			basedir,
			rhessysDir = _DIR
	)

Verify that RHESSys directory structure is present, creating directories as needed.

Parameters

basedir	String representing the path to the directory in which RHESSys directories will be created
rhessysDir	String representing root directory into which RHESSys directories will be created

IOError is self.basedir is not writeable. OSError if any directory creation fails.

def rhessysworkflows.rhessys.RHESSysPaths.__init__	(		self,
			basedir,
			rhessysDir = _DIR
	)

Verify that RHESSys directory structure is present, creating directories as needed.

Parameters

basedir	String representing the path to the directory in which RHESSys directories will be created
rhessysDir	String representing root directory into which RHESSys directories will be created

IOError is self.basedir is not writeable. OSError if any directory creation fails.

Member Function Documentation

def rhessysworkflows.rhessys.RHESSysPaths.getReclassRulesDirectory

(

self

)

Get path to directory, within the project directory, for storing raster reclass rules in.

If the directory does not exist it will be created.

Returns

String representing the path of the rules directory

def rhessysworkflows.rhessys.RHESSysPaths.getReclassRulesDirectory

(

self

)

Get path to directory, within the project directory, for storing raster reclass rules in.

If the directory does not exist it will be created.

Returns

String representing the path of the rules directory

def rhessysworkflows.rhessys.RHESSysPaths.relpath	(		self,
			path
	)

Return the portion of path relative to self.basedir.

Parameters

path	String representing a path within self.basedir

Returns

The relative path, or None if path was not rooted at self.basedir

def rhessysworkflows.rhessys.RHESSysPaths.relpath	(		self,
			path
	)

Return the portion of path relative to self.basedir.

Parameters

path	String representing a path within self.basedir

Returns

The relative path, or None if path was not rooted at self.basedir

Member Data Documentation

rhessysworkflows.rhessys.RHESSysPaths.basedir

rhessysworkflows.rhessys.RHESSysPaths.DB_DIR

rhessysworkflows.rhessys.RHESSysPaths.RHESSYS_BIN

rhessysworkflows.rhessys.RHESSysPaths.RHESSYS_CLIM

rhessysworkflows.rhessys.RHESSysPaths.RHESSYS_DEF

rhessysworkflows.rhessys.RHESSysPaths.RHESSYS_DIR

rhessysworkflows.rhessys.RHESSysPaths.RHESSYS_FLOW

rhessysworkflows.rhessys.RHESSysPaths.RHESSYS_OBS

rhessysworkflows.rhessys.RHESSysPaths.RHESSYS_OUT

rhessysworkflows.rhessys.RHESSysPaths.RHESSYS_SRC

rhessysworkflows.rhessys.RHESSysPaths.RHESSYS_TEC

rhessysworkflows.rhessys.RHESSysPaths.RHESSYS_TEC_ACTIVE

rhessysworkflows.rhessys.RHESSysPaths.RHESSYS_TEMPLATES

rhessysworkflows.rhessys.RHESSysPaths.RHESSYS_WORLD

rhessysworkflows.rhessys.RHESSysPaths.RHESSYS_WORLD_ACTIVE

rhessysworkflows.rhessys.RHESSysPaths.rhessysDir

---

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

• build/lib/rhessysworkflows/rhessys.py