diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/fullswof-utils.texi | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/fullswof-utils.texi b/doc/fullswof-utils.texi index 9cdea0b..3e67c65 100644 --- a/doc/fullswof-utils.texi +++ b/doc/fullswof-utils.texi @@ -199,6 +199,31 @@ computation. @end table +@node Invoking boundaryProfile.py, Invoking makeBoundary, Runtime Dependencies, Usage +@comment node-name, next, previous, up +@section Invoking @command{boundaryProfile.py} +The @command{boundaryProfile.py} program plots a cross-section through +the topography at the specified boundary. The command-line syntax is: + +@example +./boundaryProfile.py @option{boundary} +@end example + +where @option{boundary} is one of @code{top}, @code{bottom}, @code{left} +and @code{right}. + +The program reads an input file that contains the local height data. As +a pre-requisite step the input file must be extracted from the global +@code{xyz} file. A standard utility such as @command{awk} may be used. +The input filename must be one of +@code{(top|bottom|left|right)_boundary.txt}. + +Elevation at the specified boundary is plotted against distance. The +colour of the curve denotes the boundary; the @code{top} boundary is +blue, the @code{bottom} boundary is green, the @code{left} boundary is +red and the @code{right} boundary is orange. + + @node Invoking makeBoundary, , Runtime Dependencies, Usage @comment node-name, next, previous, up @section Invoking @command{makeBoundary} |