This repository contains scripts to set up a workflow in python for the three cases in the CSP11 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/daavid00/pyopmcsp11.git
# Get inside the folder
cd pyopmcsp11
# Create virtual environment
python3 -m venv vpyopmcsp11
# Activate virtual environment
source vpyopmcsp11/bin/activate
# Upgrade pip, setuptools, and wheel
pip install --upgrade pip setuptools wheel
# Install the pyopmcsp11 package (in editable mode for contributions/modifications, i.e., pip install -e .)
pip install .
# 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 pyopmcsp11 package in ubuntu.
You can run pyopmcsp11 as a single command line:
pyopmcsp11 -i some_input.txt -o some_output_folder
Run pyopmcsp11 --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 pyopmcsp11 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 csp11 details. Contributions are more than welcome using the fork and pull request approach.