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
29 changes: 10 additions & 19 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,46 +7,37 @@ jobs:
run-pofff-local:
permissions:
contents: read
pull-requests: write
timeout-minutes: 60
runs-on: ubuntu-26.04

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

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

- name: Install Flow Simulator
run: |
sudo apt-get update
sudo apt-get install software-properties-common
sudo apt-get install software-properties-common mpi-default-bin
sudo apt-add-repository ppa:opm/ppa
sudo apt-get update
sudo apt-get install mpi-default-bin
sudo apt-get install libopm-simulators-bin

- name: Install plotting (LaTeX) and ert dependencies
- name: Install (optional but recommended) plotting (LaTeX) and ert dependencies
run: |
sudo apt-get install texlive-fonts-recommended texlive-fonts-extra dvipng cm-super
sudo apt-get install freeglut3-dev

- name: Install Python dependecies
- name: Install pofff and python requirements
run: |
python3.14 -m venv vpofff
. vpofff/bin/activate
echo "$PWD/vpofff/bin" >> $GITHUB_PATH
pip install --upgrade pip setuptools wheel
pip install -r dev-requirements.txt

- name: Install pofff
run: |
pip install .
pip install -r dev-requirements.txt

- name: Check code style and linting
run: |
black --target-version py312 src/ tests/ publication/ --check
black --target-version py314 src/ tests/ publication/ --check
pylint src/ tests/ publication/
ruff check src/ tests/ publication/
mypy --ignore-missing-imports src/ tests/ publication/
Expand All @@ -58,4 +49,4 @@ jobs:
- name: Build documentation
run: |
pushd docs
make html
make html SPHINXOPTS="-W"
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Contributions are more than welcome using the fork and pull request approach
1. Work on your own fork of the main repo
1. In the main repo execute:
1. **pip install -r dev-requirements.txt** (this installs the [_dev-requirements.txt_](https://github.com/cssr-tools/pofff/blob/main/dev-requirements.txt))
1. **black --target-version py312 src/ tests/ publication/** (this formats the code)
1. **black --target-version py314 src/ tests/ publication/** (this formats the code)
1. **pylint src/ tests/ publication/** (this analyses the code, and might rise issues that need to be fixed before the pull request)
1. **ruff check src/ tests/ publication/** (this also analyses the code, and might rise issues that need to be fixed before the pull request)
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)
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 @@ -23,7 +23,7 @@ Contribute to the software
#. In the main repo execute:

#. **pip install -r dev-requirements.txt** (this installs the `dev-requirements.txt <https://github.com/cssr-tools/pofff/blob/main/dev-requirements.txt>`_)
#. **black \-\-target-version py312 src/ tests/ publication/** (this formats the code)
#. **black \-\-target-version py314 src/ tests/ publication/** (this formats the code)
#. **pylint src/ tests/ publication/** (this analyses the code, and might rise issues that need to be fixed before the pull request)
#. **ruff check src/ tests/ publication/** (this also analyses the code, and might rise issues that need to be fixed before the pull request)
#. **mypy \-\-ignore-missing-imports src/ tests/** (this is a static checker, and might rise issues that need to be fixed before the pull request)
Expand Down
10 changes: 7 additions & 3 deletions docs/_sources/installation.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ supported Python versions are 3.12 to 3.14.

.. code-block:: bash

brew install cssr-tools/opm/resinsight
brew tap cssr-tools/opm
brew trust cssr-tools/opm
brew install cssr-tools/opm/resinsight -y

Then, you should be able to open resinsight by typing in the terminal **resinsight**.

Expand Down Expand Up @@ -128,11 +130,13 @@ Brew formula for macOS
++++++++++++++++++++++
For macOS, there are no available binary packages, so OPM Flow needs to be built from source. Recently, a formula to build flow using brew has
been added in `https://github.com/cssr-tools/homebrew-opm <https://github.com/cssr-tools/homebrew-opm>`_.
Then, you can try to install flow (v2026.02) by simply typing:
Then, you can try to install flow (v2026.07 interim release) by simply typing:

.. code-block:: console

brew install cssr-tools/opm/opm-simulators
brew tap cssr-tools/opm
brew trust cssr-tools/opm
brew install cssr-tools/opm/opm-simulators -y

You can check if the installation of OPM Flow succeded by typing in the terminal **flow \-\-help**.

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing.html
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ <h2>Contribute to the software<a class="headerlink" href="#contribute-to-the-sof
<blockquote>
<div><ol class="arabic simple">
<li><p><strong>pip install -r dev-requirements.txt</strong> (this installs the <a class="reference external" href="https://github.com/cssr-tools/pofff/blob/main/dev-requirements.txt">dev-requirements.txt</a>)</p></li>
<li><p><strong>black --target-version py312 src/ tests/ publication/</strong> (this formats the code)</p></li>
<li><p><strong>black --target-version py314 src/ tests/ publication/</strong> (this formats the code)</p></li>
<li><p><strong>pylint src/ tests/ publication/</strong> (this analyses the code, and might rise issues that need to be fixed before the pull request)</p></li>
<li><p><strong>ruff check src/ tests/ publication/</strong> (this also analyses the code, and might rise issues that need to be fixed before the pull request)</p></li>
<li><p><strong>mypy --ignore-missing-imports src/ tests/</strong> (this is a static checker, and might rise issues that need to be fixed before the pull request)</p></li>
Expand Down
10 changes: 7 additions & 3 deletions docs/installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,9 @@ <h1>Installation<a class="headerlink" href="#installation" title="Link to this h
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>There are binary packages for Linux and Windows to install Resinsight, see the <a class="reference external" href="https://resinsight.org/releases/">ResInsight Documentation</a>. For macOS users, you could try to install it using <a class="reference external" href="https://brew.sh">brew</a> by executing:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>brew<span class="w"> </span>install<span class="w"> </span>cssr-tools/opm/resinsight
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>brew<span class="w"> </span>tap<span class="w"> </span>cssr-tools/opm
brew<span class="w"> </span>trust<span class="w"> </span>cssr-tools/opm
brew<span class="w"> </span>install<span class="w"> </span>cssr-tools/opm/resinsight<span class="w"> </span>-y
</pre></div>
</div>
<p>Then, you should be able to open resinsight by typing in the terminal <strong>resinsight</strong>.</p>
Expand Down Expand Up @@ -198,8 +200,10 @@ <h3>Source build in Linux/Windows<a class="headerlink" href="#source-build-in-li
<span id="macos"></span><h3>Brew formula for macOS<a class="headerlink" href="#brew-formula-for-macos" title="Link to this heading"></a></h3>
<p>For macOS, there are no available binary packages, so OPM Flow needs to be built from source. Recently, a formula to build flow using brew has
been added in <a class="reference external" href="https://github.com/cssr-tools/homebrew-opm">https://github.com/cssr-tools/homebrew-opm</a>.
Then, you can try to install flow (v2026.02) by simply typing:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">brew install cssr-tools/opm/opm-simulators</span>
Then, you can try to install flow (v2026.07 interim release) by simply typing:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">brew tap cssr-tools/opm</span>
<span class="go">brew trust cssr-tools/opm</span>
<span class="go">brew install cssr-tools/opm/opm-simulators -y</span>
</pre></div>
</div>
<p>You can check if the installation of OPM Flow succeded by typing in the terminal <strong>flow --help</strong>.</p>
Expand Down
36 changes: 18 additions & 18 deletions docs/pofff.config.config.html

Large diffs are not rendered by default.

Loading