Add comments for script use on run_from_github.py

wrf-model · Sep 22, 2016 · e98e5b5 · e98e5b5
1 parent dffde51
commit e98e5b5
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/run_from_github.py b/run_from_github.py
@@ -1,4 +1,16 @@
 #!/usr/bin/python
+#
+# A python script for running a WTF straight from Github, just specifying a URL and branch name.
+# For now, this only works on Yellowstone. Future modifications will allow for use on local machines.
+#
+# Usage: ./run_from_github.py
+#        When prompted, enter a repository URL.
+#        When prompted, enter a branch name.
+# 
+# Author: Michael Kavulich, Jr. (September 2016)
+#
+
+
 import os
 import shutil
 import tarfile