Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 6 additions & 9 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
@@ -1,28 +1,25 @@
name: Run pofff

on:
push:
branches:
- main
pull_request:

jobs:
run-pofff-local:
permissions:
contents: read
pull-requests: write
timeout-minutes: 30
runs-on: ubuntu-latest
timeout-minutes: 60
runs-on: ubuntu-26.04

steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0

- name: Set up Python 3.12
- name: Set up Python 3.14
uses: actions/setup-python@v2
with:
python-version: 3.12
python-version: 3.14

- name: Install Flow Simulator
run: |
Expand All @@ -49,14 +46,14 @@ jobs:

- name: Check code style and linting
run: |
black --target-version py312 --check src/ tests/ publication/
black --target-version py312 src/ tests/ publication/ --check
pylint src/ tests/ publication/
ruff check src/ tests/ publication/
mypy --ignore-missing-imports src/ tests/ publication/

- name: Run the tests
run: |
pytest --cov=pofff --exitfirst --cov-report term-missing --basetemp=test_outputs tests/
pytest --cov=pofff --cov-report term-missing --basetemp=test_outputs tests/ --exitfirst

- name: Build documentation
run: |
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ Contributions are more than welcome using the fork and pull request approach
1. **mypy --ignore-missing-imports src/ tests/ publication/** (this is a static checker, and might rise issues that need to be fixed before the pull request)
1. **pytest --cov=pofff --cov-report term-missing --basetemp=test_outputs tests/ -n auto** (this runs locally the tests, and might rise issues that need to be fixed before the pull request)
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 delete all content from the [_docs_](https://github.com/cssr-tools/pofff/tree/main/docs) folder except [_Makefile_](https://github.com/OPM/pofff/blob/main/docs/Makefile), [_text_](https://github.com/OPM/pofff/blob/main/docs/text), and [_.nojekyll_](https://github.com/OPM/pofff/blob/main/docs/.nojekyll), after copy all contents from the docs/_build/html/ folder, and finally paste them in the [_docs_](https://github.com/cssr-tools/pofff/tree/main/docs) folder)
* Tip for Linux users: See the [_CI.yml_](https://github.com/cssr-tools/pofff/blob/main/.github/workflows/CI.yml) script and the [_Actions_](https://github.com/cssr-tools/pofff/actions) for installation of pofff, OPM Flow (binary packages), and dependencies, as well as the execution of the six previous steps in Ubuntu 24.04 using Python 3.12.
* 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 pofff), OPM Flow (source build), and dependencies, as well as running the tests in macOS 26 using Python 3.13. Note that to run the pofff tests, you have to add the directory containing the OPM Flow executable to your system's PATH environment variable (e.g., export PATH=$PATH:/path/to/opm-flow); you can check if this worked by after typing in the terminal 'flow \-\-help'.
* Tip for Linux users: See the [_CI.yml_](https://github.com/cssr-tools/pofff/blob/main/.github/workflows/CI.yml) script and the [_Actions_](https://github.com/cssr-tools/pofff/actions) for installation of pofff, OPM Flow (binary packages), and dependencies, as well as the execution of the six previous steps in Ubuntu 26.04 using Python 3.14.
* 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 pofff), OPM Flow (source build), and dependencies, as well as running the tests in macOS 26 using Python 3.14. Note that to run the pofff tests, you have to add the directory containing the OPM Flow executable to your system's PATH environment variable (e.g., export PATH=$PATH:/path/to/opm-flow); you can check if this worked by after typing in the terminal 'flow \-\-help'.
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)
1. Push your commit and make a pull request
1. The maintainers will review the pull request, and if the contribution is accepted, then it will be merged to the main repo
Expand Down
2 changes: 1 addition & 1 deletion docs/_sources/contributing.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Contribute to the software
#. **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/pofff/tree/main/docs>`_ folder)

.. tip::
See the `CI.yml <https://github.com/cssr-tools/pofff/blob/main/.github/workflows/CI.yml>`_ script and the `Actions <https://github.com/cssr-tools/pofff/actions>`_ for installation of pofff, OPM Flow (binary packages), and dependencies, as well as the execution of the six previous steps in Ubuntu 24.04 using Python 3.12.
See the `CI.yml <https://github.com/cssr-tools/pofff/blob/main/.github/workflows/CI.yml>`_ script and the `Actions <https://github.com/cssr-tools/pofff/actions>`_ for installation of pofff, OPM Flow (binary packages), and dependencies, as well as the execution of the six previous steps in Ubuntu 26.04 using Python 3.14.
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 pofff), OPM Flow (source build), and dependencies in macOS 26 using Python 3.14.
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/pofff/build/opm-simulators/bin).

Expand Down
2 changes: 1 addition & 1 deletion docs/_sources/installation.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ supported either via source builds or through running a virtual machine.
.. tip::

See the `CI.yml <https://github.com/cssr-tools/pofff/blob/main/.github/workflows/CI.yml>`_ script
for installation of OPM Flow (binary packages), LaTeX (optional) libraries, and the pofff package in Ubuntu 24.04 and Python 3.12.
for installation of OPM Flow (binary packages), LaTeX (optional) libraries, and the pofff package in Ubuntu 26.04 and Python 3.14.

Source build in Linux/Windows
+++++++++++++++++++++++++++++
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing.html
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ <h2>Contribute to the software<a class="headerlink" href="#contribute-to-the-sof
</ol>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>See the <a class="reference external" href="https://github.com/cssr-tools/pofff/blob/main/.github/workflows/CI.yml">CI.yml</a> script and the <a class="reference external" href="https://github.com/cssr-tools/pofff/actions">Actions</a> for installation of pofff, OPM Flow (binary packages), and dependencies, as well as the execution of the six previous steps in Ubuntu 24.04 using Python 3.12.
<p>See the <a class="reference external" href="https://github.com/cssr-tools/pofff/blob/main/.github/workflows/CI.yml">CI.yml</a> script and the <a class="reference external" href="https://github.com/cssr-tools/pofff/actions">Actions</a> for installation of pofff, OPM Flow (binary packages), and dependencies, as well as the execution of the six previous steps in Ubuntu 26.04 using Python 3.14.
For macOS users, see the <a class="reference external" href="https://github.com/daavid00/OPM-Flow_macOS/blob/main/.github/workflows/ci_pycopm_macos.yml">ci_pycopm_macos.yml</a> script and the <a class="reference external" href="https://github.com/cssr-tools/pycopm/actions">OPM-Flow_macOS Actions</a> for installation of pycopm (a related tool to pofff), OPM Flow (source build), and dependencies in macOS 26 using Python 3.14.
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/pofff/build/opm-simulators/bin).</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ <h3>Binary packages<a class="headerlink" href="#binary-packages" title="Link to
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>See the <a class="reference external" href="https://github.com/cssr-tools/pofff/blob/main/.github/workflows/CI.yml">CI.yml</a> script
for installation of OPM Flow (binary packages), LaTeX (optional) libraries, and the pofff package in Ubuntu 24.04 and Python 3.12.</p>
for installation of OPM Flow (binary packages), LaTeX (optional) libraries, and the pofff package in Ubuntu 26.04 and Python 3.14.</p>
</div>
</section>
<section id="source-build-in-linux-windows">
Expand Down
Loading
Loading