RegisterGage Namespace Reference

Register streamflow gage coordinates from a point shapefile into metadata store for a project directory, copying the shapefile into the project directory in the process. More...

Variables
tuple	parser argparse.ArgumentParser(description='Register streamflow gage shapefile with project')
string	help 'The configuration file'
tuple	args parser.parse_args()
tuple	cmdline GenericMetadata.getCommandLine()
	configFile None
tuple	config ConfigParser.RawConfigParser()
	projectDir args.projectDir
tuple	inGagePath os.path.abspath(args.gageFile)
	publisher args.publisher
	outfile args.outfile
tuple	studyArea GenericMetadata.readStudyAreaEntries(projectDir)
list	bbox studyArea['bbox_wgs84']
string	outFilename "%s%sshp"
tuple	outFilepath os.path.join(projectDir, outFilename)
list	gageIDs [args.idValue]
tuple	coords
list	gage_lon coords[0]
list	gage_lat coords[0]
tuple	coordinates (gage_lon, gage_lat)
tuple	shpFilename writeCoordinatePairsToPointShapefile(projectDir, outfile, "gage_id", gageIDs, [coordinates])
tuple	asset AssetProvenance(GenericMetadata.MANIFEST_SECTION)

Detailed Description

Register streamflow gage coordinates from a point shapefile into metadata store for a project directory, copying the shapefile into the project directory in the process.

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

Post conditions

1. Will write the following entry(ies) to the manifest section of metadata associated with the project directory: gage [the name of the streamflow gage shapefile]

1. Will write the following entry(ies) to the study area section of metadata associated with the project directory: gage_id_attr [the name of the attribute in the gage shapefile that uniquely identifies a streamflow gage] gage_id [the unique ID of the gage in the shapefile]

Usage:

python ./RegisterGage.py -p /path/to/project_dir -g /path/to/gage/shapefile -l layername -a id_attribute -d id_value

Note

If option -t is not specified, UTM projection (WGS 84 coordinate system) will be inferred from bounding box center.

Todo:

Set date in provenance to file modification date

Variable Documentation

tuple RegisterGage.args parser.parse_args()

tuple RegisterGage.asset AssetProvenance(GenericMetadata.MANIFEST_SECTION)

tuple RegisterGage.bbox studyArea['bbox_wgs84']

tuple RegisterGage.cmdline GenericMetadata.getCommandLine()

tuple RegisterGage.config ConfigParser.RawConfigParser()

list RegisterGage.configFile None

tuple RegisterGage.coordinates (gage_lon, gage_lat)

tuple RegisterGage.coords

Initial value:

getCoordinatesOfPointsFromShapefile(inGagePath, args.layerName,
                                             args.idAttribute, gageIDs)

list RegisterGage.gage_lat coords[0]

list RegisterGage.gage_lon coords[0]

list RegisterGage.gageIDs [args.idValue]

string RegisterGage.help 'The configuration file'

tuple RegisterGage.inGagePath os.path.abspath(args.gageFile)

string RegisterGage.outfile args.outfile

string RegisterGage.outFilename "%s%sshp"

tuple RegisterGage.outFilepath os.path.join(projectDir, outFilename)

tuple RegisterGage.parser argparse.ArgumentParser(description='Register streamflow gage shapefile with project')

tuple RegisterGage.projectDir args.projectDir

string RegisterGage.publisher args.publisher

tuple RegisterGage.shpFilename writeCoordinatePairsToPointShapefile(projectDir, outfile, "gage_id", gageIDs, [coordinates])

tuple RegisterGage.studyArea GenericMetadata.readStudyAreaEntries(projectDir)