Repository files navigation

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

To install theplopm executable in an existing Python environment:

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

If you are interested in a specific version (e.g., v2024.10) or 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 repogit clone https://github.com/cssr-tools/plopm.git# Get inside the foldercd plopm# For a specific version (e.g., v2024.10), or else skip this step (i.e., edge version)git checkout v2024.10# Create virtual environment (for macOS, use a Python version >= 3.10)python3 -m venv vplopm# Activate virtual environmentsource vplopm/bin/activate# Upgrade pip, setuptools, and wheelpip install --upgrade pip setuptools wheel# Install the plopm packagepip install -e.# Install the dev-requirementspip install -r dev-requirements.txt

To use the conversion from OPM Flow output files (i.e., .EGRID, .INIT, .UNRST) to VTK (e.g, to useparaview for visualization/postprocessing),OPM Flow is needed. See theinstallation 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 and LaTeX dependencies.

You can runplopm as a single command line:

plopm -i name(s)_of_input_file(s)

Runplopm --help to see all possible command line argument options.

See theexamples in thedocumentation.

If you would like to cite this repository:

• Landa-Marbán, D. 2024. plopm: Quick generation of PNGs, GIFs, and VTKs from a OPM Flow type model.https://doi.org/10.5281/zenodo.13332415.

Theplopm package is being funded by theHPC Simulation Software for the Gigatonne Storage Challenge project [project number 622059] andCenter 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.