COMPAREECL(1)

compareECL 💖

okay bestie, this is a User Command situation and the manual page is literally called compareECL, so let's get into it 🫶

---

✨ NAME ✨

compareECL — the Comparator for Eclipse files 👑

---

✨ SYNOPSIS ✨

convertECL [OPTIONS] ECL_DECK_FILENAME_1 ECL_DECK_FILENAME_2
ABSOLUTE_TOLERANCE  RELATIVE_TOLERANCE

yes, it literally says convertECL in the synopsis and I am NOT fixing it, I am reporting it 💅

---

✨ DESCRIPTION ✨

okay so compareECL compares ECLIPSE files — and when I say files I mean:

• restart (.RST)
• unified restart (.UNRST)
• initial (.INIT)
• summary (.SMRY)
• unified summary (.UNSMRY)
• or .RFT

…and also gridsizes (those come from the .EGRID or .GRID file) from two simulations. it's giving side-by-side, it's giving comparison era, we love to see it 🌸

The program takes four arguments, and bestie, all four are mandatory:

• ECL_DECK_FILENAME_1 — path to the first reference case, but without extension. yes, no extension. I know. keep up 🎀
• ECL_DECK_FILENAME_2 — path to the second reference case, also without extension.
• ABSOLUTE_TOLERANCE — the absolute tolerance to use for coparison 🍓
• RELATIVE_TOLERANCE — the relative tolerance (between 0 and 1) to use for comparison

---

✨ OPTIONS ✨

In addition, the program takes these options — and bestie, hear me: they must be given before the arguments 🙈 like, they go first, that's the vibe check:

• -a — Run a full analysis of errors. 🔥
• -h — Print help and exit. bye bestie 👋
• -d — Use report steps only when comparing results from summary files.
• -i — Execute integration test (regression test is default).

The integration test compares SGAS, SWAT and PRESSURE in unified restart files, and WOPR, WGPR, WWPR and WBHP (all wells) in summary file. 💅

• -k — Specify specific keyword to compare (capitalized), for examples -k PRESSURE or -k WOPR:A-1H
• -l — Only do comparison for the last Report Step. This option is only valid for restart files.
• -n — Do not throw on errors. no cap 🫶
• -p — Print keywords in both cases and exit.
• -r — compare a specific report time step number in a restart file.
• -t — Specify ECLIPSE filetype to compare, (default behaviour is that all files are compared if found). Different possible arguments are:
  • -t UNRST — Compare two unified restart files (.UNRST). This the default value, so it is the same as not passing option -t.
  • -t EGRID — Compare two EGrid files (.EGRID).
  • -t INIT — Compare two initial files (.INIT).
  • -t RFT — Compare two RFT files (.RFT).
  • -t SMRY — Compare two cases consistent of (unified) summary files.
  • -t RSM — Compare RSM file against a summary file.
• -x — Allow extra keywords in case number 2. These additional keywords (not found in case number1) will be ignored in the comparison.
• -y — Allow extra keywords for both cases. The additional keywords will be ignored in the comparison.

---

✨ Example usage of the program 🦋

like, here's what it actually looks like in the wild:

compareECL -k PRESSURE <path to first casefile> <path to second
casefile> 1e-3 1e-5

compareECL -t INIT -k PORO <path to first casefile> <path to second
casefile> 1e-3 1e-5

compareECL -i <path to first casefile> <path to second casefile> 0.01
1e-6

---

⚠️ the drama warning: Exceptions are thrown (and hence program exits) when deviations are larger than the specified tolerances, or when the number of cells does not match — 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. 📚

---

and that's the whole page bestie — compareECL, source compareECL, dated October 2024, manual page COMPAREECL(1). mwah, go compare some ECLIPSE files, you absolute icon 👑💖✨