multiphasepy 4.0.0__tar.gz

multiphasepy-4.0.0/.gitignore

@@ -0,0 +1,201 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python
+# Edit at https://www.toptal.com/developers/gitignore?templates=python
+
+### macOS ###
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Project specific files ###
+docs/modules.rst
+docs/multiphasepy.rst
+docs/multiphasepy.*.rst
+docs/_build
+**/_version.py
+tests/data/**/postProcessing/**/fuzzy
+tests/data/case/jinja2/case.yml
+megalinter-reports
+report.xml
+flask
+
+# Apptainer files
+*.sif
+*.def
+
+# VS Code
+**/.vscode
+*.code-workspace
+.history/
+.history
+.ionide
+.devcontainer.json
+
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json

multiphasepy-4.0.0/PKG-INFO

@@ -0,0 +1,172 @@
+Metadata-Version: 2.4
+Name: multiphasepy
+Version: 4.0.0
+Summary: Toolkit for reproducible multiphase CFD workflows.
+Project-URL: Documentation, https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/
+Project-URL: Repository, https://codebase.helmholtz.cloud/fwdc/public/python.git
+Project-URL: Issues, https://codebase.helmholtz.cloud/fwdc/public/python/-/issues
+Project-URL: Changelog, https://codebase.helmholtz.cloud/fwdc/public/python/-/blob/main/CHANGELOG.md
+Project-URL: DOI, https://doi.org/10.14278/rodare.3093
+Project-URL: HELMHOLTZ-Software, https://helmholtz.software/software/multiphase-python-repository-by-hzdr
+Author-email: "Members of the Department of Computational Fluid Dynamics at Helmholtz-Zentrum Dresden-Rossendorf e.V. (HZDR)" <f.schlegel@hzdr.de>
+Maintainer-email: "Schlegel, Fabian" <f.schlegel@hzdr.de>, "Fombonne, Clement" <clement.fombonne@framatome.com>, "Hänsch, Susann" <s.haensch@hzdr.de>, "Krull, Benjamin" <b.krull@hzdr.de>, "Lehnigk, Ronald" <r.lehnigk@hzdr.de>, "Meller, Richard" <r.meller@hzdr.de>
+License: GPL-3.0-or-later
+Keywords: Gitlab,Numerical Simulations,Post-Processing,Python
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.12
+Requires-Dist: astropy>=6.1.3
+Requires-Dist: copier>=9.2.0
+Requires-Dist: dask>=2025.5.1
+Requires-Dist: fabric>=3.2.2
+Requires-Dist: gitpython>=3.1.45
+Requires-Dist: identify>=2.6.12
+Requires-Dist: jinja2>=3.1.2
+Requires-Dist: markdown>=3.6
+Requires-Dist: matplotlib>=3.10.8
+Requires-Dist: mistune>=3.0.2
+Requires-Dist: numpy<2.5.0,>=1.21.5
+Requires-Dist: paramiko>=3.5.1
+Requires-Dist: pygments==2.20.0
+Requires-Dist: pyvista>=0.46.4
+Requires-Dist: pyyaml==6.0.3
+Requires-Dist: requests>=2.32.3
+Requires-Dist: rich-argparse>=1.4.0
+Requires-Dist: rich-click>=1.9.5
+Requires-Dist: scikit-fuzzy>=0.5.0
+Requires-Dist: scipy>=1.8.0
+Requires-Dist: snakemake-executor-plugin-cluster-generic==1.0.9
+Requires-Dist: snakemake==9.5.0
+Requires-Dist: watchdog>=3.0.0
+Provides-Extra: dev
+Requires-Dist: black; extra == 'dev'
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: myst-parser; extra == 'dev'
+Requires-Dist: pre-commit>=3.8.0; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: requests-mock; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: sphinx; extra == 'dev'
+Requires-Dist: sphinx-rtd-theme; extra == 'dev'
+Requires-Dist: tox>=4.19; extra == 'dev'
+Requires-Dist: xvfbwrapper>=0.2.18; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Multiphase Python Repository by HZDR
+
+The `multiphasepy` package is a Python toolkit for building, running, and
+maintaining CFD simulation case collections for the software released by the
+[OpenFOAM Foundation](https://openfoam.org) (but also others, like Ansys Fluent
+or Siemens Simcenter Star-CCM). It combines reusable library modules with
+practical command-line tools to cover the full simulation lifecycle: case
+templating, batch execution, monitoring, post-processing, validation support,
+repository comparison, and publication workflows.
+
+At its core, `multiphasepy` helps teams move from individual case setups to
+scalable, structured projects containing a large collection of setups, e.g. a
+validation database. Cases can be provided as templates that are parameterized
+at runtime, metadata can be managed in a machine-readable way and cases can be
+conveniently batch-processed with the workflow management tool
+[Snakemake](https://snakemake.github.io/) both on workstations and
+[Slurm](https://slurm.schedmd.com/)-based HPC systems. Using a container-based
+software environment (e.g. [Apptainer](https://apptainer.org/) or
+[Docker](https://www.docker.com/)) the case collection becomes fully portable.
+An integrated [Copier](https://copier.readthedocs.io/) template allows the
+creation and maintenance of multiple independent case collections.
+
+Beyond execution, the package supports quality assurance and communication of
+results: tools are included for automated checks, fuzzy-logic based evaluation,
+data conversion, visualization, and generation of artifacts suitable for
+reporting and dissemination. This makes multiphasepy a practical bridge
+between day-to-day CFD case work and long-term, reproducible research software
+operations in collaborative environments.
+
+## Command-Line Tools
+
+The multiphasepy package provides a comprehensive suite of command-line tools
+for CFD workflow management, data processing, and quality assurance. All tools
+follow the naming convention `mpy<function>` and provide `--help` for detailed
+usage information.
+
+### Workflow Management
+
+- [**mpycopy**](https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/cli-tools/mpycopy.html)
+: Copy and render templated cases
+- [**mpydocker**](https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/cli-tools/mpycopy.html/cli-tools/mpydocker.html)
+: Launch customizable Docker development environments
+- [**mpywatch**](https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/cli-tools/mpywatch.html)
+: Progress display and real-time data visualization
+- [**mpyworkflow**](https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/cli-tools/mpyworkflow.html)
+: Create and manage cases projects allowing [batch processing](https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/batch-processing.html)
+
+### Data Processing
+
+- [**mpyconv**](https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/cli-tools/mpyconv.html)
+: Convert data files between formats
+- [**mpypost**](https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/cli-tools/mpypost.html)
+: Mathematical post-processing operations
+- [**mpyvisualize**](https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/cli-tools/mpyvisualize.html)
+: Visualize simulation result files
+
+### Quality Assurance
+
+- [**mpytest**](https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/cli-tools/mpytest.html)
+: Run CFD code functionality tests
+- [**mpyfuzzy**](https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/cli-tools/mpyfuzzy.html)
+: Evaluate simulation goodness using fuzzy logic
+- [**mpyhooks**](https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/cli-tools/mpyhooks.html)
+: Run git hooks for code quality checks
+
+### Utilities
+
+- [**mpyidentify**](https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/cli-tools/mpyidentify.html)
+: Identify file types and associate tags
+- [**mpyrpcmp**](https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/cli-tools/mpyrpcmp.html)
+: Compare two repositories (file-based)
+- [**mpyrpdiff**](https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/cli-tools/mpyrpdiff.html)
+: Compare repositories using git diff
+- [**mpyshrun**](https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/cli-tools/mpyshrun.html)
+: Wrap shell commands with logging
+
+### Publishing
+
+- [**mpypublish**](https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/cli-tools/mpypublish.html)
+: Publish software to Rodare repository
+
+## Installation
+
+The `multiphasepy` package requires Python 3.12 or newer.
+
+Install the latest release from PyPI:
+
+```bash
+pip install multiphasepy
+```
+
+For full environment setup and platform-specific notes, see the installation
+guide in the documentation.
+
+## How to cite us?
+
+If you find that package useful, please cite as
+
+```text
+Schlegel et al. (2026). Multiphase Python Repository by HZDR. Rodare.
+<https://doi.org/10.14278/rodare.3093>.
+```
+
+## Acknowledgements
+
+OpenFOAM® is a registered trade mark of OpenCFD Limited, producer and
+distributor of the OpenFOAM® software via
+[www.openfoam.com](https://openfoam.com). The Multiphase Python Repository by
+HZDR is not compatible with the software released by OpenCFD Limited, but is
+developed for the software released by the OpenFOAM Foundation via
+[www.openfoam.org](https://openfoam.org).

multiphasepy-4.0.0/README.md

@@ -0,0 +1,111 @@
+# Multiphase Python Repository by HZDR
+
+The `multiphasepy` package is a Python toolkit for building, running, and
+maintaining CFD simulation case collections for the software released by the
+[OpenFOAM Foundation](https://openfoam.org) (but also others, like Ansys Fluent
+or Siemens Simcenter Star-CCM). It combines reusable library modules with
+practical command-line tools to cover the full simulation lifecycle: case
+templating, batch execution, monitoring, post-processing, validation support,
+repository comparison, and publication workflows.
+
+At its core, `multiphasepy` helps teams move from individual case setups to
+scalable, structured projects containing a large collection of setups, e.g. a
+validation database. Cases can be provided as templates that are parameterized
+at runtime, metadata can be managed in a machine-readable way and cases can be
+conveniently batch-processed with the workflow management tool
+[Snakemake](https://snakemake.github.io/) both on workstations and
+[Slurm](https://slurm.schedmd.com/)-based HPC systems. Using a container-based
+software environment (e.g. [Apptainer](https://apptainer.org/) or
+[Docker](https://www.docker.com/)) the case collection becomes fully portable.
+An integrated [Copier](https://copier.readthedocs.io/) template allows the
+creation and maintenance of multiple independent case collections.
+
+Beyond execution, the package supports quality assurance and communication of
+results: tools are included for automated checks, fuzzy-logic based evaluation,
+data conversion, visualization, and generation of artifacts suitable for
+reporting and dissemination. This makes multiphasepy a practical bridge
+between day-to-day CFD case work and long-term, reproducible research software
+operations in collaborative environments.
+
+## Command-Line Tools
+
+The multiphasepy package provides a comprehensive suite of command-line tools
+for CFD workflow management, data processing, and quality assurance. All tools
+follow the naming convention `mpy<function>` and provide `--help` for detailed
+usage information.
+
+### Workflow Management
+
+- [**mpycopy**](https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/cli-tools/mpycopy.html)
+: Copy and render templated cases
+- [**mpydocker**](https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/cli-tools/mpycopy.html/cli-tools/mpydocker.html)
+: Launch customizable Docker development environments
+- [**mpywatch**](https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/cli-tools/mpywatch.html)
+: Progress display and real-time data visualization
+- [**mpyworkflow**](https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/cli-tools/mpyworkflow.html)
+: Create and manage cases projects allowing [batch processing](https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/batch-processing.html)
+
+### Data Processing
+
+- [**mpyconv**](https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/cli-tools/mpyconv.html)
+: Convert data files between formats
+- [**mpypost**](https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/cli-tools/mpypost.html)
+: Mathematical post-processing operations
+- [**mpyvisualize**](https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/cli-tools/mpyvisualize.html)
+: Visualize simulation result files
+
+### Quality Assurance
+
+- [**mpytest**](https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/cli-tools/mpytest.html)
+: Run CFD code functionality tests
+- [**mpyfuzzy**](https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/cli-tools/mpyfuzzy.html)
+: Evaluate simulation goodness using fuzzy logic
+- [**mpyhooks**](https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/cli-tools/mpyhooks.html)
+: Run git hooks for code quality checks
+
+### Utilities
+
+- [**mpyidentify**](https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/cli-tools/mpyidentify.html)
+: Identify file types and associate tags
+- [**mpyrpcmp**](https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/cli-tools/mpyrpcmp.html)
+: Compare two repositories (file-based)
+- [**mpyrpdiff**](https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/cli-tools/mpyrpdiff.html)
+: Compare repositories using git diff
+- [**mpyshrun**](https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/cli-tools/mpyshrun.html)
+: Wrap shell commands with logging
+
+### Publishing
+
+- [**mpypublish**](https://multiphase-python-repository-by-hzdr.readthedocs.io/en/latest/cli-tools/mpypublish.html)
+: Publish software to Rodare repository
+
+## Installation
+
+The `multiphasepy` package requires Python 3.12 or newer.
+
+Install the latest release from PyPI:
+
+```bash
+pip install multiphasepy
+```
+
+For full environment setup and platform-specific notes, see the installation
+guide in the documentation.
+
+## How to cite us?
+
+If you find that package useful, please cite as
+
+```text
+Schlegel et al. (2026). Multiphase Python Repository by HZDR. Rodare.
+<https://doi.org/10.14278/rodare.3093>.
+```
+
+## Acknowledgements
+
+OpenFOAM® is a registered trade mark of OpenCFD Limited, producer and
+distributor of the OpenFOAM® software via
+[www.openfoam.com](https://openfoam.com). The Multiphase Python Repository by
+HZDR is not compatible with the software released by OpenCFD Limited, but is
+developed for the software released by the OpenFOAM Foundation via
+[www.openfoam.org](https://openfoam.org).

multiphasepy-4.0.0/multiphasepy/__init__.py

@@ -0,0 +1,30 @@
+# Multiphase Python Repository by HZDR
+#
+# SPDX-FileCopyrightText: 2025 Helmholtz-Zentrum Dresden-Rossendorf e.V. (HZDR)
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+"""Mark this directory as multiphasepy Python package.
+
+Attributes:
+    pkgversion (str): Installed version of the package
+"""
+
+from importlib.metadata import version as get_installed_version
+
+from packaging.version import Version
+
+pkgversion = get_installed_version(str(__package__))
+
+
+def minimum_version(minversion: str):
+    """Check that the installed version meets the minimum required version.
+
+    Args:
+        minversion: Minimum required version.
+    """
+    if Version(pkgversion) < Version(minversion):
+        raise RuntimeError(
+            f"{__package__} >= {minversion} is required, "
+            f"but version {pkgversion} is installed."
+        )

multiphasepy-4.0.0/multiphasepy/assets/header_templates/c++_foundation.jinja

@@ -0,0 +1,30 @@
+/*--------------------------------{{file_type}}----------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     | Website:  https://openfoam.org
+    \\  /    A nd           | Copyright (C) {% for org in copyrightHolder %}{% if org.name == "OpenFOAM Foundation" %}{{- org.year -}}{% endif %}{% endfor %} OpenFOAM Foundation
+     \\/     M anipulation  |
+-------------------------------------------------------------------------------
+License
+    This file is part of OpenFOAM.
+
+    OpenFOAM is free software: you can redistribute it and/or modify it
+    under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
+    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+    for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
+
+{% for category, text in header.items() -%}
+{{ category }}
+    {{ text | wordwrap(76, wrapstring='\n    ', break_long_words=False)  | replace('\n    \n', '\n\n') }}
+
+{% endfor -%}
+\*---------------------------------------------------------------------------*/
+{# Keep a tailing new line to separate body from header #}

multiphasepy-4.0.0/multiphasepy/assets/header_templates/c++_hzdr.jinja

@@ -0,0 +1,46 @@
+/*--------------------------------{{file_type}}----------------------------------*\
+  ==  == ====== ====   ====    |
+                    \\     ||  | {{name | truncate(47, True, '...') }}
+  ======   //   ||  || ===//   | Website: {{url}}
+  ||  ||  //    ||  // || \\   | License: GPL-3.0-or-later
+  ==  == ====== ====   ==  ==  |
+-------------------------------------------------------------------------------
+License
+{%- filter wordwrap(76, wrapstring='\n    ', break_long_words=False) | replace('\n    \n', '\n\n') %}
+This file is part of the {{name}}.
+{% for org in copyrightHolder %}
+Copyright (C) {{ org.year }} by {{ org.name }}, Website: {{ org.url }}
+{% endfor %}
+{% filter replace('\n', ' ')-%}
+If you are interested in which files are original OpenFOAM Foundation files,
+which OpenFOAM Foundation files were modified, and which files were newly
+created, see FILES.md.
+{%- endfilter %}
+banana
+
+{% filter replace('\n', ' ')-%}
+{{name}} is free software: you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by the Free
+Software Foundation, either version 3 of the License, or (at your option) any
+later version.
+{%- endfilter %}
+
+{% filter replace('\n', ' ')-%}
+{{name}} is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+{%- endfilter %}
+
+{% filter replace('\n', ' ')-%}
+You should have received a copy of the GNU General Public License along with
+the {{name}}. If not, see <http://www.gnu.org/licenses/>.
+{%- endfilter %}
+{% endfilter %}
+
+{% for category, text in header.items() -%}
+{{ category }}
+    {{ text | wordwrap(76, wrapstring='\n    ', break_long_words=False) | replace('\n    \n', '\n\n') }}
+
+{% endfor -%}
+\*---------------------------------------------------------------------------*/
+{# Keep a tailing new line to separate body from header #}

multiphasepy-4.0.0/multiphasepy/assets/header_templates/config_openfoam_foundation.jinja

@@ -0,0 +1,17 @@
+/*--------------------------------{{file_type}}----------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     | Website:  https://openfoam.org
+    \\  /    A nd           | Version:  dev
+     \\/     M anipulation  |
+{% if header -%}
+{% for category, text in header.items() -%}
+{% if loop.first -%}
+-------------------------------------------------------------------------------
+{%- endif %}
+{{ category }}
+    {{ text | wordwrap(76, wrapstring='\n    ', break_long_words=False)  | replace('\n    \n', '\n\n') }}
+
+{% endfor %}
+{% endif -%}
+\*---------------------------------------------------------------------------*/

multiphasepy-4.0.0/multiphasepy/assets/header_templates/config_openfoam_hzdr.jinja

@@ -0,0 +1,17 @@
+/*--------------------------------{{file_type}}----------------------------------*\
+  ==  == ====== ====   ====    |
+                    \\     ||  | {{name | truncate(47, True, '...') }}
+  ======   //   ||  || ===//   | Website: {{url}}
+  ||  ||  //    ||  // || \\   | License: GPL-3.0-or-later
+  ==  == ====== ====   ==  ==  |
+{% if header -%}
+{% for category, text in header.items() -%}
+{% if loop.first -%}
+-------------------------------------------------------------------------------
+{%- endif %}
+{{ category }}
+    {{ text | wordwrap(76, wrapstring='\n    ', break_long_words=False)  | replace('\n    \n', '\n\n') }}
+
+{% endfor -%}
+{% endif -%}
+\*---------------------------------------------------------------------------*/

multiphasepy-4.0.0/multiphasepy/assets/header_templates/shell_foundation.jinja

@@ -0,0 +1,35 @@
+{% if shebang -%}
+{{ shebang }}
+#---------------------------------{{file_type}}------------------------------------
+{%- else -%}
+#---------------------------------{{file_type}}------------------------------------
+{%- endif %}
+# =========                 |
+# \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+#  \\    /   O peration     | Website:  https://openfoam.org
+#   \\  /    A nd           | Copyright (C) {% for org in copyrightHolder %}{% if org.name == "OpenFOAM Foundation" %}{{- org.year -}}{% endif %}{% endfor %} OpenFOAM Foundation
+#    \\/     M anipulation  |
+#------------------------------------------------------------------------------
+# License
+#     This file is part of OpenFOAM.
+#
+#     OpenFOAM is free software: you can redistribute it and/or modify it
+#     under the terms of the GNU General Public License as published by
+#     the Free Software Foundation, either version 3 of the License, or
+#     (at your option) any later version.
+#
+#     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
+#     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+#     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+#     for more details.
+#
+#     You should have received a copy of the GNU General Public License
+#     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
+#
+{% for category, text in header.items() -%}
+{{ category | indent(width='# ', first=True) }}
+#     {{ text | wordwrap(74, wrapstring='\n#     ', break_long_words=False) }}
+#
+{% endfor -%}
+#------------------------------------------------------------------------------
+{# Keep a tailing new line to separate body from header #}