diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/fullswof-utils.texi | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/fullswof-utils.texi b/doc/fullswof-utils.texi index 1132a86..6be130f 100644 --- a/doc/fullswof-utils.texi +++ b/doc/fullswof-utils.texi @@ -43,6 +43,7 @@ Utility scripts for the FullSWOF shallow flow solver @menu * Installation:: Installing FullSWOF-utils. * Usage:: +* Demos:: * GNU Free Documentation License:: The license of this manual. * Index:: Complete Index. @end menu @@ -293,6 +294,25 @@ number of height intervals Comment lines are allowed in the boundary definition file. Lines that start with the @samp{#} character are treated as comments. +@node Demos, GNU Free Documentation License, Boundary Definition File, Top +@comment node-name, next, previous, up +@chapter Demos + +Examples of input files that demonstrate how to use +@emph{FullSWOF-utils} programs are included in the @file{demo} +directory. Sample height data, in the file @file{topography.txt}, is +also provided. + +To run the demos directly, first change the current working directory to +the @file{demo} directory. Then execute the individual program +(@pxref{Invoking makeBoundary} for an example). + +The input files may be viewed with a text editor. To experiment with +the control parameters, first back up the distributed input files and +then edit the parameter values as desired. Note that the +@command{makeBoundary} program will overwrite its output file if it +already exists. + @node GNU Free Documentation License, Index, Usage, Top @appendix GNU Free Documentation License @include fdl-1.3.texi |