Skip to content

Commit ee3d7ef

Browse files
authored
Merge pull request #28 from daavid00/dev
Retiring resdata
2 parents e7ecb4d + 9344bbc commit ee3d7ef

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

80 files changed

+738
-1566
lines changed

.github/workflows/CI.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ jobs:
4141
run: |
4242
pip install --upgrade pip setuptools wheel
4343
pip install -r dev-requirements.txt
44-
pip install opm
4544
4645
- name: Install expreccs
4746
run: |

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,4 +178,4 @@ reference_sgas_i,j,1_t90.png
178178
/tests/site/SITE.PRT
179179
/tests/site/SITE.SMSPEC
180180
/tests/site/SITE.UNRST
181-
/tests/site/SITE.UNSMRY
181+
/tests/site/SITE.UNSMRY

CONTRIBUTING.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,14 @@ Contributions are more than welcome using the fork and pull request approach
1212

1313
1. Work on your own fork of the main repo
1414
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))
1616
1. **black src/ tests/** (this formats the code)
1717
1. **pylint src/ tests/** (this analyses the code, and might rise issues that need to be fixed before the pull request)
1818
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)
1919
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)
2020
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).
2223
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)
2324
1. Push your commit and make a pull request
2425
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
3233

3334
1. The preferred approach to seek support is to raise an Issue as described in the previous lines.
3435
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).

MANIFEST.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ include src/expreccs/core/*
44
include src/expreccs/templates/common/*
55
include src/expreccs/templates/decks/*
66
include src/expreccs/utils/*
7-
include src/expreccs/visualization/*
7+
include src/expreccs/visualization/*

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[![Build Status](https://github.com/cssr-tools/expreccs/actions/workflows/CI.yml/badge.svg)](https://github.com/cssr-tools/expreccs/actions/workflows/CI.yml)
2-
<a href="https://www.python.org/"><img src="https://img.shields.io/badge/python-3.11%20to%203.13-blue.svg"></a>
2+
<a href="https://www.python.org/"><img src="https://img.shields.io/badge/python-3.11%20to%203.14-blue.svg"></a>
33
[![Code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
44
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
55
[![DOI](https://zenodo.org/badge/760077220.svg)](https://zenodo.org/doi/10.5281/zenodo.12100600)
@@ -12,7 +12,7 @@ Simplified and flexible software for two-stage approach (dynamic pressure bounda
1212

1313
## Installation
1414
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)
1616

1717
To install the _expreccs_ executable in an existing Python environment:
1818

@@ -66,4 +66,4 @@ The following is a list of manuscripts in which _expreccs_ is used:
6666
## About expreccs
6767
The _expreccs_ package is funded by Harbour Energy, Equinor, Shell, and the Research Council of Norway [project number 336294].
6868
[_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.

dev-requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ mypy
44
pylint
55
pytest-cov
66
sphinx
7-
sphinx-rtd-theme
7+
sphinx-rtd-theme

docs/_images/pofff.png

1.91 MB
Loading

docs/_sources/about.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ Harbour Energy, Equinor, Shell, and the Research Council of Norway [project numb
1212

1313
Contributions are more than welcome using the fork and pull request approach.
1414

15-
For new features, please request them raising an issue.
15+
For new features, please request them raising an issue.

docs/_sources/api.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ visualization folder generate images (.png) to show comparisons between the diff
1313

1414
Files in the expreccs package.
1515

16-
.. include:: modules.rst
16+
.. include:: modules.rst

docs/_sources/contributing.rst.txt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,17 @@ Contribute to the software
2121
#. Work on your own fork of the main repo
2222
#. In the main repo execute:
2323

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>`_)
2525
#. **black src/ tests/** (this formats the code)
2626
#. **pylint src/ tests/** (this analyses the code, and might rise issues that need to be fixed before the pull request)
2727
#. **mypy \-\-ignore-missing-imports src/ tests/** (this is a static checker, and might rise issues that need to be fixed before the pull request)
2828
#. **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)
2929
#. **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)
3030

3131
.. 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).
3335

3436
#. Squash your commits into a single commit (see this `nice tutorial <https://gist.github.com/lpranam/4ae996b0a4bc37448dc80356efbca7fa>`_ if you are not familiar with this)
3537
#. Push your commit and make a pull request
@@ -49,4 +51,4 @@ Seek support
4951
#. The preferred approach to seek support is to raise an Issue as described in the previous lines.
5052
#. We will try to answer as soon as possible, but also any user is more than welcome to answer.
5153

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

Comments
 (0)