CreateWorldfile Namespace Reference

Create RHESSys worldfile. More...

Variables
tuple	parser = argparse.ArgumentParser(description='Create RHESSys worldfile using GRASS GIS data and grass2world utility')
string	help = 'The configuration file. Must define section "GRASS" and option "GISBASE"'
tuple	args = parser.parse_args()
tuple	cmdline = RHESSysMetadata.getCommandLine()
	configFile = None
tuple	context = Context(args.projectDir, configFile)
tuple	grassMetadata = RHESSysMetadata.readGRASSEntries(context)
tuple	metadata = RHESSysMetadata.readRHESSysEntries(context)
list	rhessysDir = metadata['rhessys_dir']
tuple	paths = RHESSysPaths(args.projectDir, rhessysDir)
tuple	modulePath = context.config.get('GRASS', 'MODULE_PATH')
tuple	grassDbase = os.path.join(context.projectDir, metadata['grass_dbase'])
tuple	grassConfig = GRASSConfig(context, grassDbase, metadata['grass_location'], metadata['grass_mapset'])
tuple	grassLib = GRASSLib(grassConfig=grassConfig)
list	demRast = grassMetadata['dem_rast']
	Run grass2world Make sure mask and region are properly set. More...
tuple	result = grassLib.script.run_command('g.region', rast=demRast)
list	basinRast = grassMetadata['basin_rast']
tuple	templateFilename = os.path.basename( metadata['template'] )
tuple	templateFilepath = os.path.join( context.projectDir, metadata['template'] )
string	worldfileName = "%s_init"
tuple	worldfilePath = os.path.join(paths.RHESSYS_WORLD, worldfileName)
tuple	g2wPath = os.path.join(context.projectDir, metadata['g2w_bin'])
string	g2wCommand = "%s -t %s -w %s"
tuple	g2wEnv = dict(os.environ)
tuple	cmdArgs = g2wCommand.split()
tuple	process

Detailed Description

Create RHESSys worldfile.

Generate world template to be used to create an initial worldfile for a RHESSys model.

This will create an initial worldfile used for input into the lairead utility, which initializes vegetation carbon stores.

This software is provided free of charge under the New BSD License. Please see the following license information:

Copyright (c) 2013, University of North Carolina at Chapel Hill 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.
• Neither the name of the University of North Carolina at Chapel Hill nor the names of its contributors may 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 UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL 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.

Author

Brian Miles brian.nosp@m._mil.nosp@m.es@un.nosp@m.c.ed.nosp@m.u

Pre conditions

1. The following metadata entry(ies) must be present in the RHESSys section of the metadata associated with the project directory: grass_dbase grass_location grass_mapset rhessys_dir g2w_bin rat_bin template

Post conditions

1. Worldfile will be created in the RHESSys folder of the project directory.
2. Will write the following entry(ies) to the RHESSys section of metadata associated with the project directory: worldfile_zero

Usage:

CreateWorldfile.py -p /path/to/project_dir

Note

EcoHydroWorkflowLib configuration file must be specified by environmental variable 'ECOHYDROWORKFLOW_CFG', or -i option must be specified.

This software is provided free of charge under the New BSD License. Please see the following license information:

Copyright (c) 2013, University of North Carolina at Chapel Hill 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.
• Neither the name of the University of North Carolina at Chapel Hill nor the names of its contributors may 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 UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL 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.

Author

Brian Miles brian.nosp@m._mil.nosp@m.es@un.nosp@m.c.ed.nosp@m.u

Pre conditions

1. The following metadata entry(ies) must be present in the study area section of the metadata associated with the project directory: bbox_wgs84
2. The following metadata entry(ies) must be present in the RHESSys section of the metadata associated with the project directory: stratum_defs landuse_defs soil_defs paramdb paramdb_dir rhessys_dir climate_stations template_template
3. The following metadata entry(ies) must be present in the GRASS section of the metadata associated with the project directory: basin_rast dem_rast hillslope_rast slope_rast aspect_rast zero_rast east_horizon_rast west_horizon_rast patch_rast soil_rast landuse_rast impervious_rast wetness_index_rast stratum_rast xmap_rast ymap_rast
4. The following metadata entry(ies) will be used if present in the GRASS section of the metadata associated with the project directory: isohyet_rast basestation_rast

Post conditions

1. Template will be created in the RHESSys folder of the project directory.
2. Will write the following entry(ies) to the RHESSys section of metadata associated with the project directory: template

Usage:

GenerateWorldTemplate.py -p /path/to/project_dir -c climate_station_name1 ... climate_station_nameN

Note

EcoHydroWorkflowLib configuration file must be specified by environmental variable 'ECOHYDROWORKFLOW_CFG', or -i option must be specified.

Variable Documentation

tuple CreateWorldfile.args = parser.parse_args()

list CreateWorldfile.basinRast = grassMetadata['basin_rast']

tuple CreateWorldfile.cmdArgs = g2wCommand.split()

tuple CreateWorldfile.cmdline = RHESSysMetadata.getCommandLine()

CreateWorldfile.configFile = None

tuple CreateWorldfile.context = Context(args.projectDir, configFile)

list CreateWorldfile.demRast = grassMetadata['dem_rast']

Run grass2world Make sure mask and region are properly set.

string CreateWorldfile.g2wCommand = "%s -t %s -w %s"

tuple CreateWorldfile.g2wEnv = dict(os.environ)

tuple CreateWorldfile.g2wPath = os.path.join(context.projectDir, metadata['g2w_bin'])

tuple CreateWorldfile.grassConfig = GRASSConfig(context, grassDbase, metadata['grass_location'], metadata['grass_mapset'])

tuple CreateWorldfile.grassDbase = os.path.join(context.projectDir, metadata['grass_dbase'])

tuple CreateWorldfile.grassLib = GRASSLib(grassConfig=grassConfig)

tuple CreateWorldfile.grassMetadata = RHESSysMetadata.readGRASSEntries(context)

string CreateWorldfile.help = 'The configuration file. Must define section "GRASS" and option "GISBASE"'

tuple CreateWorldfile.metadata = RHESSysMetadata.readRHESSysEntries(context)

tuple CreateWorldfile.modulePath = context.config.get('GRASS', 'MODULE_PATH')

tuple CreateWorldfile.parser = argparse.ArgumentParser(description='Create RHESSys worldfile using GRASS GIS data and grass2world utility')

tuple CreateWorldfile.paths = RHESSysPaths(args.projectDir, rhessysDir)

tuple CreateWorldfile.process

Initial value:

= Popen(cmdArgs, cwd=paths.RHESSYS_BIN, env=g2wEnv, 
                stdout=PIPE, stderr=PIPE)

tuple CreateWorldfile.result = grassLib.script.run_command('g.region', rast=demRast)

list CreateWorldfile.rhessysDir = metadata['rhessys_dir']

tuple CreateWorldfile.templateFilename = os.path.basename( metadata['template'] )

tuple CreateWorldfile.templateFilepath = os.path.join( context.projectDir, metadata['template'] )

string CreateWorldfile.worldfileName = "%s_init"

tuple CreateWorldfile.worldfilePath = os.path.join(paths.RHESSYS_WORLD, worldfileName)