Changeset 7212
- Timestamp:
- Jun 18, 2009, 11:45:08 AM (16 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
anuga_core/documentation/user_manual/anuga_internal_tools.tex
r7190 r7212 113 113 This collection of tests is designed to speed up and automate acceptance testing of a 114 114 'cluster' of compute servers. The tests are highly dependent on the installed software 115 environment, so may have limited use outside Geoscience Australia. 115 environment, so may have limited use outside Geoscience Australia, though the system 116 design does lend itself to change. 116 117 117 118 The suite of tests checks: … … 131 132 132 133 The 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. 134 must \code{ssh} to that machine. It is assumed the acceptance tests code suite itself 135 has been installed on the node it is being run from and other required code has been 136 installed on all nodes. 135 137 136 138 Before running the acceptance tests you must prepare some environment variables: … … 144 146 The first sub-test run dumps the testing environment to the screen as a check. 145 147 146 So to run the acceptance tests, do all this:148 To run the acceptance tests, do the following: 147 149 148 150 \begin{verbatim} … … 165 167 The \code{cmpsww} program is used to compare two SWW files for some approximation 166 168 of \emph{equality}. The user must be able to define what to compare in the two files, 167 as well as 'how close is close'.169 as well as set tolerances for 'how close is close'. 168 170 169 171 \subsubsection{Using cmpsww} … … 208 210 \code{event_selection} is a graphical program used to select earthquake events. 209 211 212 It designed to run under both Windows and Linux. 213 210 214 \subsubsection{Using event_selection} 211 215 \label{subsubsec:event_selection_use} … … 218 222 \end{figure} 219 223 220 Before using the program, you need to set the \emph{output base directory} field. The program needs to write 224 Before using the program, you need to set the \emph{output base directory} field at the top 225 of the window. The program needs to write 221 226 some data files and this field tells the program where to write them. Just click in the box to 222 227 select a directory somewhere in your filesystem. … … 236 241 and the three fields below (\emph{Hazard index}, 237 242 \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 243 next time you run the program. This data is stored in a file \code{event_selection.cfg} 244 in the \code{event_selection} install directory. 245 246 \pagebreak 247 248 Now you need to enter data specific to a particular event you are going to model. Fill 249 in 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 244 251 and click on the \emph{List} button: 245 252 … … 263 270 264 271 Now you can click on either the \emph{Multimux} or \emph{Grid} buttons. 265 Clicking on the \emph{Multimux} button sgives us:272 Clicking on the \emph{Multimux} button gives us: 266 273 267 274 \begin{figure}[ht] … … 270 277 \end{figure} 271 278 272 If you now look in the \code{C:$\backslash$temp} directoryyou will see that two directories have been created:279 If you now look in the output directory \code{C:$\backslash$temp} you will see that two directories have been created: 273 280 274 281 \begin{verbatim} … … 277 284 \end{verbatim} 278 285 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 the286 The \code{Results_Australia_1009_0.50_1.00} directory contains the \code{fault.xy} and \code{quake_prob.txt} 287 files used during the calculation of the multimux results. The \code{Results} directory name contains the 281 288 region name, hazard index and minimum and maximum wave heights in an encoded form. 282 289 … … 285 292 \pagebreak 286 293 287 The \emph{Grid} button was installed [for Herve]. Clicking on this button shows: 294 The \emph{Grid} button was installed to allow the selection of seafloor deformation grid data. 295 Clicking on this button shows: 288 296 289 297 \begin{figure}[ht] … … 319 327 320 328 There 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}). 322 330 The installer is generated by moving into the \code{installer} directory and right-clicking 323 331 on the \code{EventSelection.nsi} file and selecting \code{Compile NSIS script}. You must have … … 341 349 \end{itemize} 342 350 351 \subsubsection{Bugs} 352 \label{subsubsec:event_selection_bugs} 353 354 The look of \code{event_selection} under Linux is wrong -- it needs to be rewritten using sizers for GUI layout. 355 343 356 \pagebreak 344 357 … … 372 385 \index{plotcsv.py} 373 386 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 388 graph screen. Once the desired graph is plotted you may save the plot as a picture file. 389 390 The program is designed to run under both Windows and Linux. 391 392 The CSV files used \emph{must} have column header information as the first line as the column 393 header values are used during the plotting process. 377 394 378 395 \subsubsection{Using plotcsv} … … 390 407 plot are listed in the textbox at the top of the screen. There is nothing there because this is 391 408 the 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. 409 as well as other information, when you next start the program. This files is \code{plotcsv.cfg} and it is 410 stored in the \code{plotcsv} install directory. 393 411 394 412 \pagebreak … … 426 444 Note that choosing a column to plot also sets the text in the \emph{X-Label} and \emph{Y-Label} 427 445 textboxes. You can change this text and, in this example, we want to change the stage axis text 428 to \emph{Stage (meters)}. We a dd some title text and turn on the graph legend:446 to \emph{Stage (meters)}. We also add some title text and turn on the graph legend: 429 447 430 448 \begin{figure}[ht] … … 450 468 \label{subsubsec:plotcsv_install} 451 469 452 Justexecute the \code{plotcsv_X.X.exe} file in \code{N:$\backslash$georisk$\backslash$downloads$\backslash$plotcsv}.470 For Windows execute the \code{plotcsv_X.X.exe} file in \code{N:$\backslash$georisk$\backslash$downloads$\backslash$plotcsv}. 453 471 This will install \code{plotcsv} into your \code{C:$\backslash$Program Files} directory and create a desktop icon. 454 472 455 \subsubsection{Building plotcsv} 473 Linux needs no installation, just run the program. 474 475 \subsubsection{Building plotcsv for Windows} 456 476 \label{subsubsec:plotcsv_build} 457 477 458 478 The 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.479 on the \code{plotcsv.nsi} file and select "Compile NSIS Script". You must ihave the NSIS installer installed, of course. 460 480 Get it from \url{http://nsis.sourceforge.net/Main_Page}. 461 481 … … 464 484 465 485 The 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/}, 486 close the application. Using the \code{wx_mpl_bars.py} example from 487 \url{http://eli.thegreenplace.net/2008/08/01/matplotlib-with-wxpython-guis/}, 469 488 rewrite \code{plotcsv} to have the parameter changes (such as title text) show up immediately in the current plot. 489 490 The look of \code{plotcsv} under Linux is wrong -- it needs to be rewritten using sizers for GUI layout. 470 491 471 492 \pagebreak … … 478 499 479 500 The \code{tar_file.py} program is used to tar and compress a file or directory into a *.tgz file. 501 We have a python function to do this as we can't use a local \emph{tar} program, as this wouldn't 502 work under Windows. 480 503 481 504 The associated \code{untar_file.py} program reverses the above process. 505 506 These two programs are used in the Patong Beach validation suite. 482 507 483 508 \subsubsection{Using tar_file} … … 507 532 \label{subsubsec:tar_file_install} 508 533 509 No installation is required, just run the program s.534 No installation is required, just run the program. 510 535 511 536 \pagebreak … … 516 541 517 542 \code{update_DVD_images} is a program used to create the DVD image filesystems that were burnt to DVD 518 for the ...543 for the 2009 East Coast Tsunami Inundation study. 519 544 520 545 \subsubsection{Using update_DVD_images} … … 542 567 \end{verbatim} 543 568 544 Note that the case of the input jurisdictiondoesn't matter.569 Note that the case of the jurisdiction name doesn't matter. 545 570 546 571 The program will create a new sub-directory with the \emph{formal} jurisdiction name (see below) … … 643 668 \end{verbatim} 644 669 645 where \code{j_dict} would be a reference to the jurisdiction dictionary control ing the670 where \code{j_dict} would be a reference to the jurisdiction dictionary controlling the 646 671 process (\code{gold_coast_data} in this case). 647 672 … … 687 712 \pagebreak 688 713 689 Next, we define which individual files we copy to adestination data directory:714 Next, we define which individual files we copy to the destination data directory: 690 715 691 716 \begin{verbatim} … … 729 754 variable to the path defined in the \code{arcgis_dst_path} variable. 730 755 756 \subsubsection{extra_files} 757 \label{subsubsec:update_DVD_images_extra_files} 758 759 In the same directory as \code{update_DVD_images} there must be a directory \code{extra_files}. 760 This directory contains 'scaffolding' files that must exist on the DVD as well as jurisdiction-specific 761 files that may be modifications of project files that replace those files on the DVD. 762 763 All files in the \code{extra_files} directory are copied to each jurisdiction DVD staging directory. 764 All top-level directories that \emph{aren't} named for a jurisdiction are also copied to each 765 staging directory. 766 767 Each directory named for a jurisdiction will be copied to the staging directory 768 if the directory has the same name as the jurisdiction staging directory we are creating. 769 This jurisdiction directory would normally contain jurisdiction-specific scaffolding 770 files, such as \code{index.html}, etc, as well as modified project files. 771 731 772 \pagebreak 732 773 … … 739 780 a filesystem sub_tree. 740 781 782 The \code{create_lic_file} program is used to create a licence file that controls one or more 783 data files. 784 741 785 \subsubsection{Using update_lic_checksum} 742 786 \label{subsubsec:update_lic_checksum_use} … … 750 794 where \emph{directory} is the path to the sub_directory containing licence files to update. 751 795 Normally, \code{update_lic_checksum} would search for and update all \code{*.lic} files. If you 752 want to update licence files that have a generalfilename form of \code{*.txt} then use the796 want to update licence files that have a filename form of \code{*.txt} then use the 753 797 \code{-m *.txt} option. 754 798 … … 802 846 <filename>README</filename> 803 847 <checksum>1387779554</checksum> 804 <publishable> N</publishable>848 <publishable>Y</publishable> 805 849 <accountable>rwilson</accountable> 806 850 <source>Generated by ANUGA development team</source> … … 817 861 818 862 \begin{verbatim} 819 <publishable> N</publishable>863 <publishable>Y</publishable> 820 864 <source>Generated by ANUGA development team</source> 821 865 <IP_owner>Geoscience Australia</IP_owner> … … 898 942 No installation is necessary, just execute the programs. 899 943 944 \subsubsection{Bugs} 945 \label{subsubsec:write_large_files_bugs} 946 947 Instead of having three files, one to test each NetCDF model, just add an extra option to 948 a single program: 949 \begin{verbatim} 950 -c classic model (default) 951 -l large model 952 -4 NetCDF4 model 953 \end{verbatim} 954 900 955 %begin{latexonly} 901 956 %\renewcommand{\indexname}{Index}
Note: See TracChangeset
for help on using the changeset viewer.
