ecohydrolib.climatedata.ghcndquery Namespace Reference

Query NCDC Global Historical Climatology Network dataset for daily climate data. More...

Functions
def	findStationsWithinBoundingBox (config, bbox)
	Find stations that lie within a bounding box. More...
def	findStationNearestToCoordinates (config, longitude, latitude)
	Determine identifier of station nearest to longitude, latitude coordinates. More...
def	getClimateDataForStation
	Fetch climate timeseries data for a GHCN daily station. More...

Variables
string	HOST = 'www1.ncdc.noaa.gov'
string	URL_PROTO = '/pub/data/ghcn/daily/all/{station_id}.dly'
tuple	_SRS = int(4326)
int	_BUFF_LEN = 4096

Detailed Description

Query NCDC Global Historical Climatology Network dataset for daily climate data.

Note

Requires pyspatialite 3.0.1

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

Function Documentation

def ecohydrolib.climatedata.ghcndquery.findStationNearestToCoordinates	(		config,
			longitude,
			latitude
	)

Determine identifier of station nearest to longitude, latitude coordinates.

Parameters

config	ConfigParser containing the section 'GHCND' and option 'PATH_OF_STATION_DB'
longitude	Float representing WGS84 longitude
latitude	Float representing WGS84 latitude

Returns

Tuple of the form (station_id, longitude, latitude, elevation_meters, name, distance), None if no gage is found.

from ecohydrolib.climatedata.ghcndquery import findStationNearestToCoordinates
import ConfigParser
config = ConfigParser.RawConfigParser()
config.read('./bin/macosx2.cfg')
lon = -76.7443397486
lat = 39.2955590994
nearest = findStationNearestToCoordinates(config, lon, lat)
from ecohydrolib.climatedata.ghcndquery import getClimateDataForStation
outputDir = '/tmp'
outfileName = 'clim.txt'
getClimateDataForStation(config, outputDir, outfileName, nearest[0])

def ecohydrolib.climatedata.ghcndquery.findStationsWithinBoundingBox	(		config,
			bbox
	)

Find stations that lie within a bounding box.

Parameters

config	ConfigParser containing the section 'GHCND' and option 'PATH_OF_STATION_DB'
bbox	A dict containing keys: minX, minY, maxX, maxY, srs, where srs='EPSG:4326'

Returns

A list of GHCN station attributes for each station within the bounding box: [id, lat, lon, elevation, name]

import os
import ConfigParser
from ecohydrolib.metadata import GenericMetadata
from ecohydrolib.climatedata.ghcndquery import findStationsWithinBoundingBox
studyArea = GenericMetadata.readStudyAreaEntries(projectDir)
bbox = studyArea['bbox_wgs84'].split()
bbox = dict({'minX': float(bbox[0]), 'minY': float(bbox[1]), 'maxX': float(bbox[2]), 'maxY': float(bbox[3]), 'srs': 'EPSG:4326'})
    
configFile = os.environ['ECOHYDROWORKFLOW_CFG']
config = ConfigParser.RawConfigParser()
config.read(configFile)

stations = findStationsWithinBoundingBox(config,bbox)

def ecohydrolib.climatedata.ghcndquery.getClimateDataForStation	(		config,
			outputDir,
			outFilename,
			stationID,
			overwrite = True
	)

Fetch climate timeseries data for a GHCN daily station.

Parameters

config	A Python ConfigParser (not currently used)
outputDir	String representing the absolute/relative path of the directory into which output DEM should be written
outDEMFilename	String representing the name of the DEM file to be written
stationID	String representing unique identifier of station
overwrite	Boolean value indicating whether or not the file indicated by filename should be overwritten. If False and filename exists, IOError exception will be thrown with errno.EEXIST
overwrite	Boolean value indicating whether or not the file indicated by filename should be overwritten. If False and filename exists, IOError exception will be thrown with errno.EEXIST

IOError if outputDir is not a writable directory IOError if outFilename already exists and overwrite is False (see above)

Returns

True if timeseries data were fetched and False if not

Variable Documentation

int ecohydrolib.climatedata.ghcndquery._BUFF_LEN = 4096

tuple ecohydrolib.climatedata.ghcndquery._SRS = int(4326)

string ecohydrolib.climatedata.ghcndquery.HOST = 'www1.ncdc.noaa.gov'

string ecohydrolib.climatedata.ghcndquery.URL_PROTO = '/pub/data/ghcn/daily/all/{station_id}.dly'