opm-simulators/python
Arne Morten Kvarving 1f92effa27
Merge pull request #5456 from OPM/dependabot/pip/python/sphinx_docs/jinja2-3.1.4
Bump jinja2 from 3.1.3 to 3.1.4 in /python/sphinx_docs
2024-07-01 13:39:57 +02:00
..
opm/simulators Make Python opm package a namespace package 2022-06-10 11:37:15 +02:00
simulators Docstring fixes 2024-05-02 11:24:58 +02:00
sphinx_docs Merge pull request #5456 from OPM/dependabot/pip/python/sphinx_docs/jinja2-3.1.4 2024-07-01 13:39:57 +02:00
test using one day time step for SPE1CASE1a/SPE1CASE1.DATA 2024-06-19 13:42:55 +02:00
test_data using one day time step for SPE1CASE1a/SPE1CASE1.DATA 2024-06-19 13:42:55 +02:00
CMakeLists.txt changed: vendor pybind11 using FetchContent 2023-11-16 10:02:04 +01:00
docstrings.json Docstring fixes 2024-05-02 11:24:58 +02:00
generate_docstring_hpp.py Add docstrings for Python bindings 2024-03-05 10:18:54 +01:00
README.md Removed reference to unit system 2023-09-25 11:01:12 +02:00

Python bindings for the OPM-common module of the Open Porous Media project.

To compile with python support:

  • Add the cmake flags -DOPM_ENABLE_PYTHON=ON and -DOPM_INSTALL_PYTHON=ON
  • Optionally add prefix -DCMAKE_INSTALL_PREFIX=/opt/opm to install outside the standard distro directories
  • Optionally specify python binary -DPython3_EXECUTABLE=/home/user/miniconda3/envs/rkt/bin/python3 if you don't want to use the system python, e.g. use a python from pyenv or from a conda environment

Sample compilation on linux:

#! /bin/bash

flags="-DPython3_EXECUTABLE=/home/hakon/miniconda3/envs/rkt/bin/python3 -DOPM_ENABLE_PYTHON=ON -DOPM_INSTALL_PYTHON=ON -DCMAKE_INSTALL_PREFIX=/opt/opm"
for repo in opm-common opm-grid opm-models opm-simulators
do
    cd "$repo"
    mkdir -p build
    cd build
    cmake  $flags ..
    make -j8
    sudo make install
    cd ..
    cd ..
done

Then you should be able to use the module from a Python script. If you installed in a non-standard directory by specifying -DCMAKE_INSTALL_PREFIX you may need to set the PYTHONPATH environment variable before running your Python script, for example:

$ PYTHONPATH=/opt/opm/lib/python3.11/site-packages python3 spe1case1.py

and spe1case1.py could be:

import os
from opm.simulators import BlackOilSimulator
from opm.io.parser import Parser
from opm.io.ecl_state import EclipseState
from opm.io.schedule import Schedule
from opm.io.summary import SummaryConfig

os.chdir("SPE1CASE1")
deck  = Parser().parse('SPE1CASE1.DATA')
state = EclipseState(deck)
schedule = Schedule( deck, state )
summary_config = SummaryConfig(deck, state, schedule)

sim = BlackOilSimulator(deck, state, schedule, summary_config)
sim.step_init()
sim.step()
poro = sim.get_porosity()
poro = poro *.95
sim.set_porosity(poro)
sim.step()
sim.step_cleanup()