You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The following is a set of guidelines for contributing to expreccs.
3
+
Contributions are more than welcome using the fork and pull request approach 🙂 (if you are not familiar with this approach, please visit [_GitHub Docs PRs_](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests) for an extended documentation about collaborating with pull request; also, looking at previous merged pull requests helps to get familiar with this).
5
4
6
5
## Ground Rules
7
6
8
-
1. We use Black code formatting
9
-
1. We use Pylint
10
-
1. We document our code
7
+
- We use Black code formatting
8
+
- We use Pylint
9
+
- We document our code
11
10
12
-
## Pull Request Process
11
+
## Contribute to the software
13
12
14
13
1. Work on your own fork of the main repo
15
-
1. Push your commits and make a pull request
16
-
1. The changes are merged when your code has been approved
14
+
1. In the main repo execute:
15
+
1.**pip install -r dev-requirements.txt** (this installs the [_dev-requirements.txt_](https://github.com/cssr-tools/expreccs/blob/main/dev-requirements.txt); in addition, the opm Python package is required, then for not macOs users run **pip install opm**, or else follow the instructions in [_macOS installation_](https://cssr-tools.github.io/expreccs/installation.html#source-build-in-macos))
16
+
1.**black src/ tests/** (this formats the code)
17
+
1.**pylint src/ tests/** (this analyses the code, and might rise issues that need to be fixed before the pull request)
18
+
1.**mypy --ignore-missing-imports src/ tests/** (this is a static checker, and might rise issues that need to be fixed before the pull request)
19
+
1.**pytest --cov=expreccs --cov-report term-missing tests/** (this runs locally the tests, and might rise issues that need to be fixed before the pull request)
20
+
1.**pushd docs & make html** (this generates the documentation, and might rise issues that need to be fixed before the pull request; if the build succeeds and if the contribution changes the documentation, then copy all content from the docs/_build/html/ folder and replace the files in the [_docs_](https://github.com/cssr-tools/expreccs/tree/main/docs) folder)
21
+
* Tip: See the [_CI.yml_](https://github.com/cssr-tools/expreccs/blob/main/.github/workflows/CI.yml) script and the [_Actions_](https://github.com/cssr-tools/expreccs/actions) for installation of expreccs, OPM Flow (binary packages), and dependencies, as well as the execution of the six previous steps in Ubuntu 24.10.
22
+
1. Squash your commits into a single commit (see this [_nice tutorial_](https://gist.github.com/lpranam/4ae996b0a4bc37448dc80356efbca7fa) if you are not familiar with this)
23
+
1. Push your commit and make a pull request
24
+
1. The maintainers will review the pull request, and if the contribution is accepted, then it will be merge to the main repo
25
+
26
+
## Reporting issues or problems
27
+
28
+
1. Issues or problems can be raised by creating a [_new issue_](https://github.com/cssr-tools/expreccs/issues) in the repository GitHub page (if you are not familiar with this approach, please visit [_GitHub Docs Issues_](https://docs.github.com/en/issues/tracking-your-work-with-issues)).
29
+
1. We will try to answer as soon as possible, but also any user is more than welcome to answer.
30
+
31
+
## Seek support
32
+
33
+
1. The preferred approach to seek support is to raise an Issue as described in the previous lines.
34
+
1. We will try to answer as soon as possible, but also any user is more than welcome to answer.
35
+
- An alternative approach is to send an email to any of the [_mantainers_](https://github.com/cssr-tools/expreccs/blob/main/pyproject.toml).
This repository contains scripts to set up a workflow to run site and regional reservoirs for CO2 storage using the [_OPM-Flow_](https://opm-project.org/?page_id=19) simulator.
8
+
# expreccs: A Python framework using OPM Flow to simulate regional and site reservoirs for CO2 storage
9
+
10
+
## Main feature
11
+
Simplified and flexible software for two-stage approach (dynamic pressure boundary conditions) to improve CO2 storage regional and site simulations.
12
12
13
13
## Installation
14
14
You will first need to install
15
-
* Flow (https://opm-project.org, Release 2024.04 or current master branches)
15
+
* Flow (https://opm-project.org, Release 2024.10 or current master branches)
16
16
17
17
To install the _expreccs_ executable in an existing Python environment:
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:
23
+
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:
# For a specific version (e.g., v2024.10), or skip this step (i.e., edge version)
31
+
git checkout v2024.10
30
32
# Create the virtual environment
31
33
python3 -m venv vexpreccs
32
34
# Activate the virtual environment
@@ -39,20 +41,31 @@ pip install -e .
39
41
pip install -r dev-requirements.txt
40
42
```
41
43
42
-
See the [_installation_](https://cssr-tools.github.io/exprecss/installation.html) for further details on building OPM Flow from the master branches in Linux, Windows, and macOS, as well as the opm Python package.
44
+
See the [_installation_](https://cssr-tools.github.io/exprecss/installation.html) 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.
43
45
44
46
## Running expreccs
45
47
You can run _expreccs_ as a single command line:
46
48
```
47
-
expreccs -i some_input.txt -o some_output_folder
49
+
expreccs -i configuration_file.txt
48
50
```
49
-
Run `expreccs --help` to see all possible command line argument options. Inside the `some_input.txt` file you provide the path to the
51
+
Run `expreccs --help` to see all possible command line argument options. Inside the `configuration_file.txt` file you provide the path to the
50
52
flow executable and simulation parameters. See the .txt files in the [_examples_](https://github.com/cssr-tools/expreccs/tree/main/examples) and [_tests_](https://github.com/cssr-tools/expreccs/tree/main/tests/configs) folders.
51
53
52
54
## Getting started
53
-
See the [_examples_](https://cssr-tools.github.io/expreccs/examples.html) in the [_documentation_](https://cssr-tools.github.io/expreccs/introduction.html).
55
+
See the [_examples_](https://cssr-tools.github.io/expreccs/examples.html) in the [_documentation_](https://cssr-tools.github.io/expreccs/introduction.html).
56
+
57
+
## Citing
58
+
If you would like to cite this repository:
59
+
60
+
* Landa-Marbán, D. 2024. expreccs: A Python framework using OPM Flow to simulate regional and site reservoirs for CO2 storage. V2024.04. https://doi.org/10.5281/zenodo.12100600.
61
+
62
+
## Publications
63
+
The following is a list of manuscripts in which _expreccs_ is used:
64
+
65
+
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.
66
+
1. Gasda, S.E., et al., submitted. Quantifying the impact of regional-scale pressure interference on commercial CO2 storage targets for multiple licenses.
54
67
55
68
## About expreccs
56
-
The expreccs package is funded by Wintershall Dea, Equinor, Shell, and the Research Council of Norway [project number 336294].
69
+
The _expreccs_ package is funded by Wintershall Dea, Equinor, Shell, and the Research Council of Norway [project number 336294].
57
70
This is work in progress. [_Here_](https://www.norceresearch.no/en/projects/expansion-of-resources-for-co2-storage-on-the-horda-platform-expreccs) is the link to the project details.
58
-
Contributions are more than welcome using the fork and pull request approach.
71
+
Contributions are more than welcome using the fork and pull request approach. For new features, please request them raising an issue.
Copy file name to clipboardexpand all lines: docs/_sources/about.rst.txt
+3-1
Original file line number
Diff line number
Diff line change
@@ -11,4 +11,6 @@ Wintershall Dea, Equinor, Shell, and the Research Council of Norway [project num
11
11
This is work in progress.
12
12
`Here <https://www.norceresearch.no/en/projects/expansion-of-resources-for-co2-storage-on-the-horda-platform-expreccs>`_ is the link to the project details.
13
13
14
-
Contributions are more than welcome using the fork and pull request approach.
14
+
Contributions are more than welcome using the fork and pull request approach.
15
+
16
+
For new features, please request them raising an issue.
Contributions are more than welcome using the fork and pull request approach 🙂 (if you are not familiar with this approach,
6
+
please visit `GitHub Docs PRs <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests>`_ for an extended
7
+
documentation about collaborating with pull request; also, looking at previous merged pull requests helps to get familiar with this).
8
+
9
+
============
10
+
Ground Rules
11
+
============
12
+
13
+
- We use Black code formatting
14
+
- We use Pylint
15
+
- We document our code
16
+
17
+
==========================
18
+
Contribute to the software
19
+
==========================
20
+
21
+
#. Work on your own fork of the main repo
22
+
#. In the main repo execute:
23
+
24
+
#. **pip install -r dev-requirements.txt** (this installs the `dev-requirements.txt <https://github.com/cssr-tools/expreccs/blob/main/dev-requirements.txt>`_; in addition, the opm Python package is required, then for not macOs users run **pip install opm**, or else follow the instructions in `macOS installation <https://cssr-tools.github.io/expreccs/installation.html#source-build-in-macos>`_)
25
+
#. **black src/ tests/** (this formats the code)
26
+
#. **pylint src/ tests/** (this analyses the code, and might rise issues that need to be fixed before the pull request)
27
+
#. **mypy --ignore-missing-imports src/ tests/** (this is a static checker, and might rise issues that need to be fixed before the pull request)
28
+
#. **pytest --cov=expreccs --cov-report term-missing tests/** (this runs locally the tests, and might rise issues that need to be fixed before the pull request)
29
+
#. **pushd docs & make html** (this generates the documentation, and might rise issues that need to be fixed before the pull request; if the build succeeds and if the contribution changes the documentation, then copy all content from the docs/_build/html/ folder and replace the files in the `docs <https://github.com/cssr-tools/expreccs/tree/main/docs>`_ folder)
30
+
31
+
.. tip::
32
+
See the `CI.yml <https://github.com/cssr-tools/expreccs/blob/main/.github/workflows/CI.yml>`_ script and the `Actions <https://github.com/cssr-tools/expreccs/actions>`_ for installation of expreccs, OPM Flow (binary packages), and dependencies, as well as the execution of the six previous steps in Ubuntu 24.10.
33
+
34
+
#. Squash your commits into a single commit (see this `nice tutorial <https://gist.github.com/lpranam/4ae996b0a4bc37448dc80356efbca7fa>`_ if you are not familiar with this)
35
+
#. Push your commit and make a pull request
36
+
#. The maintainers will review the pull request, and if the contribution is accepted, then it will be merge to the main repo
37
+
38
+
============================
39
+
Reporting issues or problems
40
+
============================
41
+
42
+
#. Issues or problems can be raised by creating a `new issue <https://github.com/cssr-tools/expreccs/issues>`_ in the repository GitHub page (if you are not familiar with this approach, please visit `GitHub Docs Issues <https://docs.github.com/en/issues/tracking-your-work-with-issues>`_).
43
+
#. We will try to answer as soon as possible, but also any user is more than welcome to answer.
44
+
45
+
============
46
+
Seek support
47
+
============
48
+
49
+
#. The preferred approach to seek support is to raise an Issue as described in the previous lines.
50
+
#. We will try to answer as soon as possible, but also any user is more than welcome to answer.
51
+
52
+
- An alternative approach is to send an email to any of the `mantainers <https://github.com/cssr-tools/expreccs/blob/main/pyproject.toml>`_.
@@ -98,20 +101,20 @@ iteration is set to 10 in line 22 of the `configuration_file <https://github.com
98
101
between any of the iterations, we can use our friend `plopm <https://github.com/cssr-tools/plopm>`_.
99
102
100
103
.. tip::
101
-
You can install plopm by executing in the terminal: pip install git+https://github.com/cssr-tools/plopm.git.
104
+
You can install `plopm <https://github.com/cssr-tools/plopm>`_ by executing in the terminal: **pip install git+https://github.com/cssr-tools/plopm.git**.
102
105
103
-
For example, to show the difference in the spatial maps for pressure at iteration 4 and 7 at the third restart, this is achieved by executing:
106
+
For example, to show the difference in the spatial maps for pressure between iteration 4 and 7 at the third restart, this is achieved by executing:
0 commit comments