b24ca0519c
Debian policy says that each executable should have a man page.
This should remove the lintian warning about missing man pages.
Man pages have been created by the following command:
declare -A short_desc
short_desc['compareECL']='Comparator for Eclipse files'
short_desc['convertECL']='Converter for Eclipse files (binary <-> formatted format)'
short_desc['opmhash']='Hasher for summary keywords in Eclipse files'
short_desc['opmpack']='Validator and printer of deck in Eclipse files without comments'
short_desc['summary']='Printer for summary keys in Eclipse summary files'
for key in "${!short_desc[@]}"; do
help2man -h "-h" --version-string="2020.04" --no-discard-stderr -n "${short_desc[$key]}" $key >\
$key.1
done
Gbp-Pq: Name 0005-Added-manpages-for-all-executables.patch
66 lines
3.1 KiB
Groff
66 lines
3.1 KiB
Groff
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.8.
|
|
.TH COMPAREECL "1" "April 2021" "compareECL 2020.04" "User Commands"
|
|
.SH NAME
|
|
compareECL \- Comparator for Eclipse files
|
|
.SH DESCRIPTION
|
|
compareECL compares ECLIPSE files (restart (.RST), unified restart (.UNRST), initial (.INIT), summary (.SMRY), unified summary (.UNSMRY) or .RFT) and gridsizes (from .EGRID or .GRID file) from two simulations.
|
|
The program takes four arguments:
|
|
.PP
|
|
1. Case number 1, reference case (full path without extension)
|
|
2. Case number 2, test case (full path without extension)
|
|
3. Absolute tolerance
|
|
4. Relative tolerance (between 0 and 1)
|
|
.PP
|
|
In addition, the program takes these options (which must be given before the arguments):
|
|
.PP
|
|
\fB\-a\fR Run a full analysis of errors.
|
|
\fB\-h\fR Print help and exit.
|
|
\fB\-d\fR Use report steps only when comparing results from summary files.
|
|
\fB\-i\fR Execute integration test (regression test is default).
|
|
.IP
|
|
The integration test compares SGAS, SWAT and PRESSURE in unified restart files, and WOPR, WGPR, WWPR and WBHP (all wells) in summary file.
|
|
.PP
|
|
\fB\-k\fR Specify specific keyword to compare (capitalized), for examples \fB\-k\fR PRESSURE or \fB\-k\fR WOPR:A\-1H
|
|
\fB\-l\fR Only do comparison for the last Report Step. This option is only valid for restart files.
|
|
\fB\-n\fR Do not throw on errors.
|
|
\fB\-p\fR Print keywords in both cases and exit.
|
|
\fB\-r\fR compare a spesific report time step number in a restart file.
|
|
\fB\-t\fR Specify ECLIPSE filetype to compare, (default behaviour is that all files are compared if found). Different possible arguments are:
|
|
.TP
|
|
\fB\-t\fR UNRST
|
|
Compare two unified restart files (.UNRST). This the default value, so it is the same as not passing option \fB\-t\fR.
|
|
.TP
|
|
\fB\-t\fR EGRID
|
|
Compare two EGrid files (.EGRID).
|
|
.TP
|
|
\fB\-t\fR INIT
|
|
Compare two initial files (.INIT).
|
|
.TP
|
|
\fB\-t\fR RFT
|
|
Compare two RFT files (.RFT).
|
|
.TP
|
|
\fB\-t\fR SMRY
|
|
Compare two cases consistent of (unified) summary files.
|
|
.PP
|
|
\fB\-x\fR Allow extra keywords in case number 2. These additional keywords (not found in case number1) will be ignored in the comparison.
|
|
.PP
|
|
Example usage of the program:
|
|
.PP
|
|
compareECL \fB\-k\fR PRESSURE <path to first casefile> <path to second casefile> 1e\-3 1e\-5
|
|
compareECL \fB\-t\fR INIT \fB\-k\fR PORO <path to first casefile> <path to second casefile> 1e\-3 1e\-5
|
|
compareECL \fB\-i\fR <path to first casefile> <path to second casefile> 0.01 1e\-6
|
|
.PP
|
|
Exceptions are thrown (and hence program exits) when deviations are larger than the specified tolerances, or when the number of cells does not match \fB\-\-\fR either in the grid file or for a specific keyword. Information about the keyword, keyword occurrence (zero based) and cell coordinate is printed when an exception is thrown. For more information about how the cases are compared, see the documentation of the EclFilesComparator class.
|
|
.SH "SEE ALSO"
|
|
The full documentation for
|
|
.B compareECL
|
|
is maintained as a Texinfo manual. If the
|
|
.B info
|
|
and
|
|
.B compareECL
|
|
programs are properly installed at your site, the command
|
|
.IP
|
|
.B info compareECL
|
|
.PP
|
|
should give you access to the complete manual.
|