diff --git a/.github/workflows/ci_pycopm_ubuntu.yml b/.github/workflows/ci_pycopm_ubuntu.yml index 602bfe0..d8d1e8e 100644 --- a/.github/workflows/ci_pycopm_ubuntu.yml +++ b/.github/workflows/ci_pycopm_ubuntu.yml @@ -43,7 +43,7 @@ jobs: - name: Install pycopm run: | - pip install -e .[opm] + pip install -e . - name: Check code style and linting run: | diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2fe950e..4b85d5b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,14 +13,13 @@ 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/pycopm/blob/main/dev-requirements.txt)) - 1. **pip install opm** (this does not work in macOS, then follow the steps in [_source build in macOS_](https://cssr-tools.github.io/pycopm/installation.html#source-build-in-macos)) 1. **black src/ tests/** (this formats the code) 1. **pylint src/ tests/** (this analyses the code, and might rise issues that need to be fixed before the pull request) 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) 1. **pytest --cov=pycopm --cov-report term-missing tests/** (this runs locally the tests, and might rise issues that need to be fixed before the pull request) 1. **pycopm -i examples/decks/HELLO_WORLD.DATA -c 5,5,1 -m all -o output** (this runs the hello world example, which succeeds if the file output/HELLO_WORLD_PYCOPM.EGRID is created) 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/pycopm/tree/main/docs) folder) - * Tip for Linux users: See the [_ci_pycopm_ubuntu.yml_](https://github.com/cssr-tools/pycopm/blob/main/.github/workflows/ci_pycopm_ubuntu.yml) script and the [_Actions_](https://github.com/cssr-tools/pycopm/actions) for installation of pycopm, OPM Flow (binary packages), and dependencies, as well as the execution of the eight previous steps in Ubuntu 24.04 using Python 3.11. + * Tip for Linux users: See the [_ci_pycopm_ubuntu.yml_](https://github.com/cssr-tools/pycopm/blob/main/.github/workflows/ci_pycopm_ubuntu.yml) script and the [_Actions_](https://github.com/cssr-tools/pycopm/actions) for installation of pycopm, OPM Flow (binary packages), and dependencies, as well as the execution of the seven previous steps in Ubuntu 24.04 using Python 3.11. * 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, OPM Flow (source build), and dependencies, as well as running the tests and the hello world example in macOS 26 using Python3.13. Note that if you do not add the directory containing the OPM Flow executable to your system's PATH environment variable (e.g., export PATH=$PATH:/Users/yourname/pycopm/build/opm-simulators/bin), then you can pass this in the execution of the tests and pycopm using the flags **-f/--flow** (see [_ci_pycopm_macos.yml_](https://github.com/daavid00/OPM-Flow_macOS/blob/main/.github/workflows/ci_pycopm_macos.yml#L76)). 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 diff --git a/README.md b/README.md index 384fa30..e728854 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Creation of OPM Flow geological models from provided input decks with options fo ## Installation You will first need to install -* OPM Flow (https://opm-project.org, Release 2025.04 or current master branches) +* OPM Flow (https://opm-project.org, Release 2025.10 or current master branches) To install the _pycopm_ executable from the development version: @@ -41,7 +41,7 @@ pip install -e . pip install -r dev-requirements.txt ``` -See the [_installation_](https://cssr-tools.github.io/pycopm/installation.html) for further details on building OPM Flow from the master branches in Linux, Windows (via [_WSL_](https://learn.microsoft.com/en-us/windows/wsl/)), and macOS, as well as the (optional) [_opm Python package_](https://pypi.org/project/opm/). +See the [_installation_](https://cssr-tools.github.io/pycopm/installation.html) for further details on building OPM Flow from the master branches in Linux, Windows (via [_WSL_](https://learn.microsoft.com/en-us/windows/wsl/)), and macOS. ## Running pycopm You can run _pycopm_ as a single command line: diff --git a/docs/_images/pofff.png b/docs/_images/pofff.png new file mode 100644 index 0000000..3b25a62 Binary files /dev/null and b/docs/_images/pofff.png differ diff --git a/docs/_sources/contributing.rst.txt b/docs/_sources/contributing.rst.txt index f19c75c..86ac49a 100644 --- a/docs/_sources/contributing.rst.txt +++ b/docs/_sources/contributing.rst.txt @@ -22,7 +22,6 @@ Contribute to the software #. In the main repo execute: #. **pip install -r dev-requirements.txt** (this installs the `dev-requirements.txt `_) - #. **pip install opm** (this does not work in macOS, then follow the steps in `source build in macOS `_) #. **black src/ tests/** (this formats the code) #. **pylint src/ tests/** (this 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) @@ -31,9 +30,9 @@ 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 `_ folder) .. tip:: - See the `ci_pycopm_ubuntu.yml `_ script and the `Actions `_ for installation of pycopm, OPM Flow (binary packages), and dependencies, as well as the execution of the eight previous steps in Ubuntu 24.04 using Python 3.11. + See the `ci_pycopm_ubuntu.yml `_ script and the `Actions `_ for installation of pycopm, OPM Flow (binary packages), and dependencies, as well as the execution of the seven previous steps in Ubuntu 24.04 using Python 3.11. For macOS users, see the `ci_pycopm_macos.yml `_ script and the `OPM-Flow_macOS Actions `_ for installation of pycopm, OPM Flow (source build), and dependencies, as well as running the tests and the hello world example in macOS 26 using Python3.13. - Note that if you do not add the directory containing the OPM Flow executable to your system's PATH environment variable (e.g., export PATH=$PATH:/Users/yourname/pycopm/build/opm-simulators/bin), then you can pass this in the execution of the tests and pycopm using the flags **-f/--flow** (see `this script `_). + Note that if you do not add the directory containing the OPM Flow executable to your system's PATH environment variable (e.g., export PATH=$PATH:/Users/yourname/pycopm/build/opm-simulators/bin), then you can pass this in the execution of the tests and pycopm using the flags **-f/--flow** (see `this script `_). #. Squash your commits into a single commit (see this `nice tutorial `_ if you are not familiar with this) #. Push your commit and make a pull request diff --git a/docs/_sources/installation.rst.txt b/docs/_sources/installation.rst.txt index 2ab6e36..eb0c01e 100644 --- a/docs/_sources/installation.rst.txt +++ b/docs/_sources/installation.rst.txt @@ -50,25 +50,13 @@ OPM Flow -------- You also need to install: -* OPM Flow (https://opm-project.org, Release 2025.04 or current master branches) +* OPM Flow (https://opm-project.org, Release 2025.10 or current master branches) .. tip:: See the `ci_pycopm_ubuntu.yml `_ script for installation of OPM Flow (binary packages) and the pycopm package in Ubuntu. -.. note:: - - For not macOS users, to install the optional Python opm package (this is an alternative - to `resdata `_, both are use to read OPM output files; while resdata is easier to - install in macOS, opm seems to be faster; the default is `-u resdata`), execute in the terminal - - **pip install opm** - - This is equivalent to execute **pip install -e .[opm]** in the installation process. - - For macOS users, see :ref:`macOS`. - Source build in Linux/Windows +++++++++++++++++++++++++++++ If you are a Linux user (including the Windows subsystem for Linux, see `this link `_ @@ -109,16 +97,12 @@ with brew the prerequisites can be installed by: .. code-block:: console - brew install boost@1.85 cmake openblas suite-sparse python@3.13 - -.. note:: - boost 1.89.0 was made available recently (August 14th, 2025), which it is not compatible with OPM Flow (yet). - Then, we install boost 1.85, and add the cmake path to the boost include folder, as shown in the bash lines below. + brew install boost openblas suite-sparse python@3.13 cmake In addition, it is recommended to uprade and update your macOS to the latest available versions (the following steps have worked for macOS Tahoe 26.0.1 with Apple clang version 17.0.0). After the prerequisites are installed and the vpyocpm Python environment is created (see :ref:`vpycopm`), -then building OPM Flow and the opm Python package can be achieved with the following bash lines: +then building OPM Flow can be achieved with the following bash lines: .. code-block:: console @@ -139,11 +123,8 @@ then building OPM Flow and the opm Python package can be achieved with the follo do git clone https://github.com/OPM/opm-$repo.git mkdir build/opm-$repo cd build/opm-$repo - cmake -DPYTHON_EXECUTABLE=$(which python) -DOPM_ENABLE_PYTHON=ON -DWITH_NDEBUG=1 -DUSE_MPI=0 -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH="/opt/homebrew/opt/boost@1.85/include;$CURRENT_DIRECTORY/dune-common/build-cmake;$CURRENT_DIRECTORY/dune-grid/build-cmake;$CURRENT_DIRECTORY/dune-geometry/build-cmake;$CURRENT_DIRECTORY/dune-istl/build-cmake;$CURRENT_DIRECTORY/build/opm-common;$CURRENT_DIRECTORY/build/opm-grid" $CURRENT_DIRECTORY/opm-$repo - if [[ $repo == common ]]; then - make -j5 opm$repo - make -j5 opmcommon_python - elif [[ $repo == simulators ]]; then + cmake -DUSE_MPI=0 -DWITH_NDEBUG=1 -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH="$CURRENT_DIRECTORY/dune-common/build-cmake;$CURRENT_DIRECTORY/dune-grid/build-cmake;$CURRENT_DIRECTORY/dune-geometry/build-cmake;$CURRENT_DIRECTORY/dune-istl/build-cmake;$CURRENT_DIRECTORY/build/opm-common;$CURRENT_DIRECTORY/build/opm-grid" $CURRENT_DIRECTORY/opm-$repo + if [[ $repo == simulators ]]; then make -j5 flow else make -j5 opm$repo @@ -151,19 +132,12 @@ then building OPM Flow and the opm Python package can be achieved with the follo cd ../.. done - echo "export PYTHONPATH=\$PYTHONPATH:$CURRENT_DIRECTORY/build/opm-common/python" >> $CURRENT_DIRECTORY/vpycopm/bin/activate echo "export PATH=\$PATH:$CURRENT_DIRECTORY/build/opm-simulators/bin" >> $CURRENT_DIRECTORY/vpycopm/bin/activate deactivate source vpycopm/bin/activate -This builds OPM Flow as well as the OPM Python library, and it exports the required PYTHONPATH to the opm Python package and the path to the flow executable. - -.. note:: - You can test if flow works by typing in the terminal `./build/opm-simulators/bin/flow --help`. In addition, you can add `build/opm-simulators/bin` to your path - to execute it as flow. You can also test that the Python package opm works by executing `python -c "import opm"`. If for any reason the installation of the Python - opm package was not sucessful, still all functionality of **pycopm** is available, just do not execute **pycopm** with the flag `-u opm` (see the note in - :ref:`opmflow` for a brief comment about the Python packages resdata and opm). +This builds OPM Flow, and it exports the path to the flow executable. .. tip:: See `this repository `_ dedicated to build OPM Flow from source in the latest macOS (GitHub actions), and tested with **pycopm**. diff --git a/docs/_sources/introduction.rst.txt b/docs/_sources/introduction.rst.txt index 9941e12..7098424 100644 --- a/docs/_sources/introduction.rst.txt +++ b/docs/_sources/introduction.rst.txt @@ -59,6 +59,6 @@ where -e Use 'utf8' or 'ISO-8859-1' encoding to read the deck ('ISO-8859-1' by default). -ijk Given i,j,k indices in the input model, return the modified i,j,k corresponding positions ('' by default; if not empty, e.g., '1,2,3', then there will not be generation of modified files, only the i,j,k mapped indices in the terminal). -d Options to transform the x,y,z coordinates: 'translate [10,-5,4]' adds the values in meters to the coordinates, 'scale [1,2,3]' multiplies the coordinates by the given values respectively, and 'rotatexy 45' applies a rotation in degrees in the xy plane (rotatexz and rotateyz applies a rotation around the y and x axis respectively) ('' by default). --u Use the resdata or opm Python libraries ('resdata' by default). +-u Use the resdata or opm Python libraries ('opm' by default). -explicit Set to 1 to explicitly write the cell values in the SOLUTION section in the deck ('0' by default). -warnings Set to 1 to show Python warnings ('0' by default). \ No newline at end of file diff --git a/docs/_sources/related.rst.txt b/docs/_sources/related.rst.txt index ef1cadf..7c051af 100644 --- a/docs/_sources/related.rst.txt +++ b/docs/_sources/related.rst.txt @@ -13,6 +13,14 @@ pyopmspe11 `A Python framework using OPM Flow for the CSP SPE11 benchmark project `_. +***** +pofff +***** + +.. image:: ./figs/pofff.png + +`An image-based history-matching framework for the FluidFlower Benchmark using OPM Flow `_. + ************* pyopmnearwell ************* diff --git a/docs/contributing.html b/docs/contributing.html index 05412e0..ad19862 100644 --- a/docs/contributing.html +++ b/docs/contributing.html @@ -108,7 +108,6 @@

Contribute to the software

  • pip install -r dev-requirements.txt (this installs the dev-requirements.txt)

    • -

  • pip install opm (this does not work in macOS, then follow the steps in source build in macOS)

  • black src/ tests/ (this formats the code)

  • pylint src/ tests/ (this 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)

    • @@ -118,9 +117,9 @@

    Contribute to the software

    Tip

    -

    See the ci_pycopm_ubuntu.yml script and the Actions for installation of pycopm, OPM Flow (binary packages), and dependencies, as well as the execution of the eight previous steps in Ubuntu 24.04 using Python 3.11. +

    See the ci_pycopm_ubuntu.yml script and the Actions for installation of pycopm, OPM Flow (binary packages), and dependencies, as well as the execution of the seven previous steps in Ubuntu 24.04 using Python 3.11. For macOS users, see the ci_pycopm_macos.yml script and the OPM-Flow_macOS Actions for installation of pycopm, OPM Flow (source build), and dependencies, as well as running the tests and the hello world example in macOS 26 using Python3.13. -Note that if you do not add the directory containing the OPM Flow executable to your system’s PATH environment variable (e.g., export PATH=$PATH:/Users/yourname/pycopm/build/opm-simulators/bin), then you can pass this in the execution of the tests and pycopm using the flags -f/–flow (see this script).

    +Note that if you do not add the directory containing the OPM Flow executable to your system’s PATH environment variable (e.g., export PATH=$PATH:/Users/yourname/pycopm/build/opm-simulators/bin), then you can pass this in the execution of the tests and pycopm using the flags -f/–flow (see this script).

    diff --git a/docs/genindex.html b/docs/genindex.html index 118faad..2a240cd 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -176,6 +176,8 @@

    G

    H