GetGHCNDailyClimateDataForBoundingboxCentroid Namespace Reference

Query NCDC archive for climate data for a single station in the Global Historical Climatology Network (http://www1.ncdc.noaa.gov/pub/data/ghcn/daily/readme.txt). More...

Variables
tuple	parser = argparse.ArgumentParser(description='Query NCDC archive for climate data for a single station in the Global Historical Climatology Network')
string	help = 'The configuration file'
tuple	args = parser.parse_args()
tuple	cmdline = GenericMetadata.getCommandLine()
	configFile = None
tuple	context = Context(args.projectDir, configFile)
	outDir = args.outdir
tuple	outDirPath = os.path.join(context.projectDir, outDir)
tuple	studyArea = GenericMetadata.readStudyAreaEntries(context)
tuple	bbox = bboxFromString(studyArea['bbox_wgs84'])
tuple	nearest = findStationNearestToCoordinates(context.config, longitude, latitude)
tuple	outFile = os.path.join(outDir, nearest[0])
tuple	returnCode = getClimateDataForStation(context.config, context.projectDir, outFile, nearest[0])
tuple	station = ClimatePointStation()

Detailed Description

Query NCDC archive for climate data for a single station in the Global Historical Climatology Network (http://www1.ncdc.noaa.gov/pub/data/ghcn/daily/readme.txt).

Will find the nearest station to the centroid of the study area bounding box. Requires that the GHCN station database be setup using GHCNDSetup.py. Database must be stored in a location specified by a configuration file containing the section 'GHCND', and value 'PATH_OF_STATION_DB'.

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: 'GHCND', 'PATH_OF_STATION_DB'
2. 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 a ClimatePointStation entry to the climate point section of metadata associated with the project directory:
2. Will save climate data files to outdir

Usage:

GetGHCNDailyClimateDataForBoundingboxCentroid.py -p /path/to/project_dir

Note

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

Todo:

parse data files to determine start date, start time, and variables

Will find the nearest station to the centroid of the study area bounding box. Requires that the GHCN station database be setup using GHCNDSetup.py. Database must be stored in a location specified by a configuration file containing the section 'GHCND', and value 'PATH_OF_STATION_DB'.

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: 'GHCND', 'PATH_OF_STATION_DB'
2. 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 a ClimatePointStation entry to the climate point section of metadata associated with the project directory:
2. Will save climate data files to outdir

Usage:

GetGHCNDailyClimateDataForBoundingboxCentroid.py -p /path/to/project_dir

Note

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

Todo:

parse data files to determine start date, start time, and variables

Variable Documentation

tuple GetGHCNDailyClimateDataForBoundingboxCentroid.args = parser.parse_args()

tuple GetGHCNDailyClimateDataForBoundingboxCentroid.bbox = bboxFromString(studyArea['bbox_wgs84'])

tuple GetGHCNDailyClimateDataForBoundingboxCentroid.cmdline = GenericMetadata.getCommandLine()

GetGHCNDailyClimateDataForBoundingboxCentroid.configFile = None

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

string GetGHCNDailyClimateDataForBoundingboxCentroid.help = 'The configuration file'

tuple GetGHCNDailyClimateDataForBoundingboxCentroid.nearest = findStationNearestToCoordinates(context.config, longitude, latitude)

string GetGHCNDailyClimateDataForBoundingboxCentroid.outDir = args.outdir

tuple GetGHCNDailyClimateDataForBoundingboxCentroid.outDirPath = os.path.join(context.projectDir, outDir)

tuple GetGHCNDailyClimateDataForBoundingboxCentroid.outFile = os.path.join(outDir, nearest[0])

tuple GetGHCNDailyClimateDataForBoundingboxCentroid.parser = argparse.ArgumentParser(description='Query NCDC archive for climate data for a single station in the Global Historical Climatology Network')

tuple GetGHCNDailyClimateDataForBoundingboxCentroid.returnCode = getClimateDataForStation(context.config, context.projectDir, outFile, nearest[0])

tuple GetGHCNDailyClimateDataForBoundingboxCentroid.station = ClimatePointStation()

tuple GetGHCNDailyClimateDataForBoundingboxCentroid.studyArea = GenericMetadata.readStudyAreaEntries(context)