Changeset 7212


Ignore:
Timestamp:
Jun 18, 2009, 11:45:08 AM (15 years ago)
Author:
rwilson
Message:

Minor additions, spelling errors, etc.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • anuga_core/documentation/user_manual/anuga_internal_tools.tex

    r7190 r7212  
    113113This collection of tests is designed to speed up and automate acceptance testing of a
    114114'cluster' of compute servers.  The tests are highly dependent on the installed software
    115 environment, so may have limited use outside Geoscience Australia.
     115environment, so may have limited use outside Geoscience Australia, though the system
     116design does lend itself to change.
    116117
    117118The suite of tests checks:
     
    131132
    132133The acceptance tests are designed to be run from the cluster 'master node', so you
    133 must \code{ssh} to that machine.  It is assumed the acceptance tests code suite is available
    134 on the master node.
     134must \code{ssh} to that machine.  It is assumed the acceptance tests code suite itself
     135has been installed on the node it is being run from and other required code has been
     136installed on all nodes.
    135137
    136138Before running the acceptance tests you must prepare some environment variables:
     
    144146The first sub-test run dumps the testing environment to the screen as a check.
    145147
    146 So to run the acceptance tests, do all this:
     148To run the acceptance tests, do the following:
    147149
    148150\begin{verbatim}
     
    165167The \code{cmpsww} program is used to compare two SWW files for some approximation
    166168of \emph{equality}.  The user must be able to define what to compare in the two files,
    167 as well as 'how close is close'.
     169as well as set tolerances for 'how close is close'.
    168170
    169171\subsubsection{Using cmpsww}
     
    208210\code{event_selection} is a graphical program used to select earthquake events.
    209211
     212It designed to run under both Windows and Linux.
     213
    210214\subsubsection{Using event_selection}
    211215\label{subsubsec:event_selection_use}
     
    218222\end{figure}
    219223
    220 Before using the program, you need to set the \emph{output base directory} field.  The program needs to write
     224Before using the program, you need to set the \emph{output base directory} field at the top
     225of the window.  The program needs to write
    221226some data files and this field tells the program where to write them.  Just click in the box to
    222227select a directory somewhere in your filesystem.
     
    236241and the three fields below (\emph{Hazard index},
    237242\emph{Minimum wave height} and \emph{Maximum wave height}) will be remembered and restored the
    238 next time you run the program.
    239 
    240 \pagebreak
    241 
    242 OK, now you need to enter data specific to a particular event you are going to model.  Fill
    243 in the \emph{Hazard index}, \emph{Minimum wave height} and \emph{Maximum wave height} values
     243next time you run the program.  This data is stored in a file \code{event_selection.cfg}
     244in the \code{event_selection} install directory.
     245
     246\pagebreak
     247
     248Now you need to enter data specific to a particular event you are going to model.  Fill
     249in the \emph{Hazard index} (location in the database of the point where the hazard is measured),
     250\emph{Minimum wave height} and \emph{Maximum wave height} values
    244251and click on the \emph{List} button:
    245252
     
    263270
    264271Now you can click on either the \emph{Multimux} or \emph{Grid} buttons.
    265 Clicking on the  \emph{Multimux} buttons gives us:
     272Clicking on the  \emph{Multimux} button gives us:
    266273
    267274\begin{figure}[ht]
     
    270277\end{figure}
    271278
    272 If you now look in the \code{C:$\backslash$temp} directory you will see that two directories have been created:
     279If you now look in the output directory \code{C:$\backslash$temp} you will see that two directories have been created:
    273280
    274281\begin{verbatim}
     
    277284\end{verbatim}
    278285
    279 The \code{Results_Australia_1009_0.50_1.00} directory contains the \code{fault.xy} and \code(quake_prob.txt}
    280 files used during the calculation of the multimux results.  The directory name contains the
     286The \code{Results_Australia_1009_0.50_1.00} directory contains the \code{fault.xy} and \code{quake_prob.txt}
     287files used during the calculation of the multimux results.  The \code{Results} directory name contains the
    281288region name, hazard index and minimum and maximum wave heights in an encoded form.
    282289
     
    285292\pagebreak
    286293
    287 The \emph{Grid} button was installed [for Herve].  Clicking on this button shows:
     294The \emph{Grid} button was installed to allow the selection of seafloor deformation grid data.
     295Clicking on this button shows:
    288296
    289297\begin{figure}[ht]
     
    319327
    320328There is an installer program used to install \code{event_selection} on a Windows machine (usually found at
    321 \code{georisk\downloads\event_selection}).
     329\code{georisk$\backslash$downloads$\backslash$event_selection}).
    322330The installer is generated by  moving into the \code{installer} directory and right-clicking
    323331on the \code{EventSelection.nsi} file and selecting \code{Compile NSIS script}.  You must have
     
    341349\end{itemize}
    342350
     351\subsubsection{Bugs}
     352\label{subsubsec:event_selection_bugs}
     353
     354The look of \code{event_selection} under Linux is wrong -- it needs to be rewritten using sizers for GUI layout.
     355
    343356\pagebreak
    344357
     
    372385\index{plotcsv.py}
    373386
    374 
    375 \code{plotcsv} is a GUI program to quickly plot selected columns of a CSV file onto a graph screen.
    376 Once the desired graph is plotted you may save the plot as a picture file.
     387\code{plotcsv} is a GUI program to quickly plot selected columns of one or more CSV files onto a
     388graph screen.  Once the desired graph is plotted you may save the plot as a picture file.
     389
     390The program is designed to run under both Windows and Linux.
     391
     392The CSV files used \emph{must} have column header information as the first line as the column
     393header values are used during the plotting process.
    377394
    378395\subsubsection{Using plotcsv}
     
    390407plot are listed in the textbox at the top of the screen.  There is nothing there because this is
    391408the first time you have run \code{plotcsv}.  Note that \code{plotcsv} will remember the selected files,
    392 as well as other information, when you next start the program.
     409as well as other information, when you next start the program.  This files is \code{plotcsv.cfg} and it is
     410stored in the \code{plotcsv} install directory.
    393411
    394412\pagebreak
     
    426444Note that choosing a column to plot also sets the text in the \emph{X-Label} and \emph{Y-Label}
    427445textboxes.  You can change this text and, in this example, we want to change the stage axis text
    428 to \emph{Stage (meters)}.  We add some title text and turn on the graph legend:
     446to \emph{Stage (meters)}.  We also add some title text and turn on the graph legend:
    429447
    430448\begin{figure}[ht]
     
    450468\label{subsubsec:plotcsv_install}
    451469
    452 Just execute the \code{plotcsv_X.X.exe} file in \code{N:$\backslash$georisk$\backslash$downloads$\backslash$plotcsv}.
     470For Windows execute the \code{plotcsv_X.X.exe} file in \code{N:$\backslash$georisk$\backslash$downloads$\backslash$plotcsv}.
    453471This will install \code{plotcsv} into your \code{C:$\backslash$Program Files} directory and create a desktop icon.
    454472
    455 \subsubsection{Building plotcsv}
     473Linux needs no installation, just run the program.
     474
     475\subsubsection{Building plotcsv for Windows}
    456476\label{subsubsec:plotcsv_build}
    457477
    458478The source directory for \code{plotcsv} contains an \code{installer} directory.  Just right-click
    459 on the \code{plotcsv.nsi} file and select "Compile NSIS Script".  You must the NSIS installer installed, of course.
     479on the \code{plotcsv.nsi} file and select "Compile NSIS Script".  You must ihave the NSIS installer installed, of course.
    460480Get it from \url{http://nsis.sourceforge.net/Main_Page}.
    461481
     
    464484
    465485The mixture of matplotlib and wxpython isn't successful - you only get one plot and then you must
    466 close the application.
    467 
    468 Using the wx_mpl_bars.py example from \url{http://eli.thegreenplace.net/2008/08/01/matplotlib-with-wxpython-guis/},
     486close the application.  Using the \code{wx_mpl_bars.py} example from
     487\url{http://eli.thegreenplace.net/2008/08/01/matplotlib-with-wxpython-guis/},
    469488rewrite \code{plotcsv} to have the parameter changes (such as title text) show up immediately in the current plot.
     489
     490The look of \code{plotcsv} under Linux is wrong -- it needs to be rewritten using sizers for GUI layout.
    470491
    471492\pagebreak
     
    478499
    479500The \code{tar_file.py} program is used to tar and compress a file or directory into a *.tgz file.
     501We have a python function to do this as we can't use a local \emph{tar} program, as this wouldn't
     502work under Windows.
    480503
    481504The associated \code{untar_file.py} program reverses the above process.
     505
     506These two programs are used in the Patong Beach validation suite.
    482507
    483508\subsubsection{Using tar_file}
     
    507532\label{subsubsec:tar_file_install}
    508533
    509 No installation is required, just run the programs.
     534No installation is required, just run the program.
    510535
    511536\pagebreak
     
    516541
    517542\code{update_DVD_images} is a program used to create the DVD image filesystems that were burnt to DVD
    518 for the ...
     543for the 2009 East Coast Tsunami Inundation study.
    519544
    520545\subsubsection{Using update_DVD_images}
     
    542567\end{verbatim}
    543568
    544 Note that the case of the input jurisdiction doesn't matter.
     569Note that the case of the jurisdiction name doesn't matter.
    545570
    546571The program will create a new sub-directory with the \emph{formal} jurisdiction name (see below)
     
    643668\end{verbatim}
    644669
    645 where \code{j_dict} would be a reference to the jurisdiction dictionary controling the
     670where \code{j_dict} would be a reference to the jurisdiction dictionary controlling the
    646671process (\code{gold_coast_data} in this case).
    647672
     
    687712\pagebreak
    688713
    689 Next, we define which individual files we copy to a destination data directory:
     714Next, we define which individual files we copy to the destination data directory:
    690715
    691716\begin{verbatim}
     
    729754variable to the path defined in the \code{arcgis_dst_path} variable.
    730755
     756\subsubsection{extra_files}
     757\label{subsubsec:update_DVD_images_extra_files}
     758
     759In the same directory as \code{update_DVD_images} there must be a directory \code{extra_files}.
     760This directory contains 'scaffolding' files that must exist on the DVD as well as jurisdiction-specific
     761files that may be modifications of project files that replace those files on the DVD.
     762
     763All files in the \code{extra_files} directory are copied to each jurisdiction DVD staging directory.
     764All top-level directories that \emph{aren't} named for a jurisdiction are also copied to each
     765staging directory.
     766
     767Each directory named for a jurisdiction will be copied to the staging directory
     768if the directory has the same name as the jurisdiction staging directory we are creating.
     769This jurisdiction directory would normally contain jurisdiction-specific scaffolding
     770files, such as \code{index.html}, etc, as well as modified project files.
     771
    731772\pagebreak
    732773
     
    739780a filesystem sub_tree.
    740781
     782The \code{create_lic_file} program is used to create a licence file that controls one or more
     783data files.
     784
    741785\subsubsection{Using update_lic_checksum}
    742786\label{subsubsec:update_lic_checksum_use}
     
    750794where \emph{directory} is the path to the sub_directory containing licence files to update.
    751795Normally, \code{update_lic_checksum} would search for and update all \code{*.lic} files.  If you
    752 want to update licence files that have a general filename form of \code{*.txt} then use the
     796want to update licence files that have a filename form of \code{*.txt} then use the
    753797\code{-m *.txt} option.
    754798
     
    802846    <filename>README</filename>
    803847    <checksum>1387779554</checksum>
    804     <publishable>N</publishable>
     848    <publishable>Y</publishable>
    805849    <accountable>rwilson</accountable>
    806850    <source>Generated by ANUGA development team</source>
     
    817861
    818862\begin{verbatim}
    819 <publishable>N</publishable>
     863<publishable>Y</publishable>
    820864<source>Generated by ANUGA development team</source>
    821865<IP_owner>Geoscience Australia</IP_owner>
     
    898942No installation is necessary, just execute the programs.
    899943
     944\subsubsection{Bugs}
     945\label{subsubsec:write_large_files_bugs}
     946
     947Instead of having three files, one to test each NetCDF model, just add an extra option to
     948a single program:
     949\begin{verbatim}
     950  -c    classic model (default)
     951  -l    large model
     952  -4    NetCDF4 model
     953\end{verbatim}
     954
    900955%begin{latexonly}
    901956%\renewcommand{\indexname}{Index}
Note: See TracChangeset for help on using the changeset viewer.