diff --git a/.gitignore b/.gitignore index 4fed339..08a415d 100644 --- a/.gitignore +++ b/.gitignore @@ -133,6 +133,7 @@ dmypy.json # Extra folders vpymm +cssr debugging developing tests/configs/files diff --git a/README.md b/README.md index 0e20120..ae5b93b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![Build Status](https://github.com/daavid00/pymm/actions/workflows/CI.yml/badge.svg)](https://github.com/daavid00/pymm/actions/workflows/CI.yml) +[![Build Status](https://github.com/cssr-tools/pymm/actions/workflows/CI.yml/badge.svg)](https://github.com/cssr-tools/pymm/actions/workflows/CI.yml) [![Code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black) [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) @@ -18,7 +18,7 @@ You will first need to install You will also need to install some Python packages, see ```requirements.txt``` for a complete list. You can install all the required Python packages in a virtual environment with the following commands: ```bash # Clone the repo -git clone https://github.com/daavid00/pymm.git +git clone https://github.com/cssr-tools/pymm.git # Get inside the folder cd pymm # Create virtual environment @@ -32,7 +32,7 @@ pip install -e . # For contributions/testing/linting, install the dev-requirements pip install -r dev-requirements.txt ``` -Depending on the location where OpenFOAM is installed, then before running pymm (inside the vpymm Python environment), you need to enter the OpenFoam environment: +Depending on the location where OpenFOAM is installed, then before running pymm (inside the vpymm Python environment), you need to enter the OpenFOAM environment: ```bash # Check where openFOAM is installed echo $WM_PROJECT_DIR @@ -51,7 +51,7 @@ pymm -i some_input_image.png -p some_input_parameters.txt -o some_output_folder Run `pymm --help` to see all possible command line argument options. Inside the `some_input_parameters.txt` file you provide the framework parameters such as the dimensions of the microsystem, mesh size, inlet pressure, and more. See the .txt files in the examples folder. ## Getting started -See the [_documentation_](https://daavid00.github.io/pymm/introduction.html). +See the [_documentation_](https://cssr-tools.github.io/pymm/introduction.html). ## Journal papers using pymm The following is a list of journal papers in which _pymm_ is used: diff --git a/docs/_images/contents.png b/docs/_images/contents.png index 8940416..c89bc0a 100644 Binary files a/docs/_images/contents.png and b/docs/_images/contents.png differ diff --git a/docs/_images/pyopmcsp11.gif b/docs/_images/pyopmspe11.gif similarity index 100% rename from docs/_images/pyopmcsp11.gif rename to docs/_images/pyopmspe11.gif diff --git a/docs/_sources/image.rst.txt b/docs/_sources/image.rst.txt index f5cc0fe..66bf1bb 100644 --- a/docs/_sources/image.rst.txt +++ b/docs/_sources/image.rst.txt @@ -5,7 +5,7 @@ Image In this example we consider the micromodel described in the :doc:`configuration file<./configuration_file>` section. -The image is available in the examples folder in the `Github page `_ +The image is available in the examples folder in the `Github page `_ with the default name 'microsystem.png'. The configuration file corresponds to the one in the :doc:`configuration file<./configuration_file>` section and it is saved as 'parameters.txt' (the default name for the configuration file). Since 'image' is the default entry for the simulation diff --git a/docs/_sources/introduction.rst.txt b/docs/_sources/introduction.rst.txt index ca89b6b..69fd42b 100644 --- a/docs/_sources/introduction.rst.txt +++ b/docs/_sources/introduction.rst.txt @@ -34,4 +34,4 @@ where Installation ------------ -See the `Github page `_. \ No newline at end of file +See the `Github page `_. \ No newline at end of file diff --git a/docs/_sources/related.rst.txt b/docs/_sources/related.rst.txt index a81e828..c7f2189 100644 --- a/docs/_sources/related.rst.txt +++ b/docs/_sources/related.rst.txt @@ -6,13 +6,13 @@ Below are some packages following the same configuration-file-to-postprocessing- check them out :). ********** -pyopmcsp11 +pyopmspe11 ********** -.. image:: ./figs/pyopmcsp11.gif +.. image:: ./figs/pyopmspe11.gif :scale: 50% -`A Python framework using OPM Flow for the CSP11 benchmark project `_. +`A Python framework using OPM Flow for the CSP SPE11 benchmark project `_. ************* pyopmnearwell diff --git a/docs/about.html b/docs/about.html index 617d164..a87f372 100644 --- a/docs/about.html +++ b/docs/about.html @@ -1,12 +1,14 @@ - + - + About pymm — pymm documentation - - + + + + @@ -96,7 +98,7 @@

