Updated documentation

ecjoliver · Oct 26, 2015 · c5fda2a · c5fda2a
1 parent c2ae78f
commit c5fda2a
Show file tree

Hide file tree

Showing 9 changed files with 19,675 additions and 16,398 deletions.
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -8,3 +8,4 @@ v0.7, 4 June 2015   -- Added support for missing values in temperature time seri
 v0.8, 16 July 2015  -- Added calculations of total MHW days and cumulative intensity
 v0.9, 14 Sep 2015   -- Added calculation of MHW rank and return period
 v0.10, 14 Sep 2015  -- Added calculation of normalized MHW intensity
+v0.11, 26 Oct 2015  -- Updated documentation
diff --git a/build/lib/marineHeatWaves.py b/build/lib/marineHeatWaves.py
@@ -101,7 +101,7 @@ def detect(t, temp, climatologyPeriod=[1983,2012], pctile=90, windowHalfWidth=5,
     Notes:
 
       1. This function assumes that the input time series consist of continuous daily values
-         with no missing values. Time ranges which start and end part-way through the calendar
+         with few missing values. Time ranges which start and end part-way through the calendar
          year are supported.
 
       2. This function supports leap years. This is done by ignoring Feb 29s for the initial
@@ -112,9 +112,9 @@ def detect(t, temp, climatologyPeriod=[1983,2012], pctile=90, windowHalfWidth=5,
          before the start day and ended a half-day after the end-day. (This is consistent with the
          duration definition as implemented, which assumes duration = end day - start day + 1.)
 
-      4. For the purposes of MHW detection, any missing temp values not interpolated over will be
-         set equal to the seasonal climatology. This means they will trigger the end/start of any
-         adjacent temp values which satisfy the MHW criteria.
+      4. For the purposes of MHW detection, any missing temp values not interpolated over (through
+         optional maxPadLLength) will be set equal to the seasonal climatology. This means they will
+         trigger the end/start of any adjacent temp values which satisfy the MHW criteria.
 
     Written by Eric Oliver, Institue for Marine and Antarctic Studies, University of Tasmania, Feb 2015
 

diff --git a/docs/.ipynb_checkpoints/example_synthetic-checkpoint.ipynb b/docs/.ipynb_checkpoints/example_synthetic-checkpoint.ipynb
diff --git a/docs/README.txt b/docs/README.txt
@@ -8,19 +8,19 @@
  Contents
  ========
 
- example_bigThreeMHWs.html  HTML file of IPython notebook outlining use of
-                            marineHeatWaves code to detect the "big three"
-                            historical marine heatwaves. Original data files
-                            (NOAA OI SST hi-res) not supplied.
+ marineHeatWaves_manual.html HTML file of IPython notebook outlining use of
+                             marineHeatWaves code to detect the "big three"
+                             historical marine heatwaves. Original data files
+                             (NOAA OI SST hi-res) not supplied due to copyright.
 
- example_synthetic.ipynb    IPython notebook outlining use of marineHeatWaves
-                            code to detect events from a synthetic time series.
-                            This notebook can be run by the user as it relies
-                            on internally-generated synthetic temperature data.
+ example_synthetic.ipynb     IPython notebook outlining use of marineHeatWaves
+                             code to detect events from a synthetic time series.
+                             This notebook can be run by the user as it relies only
+                             on internally-generated synthetic temperature data.
 
- example_synthetic.html     Static HTML version of example_synthetic.ipynb
+ example_synthetic.html      Static HTML version of example_synthetic.ipynb
 
- README.txt         This file
+ README.txt                  This file
 
  Contact
  =======

diff --git a/docs/example_bigThreeMHWs.html b/docs/example_bigThreeMHWs.html
diff --git a/docs/example_synthetic.html b/docs/example_synthetic.html
diff --git a/docs/example_synthetic.ipynb b/docs/example_synthetic.ipynb
diff --git a/docs/marineHeatWaves_manual.html b/docs/marineHeatWaves_manual.html
diff --git a/setup.py b/setup.py
@@ -2,7 +2,7 @@
 from distutils.core import setup
 
 setup(name='marineHeatWaves',
-    version='0.10',
+    version='0.11',
     author = "Eric C. J. Oliver",
     author_email = "eric.oliver@utas.edu.au",
     description = ("A set of functions which implement the Marine Heatwave definition of Hobday et al. (2015)"),