Add license and docs
[pyxrad/.git] / README.md
1 Pyxrad
2 ======
3
4 This repository contains scripts useful for querying and obtaining data from the Amazon Web Services NEXRAD archive.
5
6 The `example()` script contains an example sequence to use all of the functions. 
7
8 Functions
9 ---------
10
11 ### `get_filenames(year, month, day, hour, location)`
12
13 This function queries AWS for NEXRAD data on a given hour and date for a certain NEXRAD location identifier (starts with a K). Note that each input must be a string and zero-padded where appropriate. For example, 02 UTC on March 1st, 2012 for KMAF would be called as `get_filenames('2012','03','01','02','KMAF')`.
14
15 The output is the returned XML body from the AWS query.
16
17 ### `parse_xml(content)`
18
19 This function takes the returned XML from `get_filenames` and extracts all of the file names.
20
21 The output is a list of full file names on AWS for the given date, hour, and location.
22
23 ### `get_files(filelist, save_path='')`
24
25 This function downloads files supplied in a `filelist` list. An optional `save_path` will specify the path where files should be saved; by default, files will be downloaded into the current working directory.
26
27 The output is a list of files saved with their local paths.