O P M - O P

OPMRUN
Graphical User Interface
For
OPM Flow
David Baxendale (Author)
Joakim Hove (Presenter)

OPM-OP AS
Heyerdahlsvei 12b
777 Oslo, Norway
T: +(47)-9268-5704 F: +(47)-9268-5704 E: support@opm-op.com
 O P M - O P
OPMRUN
A Graphical User Interface For OPM Flow
COPYRIGHT
This file is part of the Open Porous Media project (OPM). OPM is free software: you can redistribute it
and/or modify it under the terms of the GNU General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your option) any later version. The
accompanying Python script is made available under the Open Database License:
http://opendatacommons.org/licenses/odbl/1.0/.

Any rights in individual contents of the database are licensed under the Database Contents License:
http://opendatacommons.org/licenses/dbcl/1.0/

OPM is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
aforementioned GNU General Public Licenses for more details.

Copyright (C) 2020 Equinox International Petroleum Consultants Pte. Ltd.

Date Revision Description Prepared Checked Approved

2020-02-04 Rev-1 Final 2020-04 D. Baxendale N/A N/A

2020-01-30 Rev-0 Final 2020-04 D. Baxendale N/A N/A

Project ID 2
 O P M - O P OPMRUN: What Is It?
A graphical user interface to OPM Flow that has similar functionality to the commercial
simulator’s ECLRUN program.
Target audience are Reservoir Engineers in a production environment. Developers and
experienced Linux users will already have compatible work flows.
Allows editing and management of OPM Flow’s run time parameters. Default parameters
are automatically loaded from OPM Flow, and the user can reset the default set either
from a parameter or *.PRT file. Editing of a job’s parameter file is also available.
Allows simulation jobs to be queued and run in either foreground (under OPMRUN), or
background (in an xterm terminal session). All jobs in the queue can be set to run in
NOSIM mode or RUN mode.
Foreground jobs can be killed from OPMRUN.
Queues can be edited, saved and loaded.
Jobs can be compressed to save space (*.DATA and all OPM Flow output files) and
uncompressed.
OPM Flow Keyword Generator - New Application (this presentation).
Written in Python 3 and tested under Unbuntu-Mate 18.04 TLS.
Compiled binary version should work on all Linux systems, no need to install dependencies
or Python.

Project ID 3
 O P M - O P
OPMRUN
A Graphical User Interface For OPM Flow

OPMRUN KEYWORD GENERATOR (OPMKEYW)

Project ID 4
 O P M - O P OPMRUN: Keyword Generator
Objective:
Generate OPM Flow keywords in a consistent manner and make the generation of a “deck” of
keywords relatively straight forward.
Able to be used with any editor via cut and paste.
Able to create and edit existing keyword templates.
Target audience are Reservoir Engineers and Developers.
Application:
Based on the Apache Velocity Template Language (“VTL”). The templates can therefore also be
used with any editor that supports VTL, jEdit for example.
One template per keyword, with formatting the same as the OPM Flow manual. Over 450
templates are currently implemented.
One can also customize the existing templates as well as creating User defined templates by
including the templates in the template directory and following the VTL language syntax.
Keywords filtered by Section in alphabetic order, and can also list all the keywords.
Multiple keywords can be generated at a time and copied to the clipboard or saved to a file.
Section keywords (RUNSPEC, GRID, EDIT, PROPS, SOLUTION, SUMMARY and SCHEDULE) can
optionally generate a set of keywords for the section.
The keywords are examples, one still has to edit the resulting deck with the actual required data,
but the format with comments should make this a straight forward process.

Project ID 5
 O P M - O P OPMRUN: Keyword Generator
OPMRUN options
have been expanded
to include the
“template directory”
and the “author
property” fields.
The “author
property” fields are
used in some
templates to
document the file.
Note if a“author
property” field is not
defined then the
template variable will
be output instead –
this can easily be
deleted in the
application.

Project ID 6
 O P M - O P OPMRUN: Keyword Generator
