OilfieldToolsNet/opm-common
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #3757 from blattms/man-pages-release

Browse Source 
Update and improve man pages for release
This commit is contained in:
Markus Blatt 2023-11-14 10:06:51 +01:00 committed by GitHub
commit d3b80422e6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 39 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/man1/arraylist.1
View File

@ -1,6 +1,9 @@
.TH SUMMARY "1" "October 2022" "arraylist 2022.10" "User Commands"
.TH SUMMARY "1" "October 2023" "arraylist 2023.10" "User Commands"
.SH NAME
summary \- Printer for list of arrays in Eclipse summary files
arraylist \- Printer for list of arrays in Eclipse summary files
.SH SYNOPSIS
.B arraylist
[\fI\,OPTIONS\/\fR] \fI\,ECL_DECK_FILENAME\/\fR
.SH DESCRIPTION
List all arrays found in an EclFile specified on the command line.
.PP

6
docs/man1/co2brinepvt.1
View File

@ -1,6 +1,10 @@
.TH CO2BRINEPVT "1" "April 2022" "co2brinepvt" "User Commands"
.TH CO2BRINEPVT "1" "October 2023" "co2brinepvt" "User Commands"
.SH NAME
co2brinepvt \- compute and print pvt properties for co2 with brine
.SH SYNOPSIS
.B co2brinepvt
[\fI\,OPTIONS\/\fR] \fI\,PROPERTY\/\fR \fI\,PHASE\/\fR
\fI\,PRESSURE\/\fR \fI\,TEMPERATURE\/\fR [\fI\,SALINITY\/\fR] [\fI\,RS\/\fR]
.SH DESCRIPTION
co2brinepvt computes PVT properties of a brine/co2 system
for a given phase (oil or brine), pressure, temperature, salinity and rs.

5
docs/man1/compareECL.1
View File

@ -1,6 +1,9 @@
.TH COMPAREECL "1" "October 2022" "compareECL 2022.10" "User Commands"
.TH COMPAREECL "1" "October 2023" "compareECL 2023.10" "User Commands"
.SH NAME
compareECL \- Comparator for Eclipse files
.SH SYNOPSIS
.B convertECL
[\fI\,OPTIONS\/\fR] \fI\,ECL_DECK_FILENAME_1\/\fR \fI\,ECL_DECK_FILENAME_2\/\fR
.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:

8
docs/man1/convertECL.1
View File

@ -1,6 +1,10 @@
.TH CONVERTECL "1" "October 2022" "convertECL 2022.10" "User Commands"
.TH CONVERTECL "1" "October 2023" "convertECL 2023.10" "User Commands"
.SH NAME
convertECL \- Converter for Eclipse files (binary <-> formatted format)
convertECL \- Converter for Eclipse files (binary <-> formatted
format)
.SH SYNOPSIS
.B convertECL
[\fI\,OPTIONS\/\fR] \fI\,ECL_DECK_FILENAME\/\fR
.SH DESCRIPTION
convertECL needs one argument which is the input file to be converted. If this is a binary file the output file will be formatted. If the input file is formatted the output will be binary.
.PP

7
docs/man1/opmhash.1
View File

@ -1,8 +1,11 @@
.TH OPMHASH "1" "October 2022" "opmhash 2022.10" "User Commands"
.TH OPMHASH "1" "October 2023" "opmhash 2023.10" "User Commands"
.SH NAME
opmhash \- Hasher for summary keywords in Eclipse files
.SH SYNOPSIS
.B opmhash
[\fI\,OPTIONS\/\fR] \fI\,ECL_DECK_FILENAME\/\fR
[\fI\,ECL_DECK_FILENAME_2\/\fR] [\fI\,ECL_DECK_FILENAME_3\/\fR] ...
.SH DESCRIPTION
opmhash: invalid option \fB\-\-\fR 'h'
The purpose of the opmhash program is to load a deck and create a summary, by
diffing two such summaries it is simple to determine if two decks are similar.
For each keyword a hash of the normalized content is calculated. The output of

5
docs/man1/opmpack.1
View File

@ -1,6 +1,9 @@
.TH OPMPACK "1" "October 2022" "opmpack 2022.10" "User Commands"
.TH OPMPACK "1" "October 2023" "opmpack 2023.10" "User Commands"
.SH NAME
opmpack \- Validator and printer of deck in Eclipse files without comments
.SH SYNOPSIS
.B opmpack
[\fI\,OPTIONS\/\fR] \fI\,ECL_DECK_FILENAME\/\fR
.SH DESCRIPTION
The opmpack program will load a deck, resolve all include
files and then print it out again on stdout. All comments

6
docs/man1/rst_deck.1
View File

@ -1,6 +1,10 @@
.TH RST_DECK: "1" "October 2022" "rst_deck 2022.10" "User Commands"
.TH RST_DECK: "1" "October 2023" "rst_deck 2023.10" "User Commands"
.SH NAME
rst_deck \- Convert simulation deck to a deck ready for restart
.SH SYNOPSIS
.B rst_deck
[\fI\,OPTIONS\/\fR] \fI\,ECL_DECK_FILENAME\/\fR
\fI\,RESTART_SOURCE\/\fR [\fI\,BASENAME_RESTART_DECK\/\fR
.SH DESCRIPTION
The rst_deck program will load a simulation deck and parameters for a restart
and reformat the deck to become a restart deck. Before the updated deck is

6
docs/man1/summary.1
View File

@ -1,6 +1,10 @@
.TH SUMMARY "1" "October 2022" "summary 2022.10" "User Commands"
.TH SUMMARY "1" "October 2023" "summary 2023.10" "User Commands"
.SH NAME
summary \- Printer for summary keys in Eclipse summary files
.SH SYNOPSIS
.B summary
[\fI\,OPTIONS\/\fR] \fI\,ECL_DECK_FILENAME\/\fR
\fI\,SUMMARY_KEY1\/\fR [\fI\,SUMMARY_KEY2\/\fR] ...
.SH DESCRIPTION
summary needs a minimum of two arguments. First is smspec filename and then list of vectors
.PP