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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+4-3Lines changed: 4 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,13 +12,14 @@ Contributions are more than welcome using the fork and pull request approach
12
12
13
13
1. Work on your own fork of the main repo
14
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))
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))
16
16
1.**black src/ tests/** (this formats the code)
17
17
1.**pylint src/ tests/** (this analyses the code, and might rise issues that need to be fixed before the pull request)
18
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
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
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.
21
+
* Tip for Linux users: 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.04 using Python 3.11.
22
+
* Tip for macOS users: See the [_ci_pycopm_macos_.yml_](https://github.com/daavid00/OPM-Flow_macOS/blob/main/.github/workflows/ci_pycopm_macos.yml) script and the [_OPM-Flow_macOS Actions_](https://github.com/cssr-tools/pycopm/actions) for installation of pycopm (a related tool to expreccs), OPM Flow (source build), and dependencies in macOS 26 using Python 3.13. In addition, you need to add the directory containing the OPM Flow executable to your system's PATH environment variable (e.g., export PATH=$PATH:/Users/yourname/pyopmspe11/build/opm-simulators/bin).
22
23
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
24
1. Push your commit and make a pull request
24
25
1. The maintainers will review the pull request, and if the contribution is accepted, then it will be merge to the main repo
@@ -32,4 +33,4 @@ Contributions are more than welcome using the fork and pull request approach
32
33
33
34
1. The preferred approach to seek support is to raise an Issue as described in the previous lines.
34
35
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).
36
+
- An alternative approach is to send an email to any of the [_mantainers_](https://github.com/cssr-tools/expreccs/blob/main/pyproject.toml).
@@ -12,7 +12,7 @@ Simplified and flexible software for two-stage approach (dynamic pressure bounda
12
12
13
13
## Installation
14
14
You will first need to install
15
-
* Flow (https://opm-project.org, Release 2025.04 or current master branches)
15
+
* Flow (https://opm-project.org, Release 2025.10 or current master branches)
16
16
17
17
To install the _expreccs_ executable in an existing Python environment:
18
18
@@ -66,4 +66,4 @@ The following is a list of manuscripts in which _expreccs_ is used:
66
66
## About expreccs
67
67
The _expreccs_ package is funded by Harbour Energy, Equinor, Shell, and the Research Council of Norway [project number 336294].
68
68
[_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.
69
-
Contributions are more than welcome using the fork and pull request approach. For new features, please request them raising an issue.
69
+
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/contributing.rst.txt
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,15 +21,17 @@ Contribute to the software
21
21
#. Work on your own fork of the main repo
22
22
#. In the main repo execute:
23
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>`_)
24
+
#. **pip install -r dev-requirements.txt** (this installs the `dev-requirements.txt <https://github.com/cssr-tools/expreccs/blob/main/dev-requirements.txt>`_)
25
25
#. **black src/ tests/** (this formats the code)
26
26
#. **pylint src/ tests/** (this analyses the code, and might rise issues that need to be fixed before the pull request)
27
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
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
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
30
31
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.
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.04 using Python 3.11.
33
+
For macOS users, see the `ci_pycopm_macos.yml <https://github.com/daavid00/OPM-Flow_macOS/blob/main/.github/workflows/ci_pycopm_macos.yml>`_ script and the `OPM-Flow_macOS Actions <https://github.com/cssr-tools/pycopm/actions>`_ for installation of pycopm (a related tool to expreccs), OPM Flow (source build), and dependencies in macOS 26 using Python 3.13.
34
+
In addition for macOS, you need to add the directory containing the OPM Flow executable to your system's PATH environment variable (e.g., export PATH=$PATH:/Users/yourname/pyopmspe11/build/opm-simulators/bin).
33
35
34
36
#. 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
37
#. Push your commit and make a pull request
@@ -49,4 +51,4 @@ Seek support
49
51
#. The preferred approach to seek support is to raise an Issue as described in the previous lines.
50
52
#. We will try to answer as soon as possible, but also any user is more than welcome to answer.
51
53
52
-
- An alternative approach is to send an email to any of the `mantainers <https://github.com/cssr-tools/expreccs/blob/main/pyproject.toml>`_.
54
+
- An alternative approach is to send an email to any of the `mantainers <https://github.com/cssr-tools/expreccs/blob/main/pyproject.toml>`_.
0 commit comments