March 25, 2026 Software Open Access

Schlegel, Fabian; Fombonne, Clement; Hänsch, Susann; Krull, Benjamin; Lehnigk, Ronald; Meller, Richard

JSON-LD (schema.org) Export

{
  "name": "Multiphase Python Repository by HZDR", 
  "inLanguage": {
    "alternateName": "eng", 
    "@type": "Language", 
    "name": "English"
  }, 
  "datePublished": "2026-03-25", 
  "keywords": [
    "Python", 
    "Numerical Simulations", 
    "Post-Processing", 
    "Gitlab"
  ], 
  "description": "<p>The <code>multiphasepy</code> package is a Python toolkit for building, running, and maintaining CFD simulation case collections for the software released by the OpenFOAM Foundation (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.</p> <p>At its core, <code>multiphasepy</code> 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 both on workstations and Slurm-based HPC systems. Using a container-based software environment (e.g. Apptainer or Docker) the case collection becomes fully portable. An integrated Copier template allows the creation and maintenance of multiple independent case collections.</p> <p>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.</p> Command-Line Tools <p>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 <code>mpy&lt;function&gt;</code> and provide <code>--help</code> for detailed usage information.</p> Workflow Management <ul> <li><strong>mpycopy</strong> : Copy and render templated cases</li> <li><strong>mpydocker</strong> : Launch customizable Docker development environments</li> <li><strong>mpywatch</strong> : Progress display and real-time data visualization</li> <li><strong>mpyworkflow</strong> : Create and manage cases projects allowing batch processing</li> </ul> Data Processing <ul> <li><strong>mpyconv</strong> : Convert data files between formats</li> <li><strong>mpypost</strong> : Mathematical post-processing operations</li> <li><strong>mpyvisualize</strong> : Visualize simulation result files</li> </ul> Quality Assurance <ul> <li><strong>mpytest</strong> : Run CFD code functionality tests</li> <li><strong>mpyfuzzy</strong> : Evaluate simulation goodness using fuzzy logic</li> <li><strong>mpyhooks</strong> : Run git hooks for code quality checks</li> </ul> Utilities <ul> <li><strong>mpyidentify</strong> : Identify file types and associate tags</li> <li><strong>mpyrpcmp</strong> : Compare two repositories (file-based)</li> <li><strong>mpyrpdiff</strong> : Compare repositories using git diff</li> <li><strong>mpyshrun</strong> : Wrap shell commands with logging</li> </ul> Publishing <ul> <li><strong>mpypublish</strong> : Publish software to Rodare repository</li> </ul> Installation <p>The <code>multiphasepy</code> package requires Python 3.12 or newer.</p> <p>Install the latest release from PyPI:</p> <pre><code class=\"language-bash\">pip install -i https://test.pypi.org/simple/ multiphasepy </code></pre> <p>For full environment setup and platform-specific notes, see the installation guide in the documentation.</p> How to cite us? <p>If you find that package useful, please cite as</p> <pre><code class=\"language-text\">Schlegel et al. (2026). Multiphase Python Repository by HZDR. Rodare. &lt;https://doi.org/10.14278/rodare.3093&gt;. </code></pre> Acknowledgements <p>OpenFOAM\u00ae is a registered trade mark of OpenCFD Limited, producer and distributor of the OpenFOAM\u00ae software via www.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.</p>", 
  "@context": "https://schema.org/", 
  "url": "https://rodare.hzdr.de/record/4576", 
  "license": "https://opensource.org/licenses/GPL-3.0", 
  "sameAs": [
    "https://www.hzdr.de/publications/Publ-39434"
  ], 
  "@type": "SoftwareSourceCode", 
  "creator": [
    {
      "@id": "https://orcid.org/0000-0003-3824-9568", 
      "affiliation": "Helmholtz-Zentrum Dresden - Rossendorf e.V.", 
      "@type": "Person", 
      "name": "Schlegel, Fabian"
    }, 
    {
      "affiliation": "Framatome S.A.S.", 
      "@type": "Person", 
      "name": "Fombonne, Clement"
    }, 
    {
      "@id": "https://orcid.org/0000-0003-1296-5566", 
      "affiliation": "Helmholtz-Zentrum Dresden - Rossendorf e.V.", 
      "@type": "Person", 
      "name": "H\u00e4nsch, Susann"
    }, 
    {
      "@id": "https://orcid.org/0000-0002-5394-0384", 
      "affiliation": "Helmholtz-Zentrum Dresden - Rossendorf e.V.", 
      "@type": "Person", 
      "name": "Krull, Benjamin"
    }, 
    {
      "@id": "https://orcid.org/0000-0002-5408-7370", 
      "affiliation": "Helmholtz-Zentrum Dresden - Rossendorf e.V.", 
      "@type": "Person", 
      "name": "Lehnigk, Ronald"
    }, 
    {
      "@id": "https://orcid.org/0000-0002-3801-2555", 
      "affiliation": "Helmholtz-Zentrum Dresden - Rossendorf e.V.", 
      "@type": "Person", 
      "name": "Meller, Richard"
    }
  ], 
  "identifier": "https://doi.org/10.14278/rodare.4576", 
  "@id": "https://doi.org/10.14278/rodare.4576", 
  "version": "3.0.5"
}