Changeset 4945

Timestamp:

Jan 16, 2008, 4:06:41 PM (17 years ago)

Author:

nick

Message:

update cairns scenario with new graphs

File:

• anuga_core/documentation/user_manual/anuga_user_manual.tex (modified) (3 diffs)

anuga_core/documentation/user_manual/anuga_user_manual.tex

@@ -1325 +1325 @@
 Header information has been included to identify the location in terms of eastings and
 northings, and each gauge is given a name. The elevation column can be zero here.
-This information is then passed to the function sww2timeseries (shown in
-\file{GetTimeseries.py} which generates figures for
-each desired quantity for each point location.
+This information is then passed to the function \code{sww2csv_gauges} (shown in
+\file{GetTimeseries.py} which generates the csv files for each point location. The csv files 
+can then be used in \code{csv2timeseries_graphs} to create the timeseries plot for each desired 
+quantity. \code{csv2timeseries_graphs} relies on \code{pylab} to be install which is not part
+of the standard \code{anuga} release, however it can be downloaded and installed from \code{http://matplotlib.sourceforge.net/}
 
 \verbatiminput{demos/cairns/GetTimeseries.py}
 
-Here, the time series for the quantities stage and speed will be generated for
-each gauge defined in the gauge file. As described earlie, depth is more meaningful
-for onshore gauges, and stage is more appropriate for offshore gauges. However, the
-function used to generate the time series information at each gauge will plot
-stage or depth depending on the elevation at that gauge location. Note, if this is
-not required, users may update the relevation section of the function.
+Here, the time series for the quantities stage, depth and speed will be generated for
+each gauge defined in the gauge file. As described earlier, depth is more meaningful
+for onshore gauges, and stage is more appropriate for offshore gauges. 
 
 As an example output,
 Figure \ref{fig:reef} shows the time series for the quantity stage for the 
 Elford Reef location for each scenario (the elevation at this location is negative, 
-thereby showing stage). Note the large negative stage value when the slide was
+therefore stage is the most appropriate to use). Note the large negative stage value when the slide was
 introduced. This is due to the double gaussian form of the initial surface
 displacement of the slide. By contrast, the time series for depth is shown for the onshore location of the Cairns
-Airport for each scenario is Figure \ref{fig:airportboth}.
+Airport in Figure \ref{fig:airportboth}.
 
 \begin{figure}[hbt]
-\centerline{\includegraphics[scale=0.5]{graphics/gaugeElfordReefboth.png}}
+\centerline{\includegraphics[scale=0.5]{graphics/stage_gauge_Elford_Reef.png}}
 \caption{Time series information of the quantity stage for the Elford Reef location for the 
 fixed wave and slide scenario.}
@@ -1354 +1353 @@
 
 \begin{figure}[hbt]
-\centerline{\includegraphics[scale=0.5]{graphics/gaugeCairnsAirportboth.png}}
+\centerline{\includegraphics[scale=0.5]{graphics/depth_gauge_Cairns_Airport.png}}
 \caption{Time series information of the quantity depth for the Cairns Airport 
 location for the slide and fixed wave scenario.}
@@ -4108 +4107 @@
 1) Create csv files from the sww file using \code{anuga.abstract_2d_finite_volumes.util sww2csv_gauges}
 and then use \code{anuga.abstract_2d_finite_volumes.util csv2timeseries_graphs} to 
-create the plots. This code is newer, has unit tests and might be easier to use. Read docstrings for more information.
+create the plots. This code is newer, has unit tests and might be easier to use. Read doc strings for more information and
+review section 4.7 of this manual.
 
 Or
 
 2) Use \code{anuga.abstract_2d_finite_volumes.util sww2timeseries} to do the whole thing
-however this doesn't have a much control on the file name and plots. Plus there is no unit test yet.
+however this doesn't have a much control on the file name and plots. Plus there is no unit tests yet.
 
 Read the doc string for more information.