diff --git a/.gitignore b/.gitignore index ab4799c..e311c5d 100644 --- a/.gitignore +++ b/.gitignore @@ -137,4 +137,4 @@ cssr debugging developing playground -**/tests/configs/*/ \ No newline at end of file +**/tests/configs/*/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 174ded7..fde95e6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,7 +18,7 @@ Contributions are more than welcome using the fork and pull request approach 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=pymm --cov-report term-missing tests/** (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 copy all content from the docs/_build/html/ folder and replace the files in the [_docs_](https://github.com/cssr-tools/pymm/tree/main/docs) folder) - * Tip: See the [_CI.yml_](https://github.com/cssr-tools/pymm/blob/main/.github/workflows/CI.yml) script and the [_Actions_](https://github.com/cssr-tools/pymm/actions) for installation of _pymm_, as well as the execution of the six previous steps in Ubuntu 24.10 using Python 3.12. + * Tip: See the [_CI.yml_](https://github.com/cssr-tools/pymm/blob/main/.github/workflows/CI.yml) script and the [_Actions_](https://github.com/cssr-tools/pymm/actions) for installation of _pymm_, as well as the execution of the six previous steps in Ubuntu 24.04 using Python 3.12. 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 merge to the main repo @@ -32,4 +32,4 @@ Contributions are more than welcome using the fork and pull request approach 1. The preferred approach to seek support is to raise an Issue as described in the previous lines. 1. We will try to answer as soon as possible, but also any user is more than welcome to answer. -- An alternative approach is to send an email to any of the [_mantainers_](https://github.com/cssr-tools/pymm/blob/main/pyproject.toml). \ No newline at end of file +- An alternative approach is to send an email to any of the [_mantainers_](https://github.com/cssr-tools/pymm/blob/main/pyproject.toml). diff --git a/README.md b/README.md index afbf6bd..aed92ab 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Creation of [_OpenFOAM_](https://www.openfoam.com) simulation models from given ## Installation You will first need to install * OpenFOAM (https://www.openfoam.com) (tested with OpenFOAM-13) -* Gmsh (https://gmsh.info) (tested with Gmsh 4.14.0) +* Gmsh (https://gmsh.info) (tested with Gmsh 4.15.0) To install the _pymm_ executable from the development version: @@ -43,7 +43,7 @@ pip install -e . pip install -r dev-requirements.txt ``` -See the [_OpenFOAM page_](https://openfoam.org/download/13-ubuntu/), where from OpenFOAM-12 the simulator is available via apt get. +See the [_OpenFOAM page_](https://openfoam.org/download/13-ubuntu/), where from OpenFOAM-12 the simulator is available via apt get, and OpenFOAM-13 is the latest release. ## Running pymm You can run _pymm_ as a single command line: @@ -67,4 +67,4 @@ The following is a list of journal papers in which _pymm_ is used: ## About pymm _pymm_, an image-based Python package for computational fluid dynamics, is funded by [_Center for Sustainable Subsurface Resources_](https://cssr.no) [project no. 331841] and [_NORCE Research As_](https://www.norceresearch.no) [project number 101070]. Contributions are more than welcome using the fork and pull request approach. -For a new feature, please request this by raising an issue. \ No newline at end of file +For a new feature, please request this by raising an issue. diff --git a/dev-requirements.txt b/dev-requirements.txt index e6a74d0..e2e62df 100644 --- a/dev-requirements.txt +++ b/dev-requirements.txt @@ -4,4 +4,4 @@ mypy pylint pytest-cov sphinx -sphinx-rtd-theme \ No newline at end of file +sphinx-rtd-theme 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/about.rst.txt b/docs/_sources/about.rst.txt index be8ae6c..8a56542 100644 --- a/docs/_sources/about.rst.txt +++ b/docs/_sources/about.rst.txt @@ -6,9 +6,9 @@ About pymm :scale: 35% The image-based Python package for computational fluid dynamics **pymm** is funded by -Center for Sustainable Subsurface Resources [project no. 331841] and NORCE Norwegian -Research Centre As [project number 101070]. +Center for Sustainable Subsurface Resources [project no. 331841] and NORCE +Research As [project number 101070]. Contributions are more than welcome using the fork and pull request approach. -For a new feature, please request this raising an issue. \ No newline at end of file +For a new feature, please request this raising an issue. diff --git a/docs/_sources/api.rst.txt b/docs/_sources/api.rst.txt index f375153..1cf6906 100644 --- a/docs/_sources/api.rst.txt +++ b/docs/_sources/api.rst.txt @@ -9,4 +9,4 @@ The templates folder contains mako files. Files in the pymm package. -.. include:: modules.rst \ No newline at end of file +.. include:: modules.rst diff --git a/docs/_sources/contributing.rst.txt b/docs/_sources/contributing.rst.txt index cfe217e..def10ae 100644 --- a/docs/_sources/contributing.rst.txt +++ b/docs/_sources/contributing.rst.txt @@ -29,7 +29,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 `_ folder) .. tip:: - See the `CI.yml `_ script and the `Actions `_ for installation of pymm, as well as the execution of the six previous steps in Ubuntu 24.10. + See the `CI.yml `_ script and the `Actions `_ for installation of pymm, as well as the execution of the six previous steps in Ubuntu 24.04. #. 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 @@ -49,4 +49,4 @@ Seek support #. The preferred approach to seek support is to raise an Issue as described in the previous lines. #. We will try to answer as soon as possible, but also any user is more than welcome to answer. -- An alternative approach is to send an email to any of the `mantainers `_. \ No newline at end of file +- An alternative approach is to send an email to any of the `mantainers `_. diff --git a/docs/_sources/examples.rst.txt b/docs/_sources/examples.rst.txt index 85657bc..fbaf49d 100644 --- a/docs/_sources/examples.rst.txt +++ b/docs/_sources/examples.rst.txt @@ -101,4 +101,4 @@ The execution time was ca. 15 minutes and the following are screenshots of the s .. figure:: figs/online_velocity.png .. figure:: figs/online_tracer.png - Simulation results of the (top) pressure, (middle) velocity, and (bottom) tracer concentration. \ No newline at end of file + Simulation results of the (top) pressure, (middle) velocity, and (bottom) tracer concentration. diff --git a/docs/_sources/installation.rst.txt b/docs/_sources/installation.rst.txt index 39f3155..405b84e 100644 --- a/docs/_sources/installation.rst.txt +++ b/docs/_sources/installation.rst.txt @@ -4,6 +4,8 @@ Installation The following steps work installing the dependencies in Linux via apt-get. While using package managers such as Anaconda, Miniforge, or Mamba might work, these are not tested. +The supported Python versions are 3.12 and 3.13. We will update the documentation when Python3.14 is supported +(e.g., the porespy Python package is not yet available via pip install in Python 3.14). Python package -------------- @@ -65,4 +67,4 @@ See the `Gmsh page `_. .. tip:: See the `CI.yml `_ script - for installation of pymm in Ubuntu using Python3.13. + for installation of pymm in Ubuntu using Python 3.13. diff --git a/docs/_sources/output_folder.rst.txt b/docs/_sources/output_folder.rst.txt index e1a0bc3..7167660 100644 --- a/docs/_sources/output_folder.rst.txt +++ b/docs/_sources/output_folder.rst.txt @@ -15,4 +15,4 @@ Then after running **pymm**, one could modify the generated OpenFOAM related fil run directly the simulations calling the OpenFOAM solvers, e.g., to change additional tolerances that are not currently included in the parameters.toml file and/or to change the numerical schemes (see the OpenFOAM documentation -`here `_). \ No newline at end of file +`here `_). diff --git a/docs/_sources/related.rst.txt b/docs/_sources/related.rst.txt index 68ab30e..0f17f95 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 `_. + ****** pycopm ****** @@ -55,4 +63,4 @@ ad-micp .. image:: ./figs/ad-micp.gif :scale: 40% -`A module to study CO2 leakage remediation by microbially induced calcite precipitation (MICP) `_. \ No newline at end of file +`A module to study CO2 leakage remediation by microbially induced calcite precipitation (MICP) `_. diff --git a/docs/about.html b/docs/about.html index 628388d..92b559d 100644 --- a/docs/about.html +++ b/docs/about.html @@ -84,8 +84,8 @@

About pymm_images/pymm_logo.png

The image-based Python package for computational fluid dynamics pymm is funded by -Center for Sustainable Subsurface Resources [project no. 331841] and NORCE Norwegian -Research Centre As [project number 101070].

+Center for Sustainable Subsurface Resources [project no. 331841] and NORCE +Research As [project number 101070].

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

For a new feature, please request this raising an issue.

diff --git a/docs/contributing.html b/docs/contributing.html index c800360..e582524 100644 --- a/docs/contributing.html +++ b/docs/contributing.html @@ -115,7 +115,7 @@

Contribute to the software

Tip

-

See the CI.yml script and the Actions for installation of pymm, as well as the execution of the six previous steps in Ubuntu 24.10.

+

See the CI.yml script and the Actions for installation of pymm, as well as the execution of the six previous steps in Ubuntu 24.04.

diff --git a/docs/index.html b/docs/index.html index 576f06a..0f4061a 100644 --- a/docs/index.html +++ b/docs/index.html @@ -128,6 +128,7 @@

Welcome to pymm’s documentation!Related