From 2dc516a417ef885219e0a354b03cfe95d1c7fbe4 Mon Sep 17 00:00:00 2001
From: jsta <jstachelek@utexas.edu>
Date: Wed, 5 Jul 2017 17:20:06 -0400
Subject: [PATCH 1/5] source module, fix windows pathing

---
 Tools/navigator_demo.py | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/Tools/navigator_demo.py b/Tools/navigator_demo.py
index 0dd814a..52124c6 100644
--- a/Tools/navigator_demo.py
+++ b/Tools/navigator_demo.py
@@ -1,7 +1,11 @@
-from Tools.attribution_and_accumulation import Navigator
+import sys
+sys.path.append('attribution_and_accumulation')
+
+
+from attribution_and_accumulation import Navigator
 
 region_id = '07'
-topology_file = r"..\WatershedTopology\upstream_{}.npz".format(region_id)
+topology_file = r"../WatershedTopology/upstream_{}.npz".format(region_id)
 
 region = Navigator(topology_file)
 
@@ -9,4 +13,4 @@
 
 n = len(region.all_upstream(test_reach))
 
-print(n)
\ No newline at end of file
+print(n)

From 1814a040248355a2554ee122207858f9fad2ff7f Mon Sep 17 00:00:00 2001
From: jsta <jstachelek@utexas.edu>
Date: Wed, 5 Jul 2017 18:21:54 -0400
Subject: [PATCH 2/5] platform independent file path, satisfy pylint

---
 Tools/navigator_demo.py | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

diff --git a/Tools/navigator_demo.py b/Tools/navigator_demo.py
index 52124c6..78ed0ac 100644
--- a/Tools/navigator_demo.py
+++ b/Tools/navigator_demo.py
@@ -1,16 +1,17 @@
+import os
 import sys
 sys.path.append('attribution_and_accumulation')
 
-
 from attribution_and_accumulation import Navigator
 
-region_id = '07'
-topology_file = r"../WatershedTopology/upstream_{}.npz".format(region_id)
+REGION_ID = '07'
+TOPOLOGY_FILE = "upstream_{}.npz".format(REGION_ID)
+TOPOLOGY_FILE = os.path.join("WatershedTopology", TOPOLOGY_FILE)
 
-region = Navigator(topology_file)
+REGION = Navigator(TOPOLOGY_FILE)
 
-test_reach = 4867727
+TEST_REACH = 4867727
 
-n = len(region.all_upstream(test_reach))
+N = len(REGION.all_upstream(TEST_REACH))
 
-print(n)
+print(N)

From e28d7e2cf33635ab3ea778a167bd565c5d99579e Mon Sep 17 00:00:00 2001
From: jsta <jstachelek@utexas.edu>
Date: Wed, 5 Jul 2017 18:42:04 -0400
Subject: [PATCH 3/5] add docstring

---
 Tools/navigator_demo.py | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Tools/navigator_demo.py b/Tools/navigator_demo.py
index 78ed0ac..08b4c19 100644
--- a/Tools/navigator_demo.py
+++ b/Tools/navigator_demo.py
@@ -1,3 +1,5 @@
+"""This script shows how to calculate the number of reaches upstream of a target"""
+
 import os
 import sys
 sys.path.append('attribution_and_accumulation')

From 88a86665a2e56a2bc4b4abf94637705af9b59e00 Mon Sep 17 00:00:00 2001
From: jsta <jstachelek@utexas.edu>
Date: Wed, 5 Jul 2017 18:45:58 -0400
Subject: [PATCH 4/5] add README

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0230fde
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# Demonstration of a method for compact storage and recall of upstream-downstream relationships in the NHD Plus dataset
+
+## Dependencies
+
+```
+python --version
+```
+
+> Python 3.6.1 :: Anaconda custom (64-bit)
+
+```
+conda install -c conda-forge gdal
+conda install 'icu=56.*'
+
+```
+
+## Demo
+
+```
+python Tools/navigator_demo.py
+```
+
+> 2984

From 5ecfd94d9f36aad06b2c7fc8233edb41d975f7c2 Mon Sep 17 00:00:00 2001
From: jsta <jstachelek@utexas.edu>
Date: Wed, 5 Jul 2017 20:30:47 -0400
Subject: [PATCH 5/5] add pkg level docstring

---
 Tools/__init__.py | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/Tools/__init__.py b/Tools/__init__.py
index dc7c5bc..d6e6915 100644
--- a/Tools/__init__.py
+++ b/Tools/__init__.py
@@ -1 +1,5 @@
+r"""This package demonstrates a method for compact storage and \
+recall of upstream-downstream relationships in the NHD Plus dataset
+"""
+
 __author__ = 'Jhook'