About pymm -

© Copyright 2022-2023, NORCE Norwegian Research Centre AS.

+

© Copyright 2022-2024, NORCE Norwegian Research Centre AS.

Built with Sphinx using a diff --git a/docs/api.html b/docs/api.html index ad47d68..7ea315f 100644 --- a/docs/api.html +++ b/docs/api.html @@ -1,12 +1,14 @@ - + - + pymm Python API — pymm documentation - - + + + + @@ -126,7 +128,7 @@

pymm<
-

© Copyright 2022-2023, NORCE Norwegian Research Centre AS.

+

© Copyright 2022-2024, NORCE Norwegian Research Centre AS.

Built with Sphinx using a diff --git a/docs/configuration_file.html b/docs/configuration_file.html index fb454ca..696307a 100644 --- a/docs/configuration_file.html +++ b/docs/configuration_file.html @@ -1,12 +1,14 @@ - + - + Configuration file — pymm documentation - - + + + + @@ -206,7 +208,7 @@

Remaining parameters
-

© Copyright 2022-2023, NORCE Norwegian Research Centre AS.

+

© Copyright 2022-2024, NORCE Norwegian Research Centre AS.

Built with Sphinx using a diff --git a/docs/device.html b/docs/device.html index 3cc03fa..3d38d95 100644 --- a/docs/device.html +++ b/docs/device.html @@ -1,12 +1,14 @@ - + - + Device — pymm documentation - - + + + + @@ -109,7 +111,7 @@

Device<
-

© Copyright 2022-2023, NORCE Norwegian Research Centre AS.

+

© Copyright 2022-2024, NORCE Norwegian Research Centre AS.

Built with Sphinx using a diff --git a/docs/examples.html b/docs/examples.html index a02485a..7d7107d 100644 --- a/docs/examples.html +++ b/docs/examples.html @@ -1,12 +1,14 @@ - + - + Examples — pymm documentation - - + + + + @@ -89,7 +91,7 @@

Examples

Image

In this example we consider the micromodel described in the configuration file section.

-

The image is available in the examples folder in the Github page +

The image is available in the examples folder in the Github page with the default name ‘microsystem.png’. The configuration file corresponds to the one in the configuration file section and it is saved as ‘parameters.txt’ (the default name for the configuration file). Since ‘image’ is the default entry for the simulation @@ -199,7 +201,7 @@

Online<
-

© Copyright 2022-2023, NORCE Norwegian Research Centre AS.

+

© Copyright 2022-2024, NORCE Norwegian Research Centre AS.

Built with Sphinx using a diff --git a/docs/genindex.html b/docs/genindex.html index 881fdd7..7b920e5 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -1,11 +1,13 @@ - + Index — pymm documentation - - + + + + @@ -202,7 +204,7 @@

W

-

© Copyright 2022-2023, NORCE Norwegian Research Centre AS.

+

© Copyright 2022-2024, NORCE Norwegian Research Centre AS.

Built with Sphinx using a diff --git a/docs/image.html b/docs/image.html index 713556c..1196f9f 100644 --- a/docs/image.html +++ b/docs/image.html @@ -1,12 +1,14 @@ - + - + Image — pymm documentation - - + + + + @@ -80,7 +82,7 @@

Image

In this example we consider the micromodel described in the configuration file section.

-

The image is available in the examples folder in the Github page +

The image is available in the examples folder in the Github page with the default name ‘microsystem.png’. The configuration file corresponds to the one in the configuration file section and it is saved as ‘parameters.txt’ (the default name for the configuration file). Since ‘image’ is the default entry for the simulation @@ -113,7 +115,7 @@

Image
-

© Copyright 2022-2023, NORCE Norwegian Research Centre AS.

+

© Copyright 2022-2024, NORCE Norwegian Research Centre AS.

Built with Sphinx using a diff --git a/docs/index.html b/docs/index.html index 48c7c0d..0415263 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,12 +1,14 @@ - + - + Welcome to pymm’s documentation! — pymm documentation - - + + + + @@ -112,7 +114,7 @@

Welcome to pymm’s documentation!Output folder
  • Related