Add docstrings

las_manipulation.py

@@ -1,3 +1,21 @@
+"""las_manipulation.py
+Clip, classify, and detect swash zone for an input las file.
+
+Example usage:
+
+# Process single survey at specific beach
+python las_manipulation.py survey-1-avoca.yaml
+
+# Process single survey at multiple beaches
+python las_manipulation.py survey-1-avoca.yaml survey-1-pearl.yaml
+
+# Process all surveys at specific beach
+python las_manipulation.py *avoca.yaml
+
+# Process all beaches for specific survey date
+python las_manipulation.py survey-1*.yaml
+"""
+
 import os
 import sys
 import yaml

las_outputs.py

@@ -1,15 +1,22 @@
-# python 3.5
+"""las_outputs.py
-#requires LAStools to be installed (with the appropriate license). Note that LAStools requires no spaces in file names
+Crop swash zone, plot survey profiles, and complete a volume analysis based
-
+on the output from `las_manipulation.py`.
-#should have previously run 2017088_las_manipulation to have a las that has the buildings and veg removed
+
-#note that the neilson volumes script must be in the same folder
+Example usage:
-
+
-# this script will:
+# Process single survey at specific beach
-#crop to a given polygon (crop away the swash zone)
+python las_outputs.py survey-1-avoca.yaml
-# extract values along a predefined profile,
+
-# do the volume analysis
+# Process single survey at multiple beaches
-#export pngs of the surveys
+python las_outputs.py survey-1-avoca.yaml survey-1-pearl.yaml
-########################### IMPORTS ###########################################
+
+# Process all surveys at specific beach
+python las_outputs.py *avoca.yaml
+
+# Process all beaches for specific survey date
+python las_outputs.py survey-1*.yaml
+"""
+
 import os
 import io
 import re