plopm: Simplified and flexible tool to visualize OPM Flow geological models

Main feature

Quick generation of PNG figures, GIFs, and VTKs from a OPM Flow type model.

Installation

To install the plopm executable in an existing Python environment:

pip install git+https://github.com/cssr-tools/plopm.git

If you are interested in modifying the source code, then you can clone the repository and install the Python requirements in a virtual environment with the following commands:

# Clone the repo
git clone https://github.com/cssr-tools/plopm.git
# Get inside the folder
cd plopm
# Create virtual environment (for macOS, use a Python version >= 3.10)
python3 -m venv vplopm
# Activate virtual environment
source vplopm/bin/activate
# Upgrade pip, setuptools, and wheel
pip install --upgrade pip setuptools wheel
# Install the plopm package
pip install -e .
# Install the dev-requirements
pip install -r dev-requirements.txt

To use the conversion from OPM Flow output files (i.e., .EGRID, .INIT, .UNRST) to VTK (e.g, to use paraview for visualization/postprocessing), OPM Flow is needed. Then see the installation for further details on installing binaries or building OPM Flow from the master branches in Linux, Windows, and macOS, as well as the opm Python package.

Running plopm

You can run plopm as a single command line:

plopm -i name(s)_of_input_file(s)

Run plopm --help to see all possible command line argument options.

Getting started

See the examples in the documentation.

About plopm

The plopm package is being funded by the HPC Simulation Software for the Gigatonne Storage Challenge project [project number 622059] and Center for Sustainable Subsurface Resources (CSSR) [project no. 331841]. This is work in progress. Contributions are more than welcome using the fork and pull request approach. For new features, please request them raising an issue.