CreateFlowtable Namespace Reference

Create RHESSys flowtable. More...

Variables
tuple	parser = argparse.ArgumentParser(description='Create RHESSys flowtable using GRASS GIS data and createflowpaths 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	studyArea = RHESSysMetadata.readStudyAreaEntries(context)
tuple	grassMetadata = RHESSysMetadata.readGRASSEntries(context)
tuple	metadata = RHESSysMetadata.readRHESSysEntries(context)
tuple	demResX = float(studyArea['dem_res_x'])
tuple	demResY = float(studyArea['dem_res_y'])
list	demRast = grassMetadata['dem_rast']
list	rhessysDir = metadata['rhessys_dir']
tuple	paths = RHESSysPaths(args.projectDir, rhessysDir)
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)
tuple	result = grassLib.script.run_command('g.region', rast=demRast)
list	basinRast = grassMetadata['basin_rast']
tuple	cfPath = os.path.join(context.projectDir, metadata['cf_bin'])
tuple	templatePath = os.path.join(context.projectDir, metadata['template'])
tuple	flowTableNameBase = os.path.basename(metadata['worldfile_zero'])
tuple	flowOutpath = os.path.join(paths.RHESSYS_FLOW, flowTableNameBase)
tuple	cfOutpath = os.path.join(paths.RHESSYS_FLOW, 'cf.out')
	roads = None
	roofs = None
	impervious = None
string	surfaceFlowtable = "%s_surface.flow"
string	subsurfaceFlowtable = "%s_subsurface.flow"
tuple	p
tuple	cfOut = open(cfOutpath, 'w')
string	cfCmd = "%s out=%s template=%s dem=%s slope=%s stream=%s road=%s roof=%s impervious=%s cellsize=%s"

Detailed Description

Create RHESSys flowtable.

Command line driver program to create multiple RHESSys flowtables, one flowtable for each worldfile.

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. Configuration file must define the following sections and values: 'RHESSYS', 'PATH_OF_PARAMDB'
2. The following metadata entry(ies) must be present in the study area section of the metadata associated with the project directory: dem_res_x dem_res_y

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 cf_bin worldfile_zero template
2. The following metadata entry(ies) must be present in the GRASS section of the metadata associated with the project directory: dem_rast basin_rast slope_rast streams_rast zero_rast roads_rast [optional] roof_connectivity_rast [optional] impervious_rast [optional]
3. The following metadata entry(ies) will be used if present in the GRASS section of the metadata associated with the project directory: stream_burned_dem_rast

Post conditions

1. Flowtable will be created in the RHESSys folder of the project directory.
2. File named "cf.out" will be created in the flowtable folder of the RHESSys folder.
3. Will write the following entry(ies) to the RHESSys section of metadata associated with the project directory: surface_flowtable subsurface_flowtable flowtable_cmd

Usage:

CreateFlowtable.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) 2015, 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

Variable Documentation

tuple CreateFlowtable.args = parser.parse_args()

list CreateFlowtable.basinRast = grassMetadata['basin_rast']

string CreateFlowtable.cfCmd = "%s out=%s template=%s dem=%s slope=%s stream=%s road=%s roof=%s impervious=%s cellsize=%s"

tuple CreateFlowtable.cfOut = open(cfOutpath, 'w')

tuple CreateFlowtable.cfOutpath = os.path.join(paths.RHESSYS_FLOW, 'cf.out')

tuple CreateFlowtable.cfPath = os.path.join(context.projectDir, metadata['cf_bin'])

tuple CreateFlowtable.cmdline = RHESSysMetadata.getCommandLine()

CreateFlowtable.configFile = None

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

list CreateFlowtable.demRast = grassMetadata['dem_rast']

tuple CreateFlowtable.demResX = float(studyArea['dem_res_x'])

tuple CreateFlowtable.demResY = float(studyArea['dem_res_y'])

tuple CreateFlowtable.flowOutpath = os.path.join(paths.RHESSYS_FLOW, flowTableNameBase)

tuple CreateFlowtable.flowTableNameBase = os.path.basename(metadata['worldfile_zero'])

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

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

tuple CreateFlowtable.grassLib = GRASSLib(grassConfig=grassConfig)

tuple CreateFlowtable.grassMetadata = RHESSysMetadata.readGRASSEntries(context)

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

list CreateFlowtable.impervious = None

tuple CreateFlowtable.metadata = RHESSysMetadata.readRHESSysEntries(context)

tuple CreateFlowtable.p

Initial value:

= grassLib.script.pipe_command(cfPath, out=flowOutpath, template=templatePath,
                                 dem=demRast, 
                                 slope=grassMetadata['slope_rast'],
                                 stream=grassMetadata['streams_rast'],
                                 road=roads, roof=roofs, impervious=impervious,
                                 cellsize=demResX)

tuple CreateFlowtable.parser = argparse.ArgumentParser(description='Create RHESSys flowtable using GRASS GIS data and createflowpaths utility')

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

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

list CreateFlowtable.rhessysDir = metadata['rhessys_dir']

list CreateFlowtable.roads = None

list CreateFlowtable.roofs = None

tuple CreateFlowtable.studyArea = RHESSysMetadata.readStudyAreaEntries(context)

string CreateFlowtable.subsurfaceFlowtable = "%s_subsurface.flow"

string CreateFlowtable.surfaceFlowtable = "%s_surface.flow"

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