From edfb8afabf82ae291ef1a2501d6520d6ea41d530 Mon Sep 17 00:00:00 2001
From: Dan Howe <d.howe@wrl.unsw.edu.au>
Date: Wed, 25 Jul 2018 10:11:46 +1000
Subject: [PATCH] Add docstrings

---
 las_manipulation.py | 18 ++++++++++++++++++
 las_outputs.py      | 31 +++++++++++++++++++------------
 2 files changed, 37 insertions(+), 12 deletions(-)

diff --git a/las_manipulation.py b/las_manipulation.py
index 905b07d..9a44b67 100644
--- a/las_manipulation.py
+++ b/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
diff --git a/las_outputs.py b/las_outputs.py
index f53217e..aaff5b6 100644
--- a/las_outputs.py
+++ b/las_outputs.py
@@ -1,15 +1,22 @@
-# python 3.5
-#requires LAStools to be installed (with the appropriate license). Note that LAStools requires no spaces in file names
-
-#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
-
-# this script will:
-#crop to a given polygon (crop away the swash zone)
-# extract values along a predefined profile,
-# do the volume analysis
-#export pngs of the surveys
-########################### IMPORTS ###########################################
+"""las_outputs.py
+Crop swash zone, plot survey profiles, and complete a volume analysis based
+on the output from `las_manipulation.py`.
+
+Example usage:
+
+# Process single survey at specific beach
+python las_outputs.py survey-1-avoca.yaml
+
+# Process single survey at multiple beaches
+python las_outputs.py survey-1-avoca.yaml survey-1-pearl.yaml
+
+# 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