Updating documentation

Author: wcarthur

Diff for: PlotInterface/curves.py

@@ -6,10 +6,10 @@
     :synopsis: provide methods to plot curves (hazard curves,
                distributions, logarithmic axes, etc).
 
-.. moduleauthor: Craig Arthur <[email protected]>
+.. moduleauthor:: Craig Arthur <[email protected]>
 
 The routines here make use of the themes from
-`seaborn <http://stanford.edu/~mwaskom/software/seaborn/index.html>`_ to
+`seaborn <https://seaborn.pydata.org/api.html>`_ to
 define the line styles and annotations (font sizes, etc.).
 
 """

Diff for: conf.py

@@ -53,7 +53,7 @@
 # built documents.
 #
 # The short X.Y version.
-version = '2.1'
+version = '3.1.3'
 # The full version, including alpha/beta/rc tags.
 release = latest_tag.name
 

Diff for: docs/examples.rst

@@ -18,7 +18,7 @@ the example simulation can be run as follows::
 The model will automatically create output folders to store the
 results in, as well as a log file that provides details on the
 progress of the model. The simulation will process the input track
-database (IBTrACS v03r05), run the statistical interface, generate
+database (IBTrACS v03r10), run the statistical interface, generate
 1000 simulated years of TC events, the wind swaths associated with
 those simulated years, calculate the hazard (return period wind
 speeds) for the region and plot the output as maps and a return period
@@ -32,7 +32,7 @@ curve for Port Hedland. The hazard data are also stored in netCDF
      :figclass: align-center
 
      100-year return period wind speed near Port Hedland,
-     Australia. Wind speeds represent a 3-second gust wind speed, 10
+     Australia. Wind speeds represent a 0.2-second gust wind speed, 10
      metres above ground level in open, flat terrain.
 
 .. figure:: /docs/images/hazard_curve.png
@@ -41,8 +41,9 @@ curve for Port Hedland. The hazard data are also stored in netCDF
     :figclass: align-center
 
     Hazard curve for Port Hedland, Australia, based on 1000 years of
-    synthetic tropical cyclone events. The grey shading indicates the
-    90th percentile range, based on a bootstrap resampling procedure.
+    synthetic tropical cyclone events. The red points are the wind speeds for
+    individual simulated events, and the blue line is a fitted generalised
+    pareto distribution (GPD).
 
 Running in an MPI environment
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Diff for: docs/images/hazard_curve.png

@@ -182,9 +182,13 @@ from 1981--2013, we set the value to 30.
 
 ``NumTimeSteps`` controls the maximum lifetime an event can exist
 for. ``TimeStep`` sets the time interval (in hours) for the track
-generator. ``SeasonSeed`` and ``TrackSeed`` are used to fix the random
+generator. 
+
+``SeasonSeed`` and ``TrackSeed`` are used to fix the random
 number generator on parallel systems to ensure truly random numbers on
-each individual processor. ::
+each individual processor. If they are absent, the seed is set using an integer
+representation of the current time, and is recorded in the output metadata (e.g.
+attributes in the netcdf files). ::
 
     [TrackGenerator]
     NumSimulations = 500
@@ -478,16 +482,16 @@ database. The format should use Python's `datetime
 formats.  ::
 
     [IBTRACS]
-    URL=ftp://eclipse.ncdc.noaa.gov/pub/ibtracs/v03r05/wmo/csv/Allstorms.ibtracs_wmo.v03r05.csv.gz
-    path=input
-    filename=Allstorms.ibtracs_wmo.v03r05.csv
-    Columns=tcserialno,season,num,skip,skip,skip,date,skip,lat,lon,skip,pressure
-    FieldDelimiter=,
-    NumberOfHeadingLines=3
-    PressureUnits=hPa
-    LengthUnits=km
-    DateFormat=%Y-%m-%d %H:%M:%S
-    SpeedUnits=kph
+    URL = https://www.ncei.noaa.gov/data/international-best-track-archive-for-climate-stewardship-ibtracs/v04r00/access/csv/ibtracs.since1980.list.v04r00.csv
+    path = input
+    Filename = ibtracs.since1980.list.v04r00.csv
+    Columns = tcserialno,season,num,skip,skip,skip,date,skip,lat,lon,skip,pressure
+    FieldDelimiter = ,
+    NumberOfHeadingLines = 2
+    PressureUnits = hPa
+    LengthUnits = km
+    SpeedUnits = kph
+    DateFormat = %Y-%m-%d %H:%M:%S
  
 .. _references:
 

Diff for: docs/images/hazard_example.png

@@ -9,6 +9,7 @@ Resolution=0.04
 profileType=powell
 beta=1.6
 windFieldType=kepert
+domain=full
 
 
 [Region]
@@ -20,7 +21,7 @@ landmask = input/landmask.nc
 LocationFile = input/stationlist.shp
 
 [Timeseries]
-Extract=True
+Windfields=True
 LocationFile=./input/stationlist.shp
 StationID=WMO
 

Diff for: docs/setup.rst

@@ -261,7 +261,8 @@ def doDataProcessing(configFile):
 @disableOnWorkers
 def doDataPlotting(configFile):
     """
-    Plot the pre-processed input data.
+    Plot the pre-processed input data. Requires the Data Processing step to have
+    been executed first (``Actions -- DataProcess = True``)
 
     :param str configFile: Name of configuration file.
 

Diff for: example/yasi.ini

@@ -1,21 +1,4 @@
 """
-    Tropical Cyclone Risk Model (TCRM) - Version 1.0 (beta release)
-    Copyright (C) 2011 Commonwealth of Australia (Geoscience Australia)
-
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-
  Title: NumpyTestCase.py
  Author: Nariman Habili, [email protected]
  CreationDate: 2006-12-12