diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/fullswof-utils.texi | 37 |
1 files changed, 32 insertions, 5 deletions
diff --git a/doc/fullswof-utils.texi b/doc/fullswof-utils.texi index 6119af9..c19f706 100644 --- a/doc/fullswof-utils.texi +++ b/doc/fullswof-utils.texi @@ -42,11 +42,12 @@ Utility scripts for the FullSWOF shallow flow solver @menu * Installation:: Installing FullSWOF-utils. +* Usage:: * GNU Free Documentation License:: The license of this manual. * Index:: Complete Index. @end menu -@node Installation, GNU Free Documentation License, Top, Top +@node Installation, Usage, Top, Top @comment node-name, next, previous, up @chapter Installation @@ -78,7 +79,7 @@ documentation system. @end itemize -@node Cloning, , Requirements, Installation +@node Cloning, Uninstalling, Requirements, Installation @comment node-name, next, previous, up @section Cloning @@ -110,7 +111,7 @@ on one page. The subdirectory @emph{html_node} contains a top-level The info file may be read using the @command{info} program. The html files may be read using any web browser. -@node Uninstalling, GNU Free Documentation License, Cloning, Installation +@node Uninstalling, , Cloning, Installation @comment node-name, next, previous, up @section Uninstalling @@ -124,12 +125,38 @@ Then execute the command: rm -rf fullSWOF-utils @end example +@node Usage, GNU Free Documentation License, Installation, Top +@comment node-name, next, previous, up +@chapter Usage + +The programs provided in the @emph{fullSWOF-utils} package are written +in the @emph{python} programming language. Python version 3.0 or above +is recommended. @xref{Runtime Dependencies} for the python packages +that are required by each program. + +To run an individual program it is convenient to create a symbolic link +to the corresponding file in the installation directory. For example, +from a suitable working directory, execute the following command to +create a link to the @emph{makeBoundary} program: + +@example +ln -s /path/to/installation/directory/python/makeBoundary +@end example + +@menu +* Runtime Dependencies:: +@end menu + +@node Runtime Dependencies, , Usage, Usage +@comment node-name, next, previous, up +@section Runtime Dependencies + -@node GNU Free Documentation License +@node GNU Free Documentation License, Index, Usage, Top @appendix GNU Free Documentation License @include fdl-1.3.texi -@node Index +@node Index, , GNU Free Documentation License, Top @unnumbered Index @printindex cp |