The Keyword
Generator is
located under the
“Tools” menu
“Deck Generator”
option.
Additional Deck
Generator
applications are
planned for future
versions.

Project ID 7
 O P M - O P OPMRUN: Keyword Generator
Keyword Filter Options

Keyword List

Deck Element

Project ID 8
 O P M - O P OPMRUN: Keyword Generator
The Keyword Filter
button allows for
the filtering of the
various keywords in
the selected
section, including
being able to list all
the keywords
available for all
sections.
The HEADER
section allows for a
start and end of file
comment headers.
Clicking on a
keyword will result
in the keyword
being "pasted" into
the Deck Element.

Project ID 9
 O P M - O P OPMRUN: Keyword Generator
The Deck Element
is editable by
simply clicking
anywhere in the
element and
making changes.
Use the “Clear”
button to clear the
Deck Element
display. Note that
this will cause all
changes to be
deleted.

Project ID 10
 O P M - O P OPMRUN: Keyword Generator
If a keyword
requires a file, for
example, the
INCLUDE and LOAD
keywords, then a
dialog box is
presented to
enable the file to
be selected.
Will also allow one
to select the file
name format, after
the file has been
selected.
The COMMENT
keyword, is not an
actual keyword, but
a comment block to
make the deck
more readable.

Project ID 11
 O P M - O P OPMRUN: Keyword Generator
Selecting a Section
keyword (RUNSPEC,
GRID, EDIT, PROPS,
SOLUTION,
SUMMARY, and
SCHEDULE) will give
an option to
generate a
representative set
of keywords for
that section.
One can therefore
generate a
complete input
deck in a matter of
minutes.
However, you still
have to edit this
with your actual
data.

Project ID 12
 O P M - O P OPMRUN: Keyword Generator
For The SCHEDULE
Section keyword,
one can also
generate a date
schedule from a
start year to and
end year, using
Annual, Quarterly,
or Monthly time
steps.
A standard report is
written at the
beginning of each
year and is
subsequently
switch off for
intermediate
Quarterly and
Monthly time steps.
A final report is
written at the end
of the run.

Project ID 13
 O P M - O P OPMRUN: Keyword Generator
Use the “Copy”
button to copy the
data in the Deck
Element to the
clipboard, which
can then be pasted
into your favorite
editor.
Alternatively, one
can save the data
directly to a *.DATA
or *.INC file for
further editing and
processing.

Project ID 14
 O P M - O P OPMRUN: Keyword Generator
After selecting a
keyword, right
clicking on the
keyword allows one
to load the actual
template for the
keyword.
One can then edit
the template and
save the changes
back to the same
template or
another template.
Probably a good
idea to save as a
separate template.
The Template Help
option displays a
brief introduction
to VTL.

Project ID 15
 O P M - O P OPMRUN: Keyword Generator
Status:
Currently under going final testing. Once complete will be uploaded to GitHub together
with documentation.
The Keyword Generator can also be used standalone, but the preferred application is
within OPMRUN to leverage Project directories etc.
The standard alone version is operating system independent, just need Python and the
various modules.
Considering generating standalone binaries, downloadable from the company’s web site, if
there is a need.
Considering generating additional Deck Generator applications:
Deck Sensitivity Generator: Using an existing input deck, generate sensitivity runs via
parameter substitution based on Full Factorial or an Experimental Design. Generate
queue and optionally run all the jobs.
Deck Production Generator: Load CSV file with production data and generate an OPM
Flow SCHEDULE section using the WCONHIST keyword.
Deck DST Generator: Load a CSV containing DST pressure gauge data and a CSV file
containing DST rate data and generate an OPM Flow SCHEDULE section using the
WCONHIST keyword, with automatic merging of the two data sets and user defined
sampling (5, 10 minutes etc).
Feedback welcome on current application and future developments.

Project ID 16
 O P M - O P
OPMRUN
A Graphical User Interface For OPM Flow

End of Presentation

Project ID 32