This repository contains scripts to set up a workflow to run near well numerical studies using the OPM-Flow simulator.
You will first need to install
- OPM Flow (https://opm-project.org, Release 2024.04 or current master branches)
To install the pyopmnearwell executable in an existing Python environment:
pip install git+https://github.com/cssr-tools/pyopmnearwell.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/pyopmnearwell.git
# Get inside the folder
cd pyopmnearwell
# Create virtual environment
python3 -m venv vpyopmnearwell
# Activate virtual environment
source vpyopmnearwell/bin/activate
# Upgrade pip, setuptools, and wheel
pip install --upgrade pip setuptools wheel
# Install the pyopmnearwell package
pip install -e .
# For contributions/testing/linting, install the dev-requirements
pip install -r dev-requirements.txt
See the installation for further details on building OPM Flow from the master branches in Linux, Windows, and macOS.
You can run pyopmnearwell as a single command line:
pyopmnearwell -i some_input.txt -o some_output_folder
Run pyopmnearwell --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,
tests/geometries/, and tests/models/ folders.
See the examples in the documentation.
The pyopmnearwell 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.