Skip to content

A Python framework using OPM Flow to simulate regional and site reservoirs for CO2 storage

License

Notifications You must be signed in to change notification settings

cssr-tools/expreccs

Repository files navigation

Build Status Code style License: GPL v3 DOI

expreccs: A Python framework using OPM Flow to simulate regional and site reservoirs for CO2 storage

Main feature

Simplified and flexible software for two-stage approach (dynamic pressure boundary conditions) to improve CO2 storage regional and site simulations.

Installation

You will first need to install

To install the expreccs executable in an existing Python environment:

pip install git+https://github.com/cssr-tools/expreccs.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 repo
git clone https://github.com/cssr-tools/expreccs.git
# Get inside the folder
cd expreccs
# For a specific version (e.g., v2024.10), or skip this step (i.e., edge version)
git checkout v2024.10
# Create the virtual environment
python3 -m venv vexpreccs
# Activate the virtual environment
source vexpreccs/bin/activate
# Upgrade pip, setuptools, and wheel
pip install --upgrade pip setuptools wheel
# Install the expreccs 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 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.

Running expreccs

You can run expreccs as a single command line:

expreccs -i name_of_input_file

Run expreccs --help to see all possible command line argument options. Inside the configuration_file.txt file you provide the path to the flow executable and simulation parameters. See the .txt files in the examples and tests folders.

Getting started

See the examples in the documentation.

Citing

If you would like to cite this repository:

Publications

The following is a list of manuscripts in which expreccs is used:

  1. Tveit, S., Gasda, S.E., Landa-Marbán, D., Sandve, T.H., submitted. A hierarchical approach for modeling regional pressure interference in multi-site CO2 operations. http://dx.doi.org/10.2139/ssrn.5005237.
  2. Gasda, S.E., et al., 2024. Quantifying the impact of regional-scale pressure interference on commercial CO2 storage targets for multiple licenses. http://dx.doi.org/10.2139/ssrn.5053633.

About expreccs

The expreccs package is funded by Wintershall Dea, Equinor, Shell, and the Research Council of Norway [project number 336294]. This is work in progress. Here is the link to the project details. Contributions are more than welcome using the fork and pull request approach. For new features, please request them raising an issue.