This repository contains scripts to set up a workflow in python for the three cases in the SPE11 project. Here we use the OPM-Flow simulator.
You will first need to install
- Flow (https://opm-project.org)
To build dune and the corresponding OPM master branches from source (e.g., you are a macOS user), you can run the script
./build_dune_and_opm-flow.bash, which in turn should build flow in the folder
./build/opm-simulators/bin/flow (for macOS users the dependecies such as boost can be installed using brew or macports).
You can install the requirements in a virtual environment with the following commands:
# Clone the repo
git clone https://github.com/OPM/pyopmspe11.git
# Get inside the folder
cd pyopmspe11
# Create virtual environment
python3 -m venv vpyopmspe11
# Activate virtual environment
source vpyopmspe11/bin/activate
# Upgrade pip, setuptools, and wheel
pip install --upgrade pip setuptools wheel
# Install the pyopmspe11 package (in editable mode for contributions/modifications; otherwise, pip install .)
pip install -e .
# For contributions/testing/linting, install the dev-requirements
pip install -r dev-requirements.txtSee the CI.yml script for installation of OPM Flow and the pyopmspe11 package in Linux.
You can run pyopmspe11 as a single command line:
pyopmspe11 -i some_input.txt -o some_output_folder
Run pyopmspe11 --help to see all possible command line
argument options. Inside the some_input.txt file you provide the path to the
flow executable and simulation parameters. See the .txt files in the examples
folders.
See the documentation.
The pyopmspe11 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. Here is the link to the spe11 details. Contributions are more than welcome using the fork and pull request approach.