Add license and docs

diff --git a/LICENSE b/LICENSE
new file mode 100644 (file)
index 0000000..af4c2a4
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Ethan Nelson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..dd396a7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+Pyxrad
+======
+
+This repository contains scripts useful for querying and obtaining data from the Amazon Web Services NEXRAD archive.
+
+The `example()` script contains an example sequence to use all of the functions. 
+
+Functions
+---------
+
+### `get_filenames(year, month, day, hour, location)`
+
+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')`.
+
+The output is the returned XML body from the AWS query.
+
+### `parse_xml(content)`
+
+This function takes the returned XML from `get_filenames` and extracts all of the file names.
+
+The output is a list of full file names on AWS for the given date, hour, and location.
+
+### `get_files(filelist, save_path='')`
+
+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.
+
+The output is a list of files saved with their local paths.