There is a newer version of this record available.

Software Open Access

Multiphase Python Repository by HZDR

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


DCAT Export

<?xml version='1.0' encoding='utf-8'?>
<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:adms="http://www.w3.org/ns/adms#" xmlns:cnt="http://www.w3.org/2011/content#" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:dct="http://purl.org/dc/terms/" xmlns:dctype="http://purl.org/dc/dcmitype/" xmlns:dcat="http://www.w3.org/ns/dcat#" xmlns:duv="http://www.w3.org/ns/duv#" xmlns:foaf="http://xmlns.com/foaf/0.1/" xmlns:frapo="http://purl.org/cerif/frapo/" xmlns:geo="http://www.w3.org/2003/01/geo/wgs84_pos#" xmlns:gsp="http://www.opengis.net/ont/geosparql#" xmlns:locn="http://www.w3.org/ns/locn#" xmlns:org="http://www.w3.org/ns/org#" xmlns:owl="http://www.w3.org/2002/07/owl#" xmlns:prov="http://www.w3.org/ns/prov#" xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#" xmlns:schema="http://schema.org/" xmlns:skos="http://www.w3.org/2004/02/skos/core#" xmlns:vcard="http://www.w3.org/2006/vcard/ns#" xmlns:wdrs="http://www.w3.org/2007/05/powder-s#">
  <rdf:Description rdf:about="https://doi.org/10.14278/rodare.4566">
    <rdf:type rdf:resource="http://www.w3.org/ns/dcat#Dataset"/>
    <dct:type rdf:resource="http://purl.org/dc/dcmitype/Software"/>
    <dct:identifier rdf:datatype="http://www.w3.org/2001/XMLSchema#anyURI">https://doi.org/10.14278/rodare.4566</dct:identifier>
    <foaf:page rdf:resource="https://doi.org/10.14278/rodare.4566"/>
    <dct:creator>
      <rdf:Description rdf:about="http://orcid.org/0000-0003-3824-9568">
        <rdf:type rdf:resource="http://xmlns.com/foaf/0.1/Agent"/>
        <foaf:name>Schlegel, Fabian</foaf:name>
        <foaf:givenName>Fabian</foaf:givenName>
        <foaf:familyName>Schlegel</foaf:familyName>
        <org:memberOf>
          <foaf:Organization>
            <foaf:name>Helmholtz-Zentrum Dresden - Rossendorf e.V.</foaf:name>
          </foaf:Organization>
        </org:memberOf>
      </rdf:Description>
    </dct:creator>
    <dct:creator>
      <rdf:Description>
        <rdf:type rdf:resource="http://xmlns.com/foaf/0.1/Agent"/>
        <foaf:name>Fombonne, Clement</foaf:name>
        <foaf:givenName>Clement</foaf:givenName>
        <foaf:familyName>Fombonne</foaf:familyName>
        <org:memberOf>
          <foaf:Organization>
            <foaf:name>Framatome S.A.S.</foaf:name>
          </foaf:Organization>
        </org:memberOf>
      </rdf:Description>
    </dct:creator>
    <dct:creator>
      <rdf:Description rdf:about="http://orcid.org/0000-0003-1296-5566">
        <rdf:type rdf:resource="http://xmlns.com/foaf/0.1/Agent"/>
        <foaf:name>Hänsch, Susann</foaf:name>
        <foaf:givenName>Susann</foaf:givenName>
        <foaf:familyName>Hänsch</foaf:familyName>
        <org:memberOf>
          <foaf:Organization>
            <foaf:name>Helmholtz-Zentrum Dresden - Rossendorf e.V.</foaf:name>
          </foaf:Organization>
        </org:memberOf>
      </rdf:Description>
    </dct:creator>
    <dct:creator>
      <rdf:Description rdf:about="http://orcid.org/0000-0002-5394-0384">
        <rdf:type rdf:resource="http://xmlns.com/foaf/0.1/Agent"/>
        <foaf:name>Krull, Benjamin</foaf:name>
        <foaf:givenName>Benjamin</foaf:givenName>
        <foaf:familyName>Krull</foaf:familyName>
        <org:memberOf>
          <foaf:Organization>
            <foaf:name>Helmholtz-Zentrum Dresden - Rossendorf e.V.</foaf:name>
          </foaf:Organization>
        </org:memberOf>
      </rdf:Description>
    </dct:creator>
    <dct:creator>
      <rdf:Description rdf:about="http://orcid.org/0000-0002-5408-7370">
        <rdf:type rdf:resource="http://xmlns.com/foaf/0.1/Agent"/>
        <foaf:name>Lehnigk, Ronald</foaf:name>
        <foaf:givenName>Ronald</foaf:givenName>
        <foaf:familyName>Lehnigk</foaf:familyName>
        <org:memberOf>
          <foaf:Organization>
            <foaf:name>Helmholtz-Zentrum Dresden - Rossendorf e.V.</foaf:name>
          </foaf:Organization>
        </org:memberOf>
      </rdf:Description>
    </dct:creator>
    <dct:creator>
      <rdf:Description rdf:about="http://orcid.org/0000-0002-3801-2555">
        <rdf:type rdf:resource="http://xmlns.com/foaf/0.1/Agent"/>
        <foaf:name>Meller, Richard</foaf:name>
        <foaf:givenName>Richard</foaf:givenName>
        <foaf:familyName>Meller</foaf:familyName>
        <org:memberOf>
          <foaf:Organization>
            <foaf:name>Helmholtz-Zentrum Dresden - Rossendorf e.V.</foaf:name>
          </foaf:Organization>
        </org:memberOf>
      </rdf:Description>
    </dct:creator>
    <dct:title>Multiphase Python Repository by HZDR</dct:title>
    <dct:publisher>
      <foaf:Agent>
        <foaf:name>Rodare</foaf:name>
      </foaf:Agent>
    </dct:publisher>
    <dct:issued rdf:datatype="http://www.w3.org/2001/XMLSchema#gYear">2026</dct:issued>
    <dcat:keyword>Python</dcat:keyword>
    <dcat:keyword>Numerical Simulations</dcat:keyword>
    <dcat:keyword>Post-Processing</dcat:keyword>
    <dcat:keyword>Gitlab</dcat:keyword>
    <dct:issued rdf:datatype="http://www.w3.org/2001/XMLSchema#date">2026-03-20</dct:issued>
    <dct:language rdf:resource="http://publications.europa.eu/resource/authority/language/ENG"/>
    <owl:sameAs rdf:resource="https://rodare.hzdr.de/record/4566"/>
    <adms:identifier>
      <adms:Identifier>
        <skos:notation rdf:datatype="http://www.w3.org/2001/XMLSchema#anyURI">https://rodare.hzdr.de/record/4566</skos:notation>
      </adms:Identifier>
    </adms:identifier>
    <owl:sameAs rdf:resource="https://www.hzdr.de/publications/Publ-39434"/>
    <dct:isVersionOf rdf:resource="https://doi.org/10.14278/rodare.3093"/>
    <dct:isPartOf rdf:resource="https://rodare.hzdr.de/communities/rodare"/>
    <owl:versionInfo>3.0.1</owl:versionInfo>
    <dct:description>&lt;p&gt;The &lt;code&gt;multiphasepy&lt;/code&gt; 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.&lt;/p&gt; &lt;p&gt;At its core, &lt;code&gt;multiphasepy&lt;/code&gt; 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.&lt;/p&gt; &lt;p&gt;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.&lt;/p&gt; Command-Line Tools &lt;p&gt;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 &lt;code&gt;mpy&amp;lt;function&amp;gt;&lt;/code&gt; and provide &lt;code&gt;--help&lt;/code&gt; for detailed usage information.&lt;/p&gt; Workflow Management &lt;ul&gt; &lt;li&gt;&lt;strong&gt;mpycopy&lt;/strong&gt; : Copy and render templated cases&lt;/li&gt; &lt;li&gt;&lt;strong&gt;mpydocker&lt;/strong&gt; : Launch customizable Docker development environments&lt;/li&gt; &lt;li&gt;&lt;strong&gt;mpywatch&lt;/strong&gt; : Progress display and real-time data visualization&lt;/li&gt; &lt;li&gt;&lt;strong&gt;mpyworkflow&lt;/strong&gt; : Create and manage cases projects allowing batch processing&lt;/li&gt; &lt;/ul&gt; Data Processing &lt;ul&gt; &lt;li&gt;&lt;strong&gt;mpyconv&lt;/strong&gt; : Convert data files between formats&lt;/li&gt; &lt;li&gt;&lt;strong&gt;mpypost&lt;/strong&gt; : Mathematical post-processing operations&lt;/li&gt; &lt;li&gt;&lt;strong&gt;mpyvisualize&lt;/strong&gt; : Visualize simulation result files&lt;/li&gt; &lt;/ul&gt; Quality Assurance &lt;ul&gt; &lt;li&gt;&lt;strong&gt;mpytest&lt;/strong&gt; : Run CFD code functionality tests&lt;/li&gt; &lt;li&gt;&lt;strong&gt;mpyfuzzy&lt;/strong&gt; : Evaluate simulation goodness using fuzzy logic&lt;/li&gt; &lt;li&gt;&lt;strong&gt;mpyhooks&lt;/strong&gt; : Run git hooks for code quality checks&lt;/li&gt; &lt;/ul&gt; Utilities &lt;ul&gt; &lt;li&gt;&lt;strong&gt;mpyidentify&lt;/strong&gt; : Identify file types and associate tags&lt;/li&gt; &lt;li&gt;&lt;strong&gt;mpyrpcmp&lt;/strong&gt; : Compare two repositories (file-based)&lt;/li&gt; &lt;li&gt;&lt;strong&gt;mpyrpdiff&lt;/strong&gt; : Compare repositories using git diff&lt;/li&gt; &lt;li&gt;&lt;strong&gt;mpyshrun&lt;/strong&gt; : Wrap shell commands with logging&lt;/li&gt; &lt;/ul&gt; Publishing &lt;ul&gt; &lt;li&gt;&lt;strong&gt;mpypublish&lt;/strong&gt; : Publish software to Rodare repository&lt;/li&gt; &lt;/ul&gt; Installation &lt;p&gt;The &lt;code&gt;multiphasepy&lt;/code&gt; package requires Python 3.12 or newer.&lt;/p&gt; &lt;p&gt;Install the latest release from Gitlab PyPI:&lt;/p&gt; &lt;pre&gt;&lt;code class="language-bash"&gt;python -m pip install multiphasepy --extra-index-url https://codebase.helmholtz.cloud/api/v4/projects/8786/packages/pypi/simple &lt;/code&gt;&lt;/pre&gt; &lt;p&gt;For full environment setup and platform-specific notes, see the installation guide in the documentation.&lt;/p&gt; Acknowledgements &lt;p&gt;OpenFOAM® is a registered trade mark of OpenCFD Limited, producer and distributor of the OpenFOAM® software via &amp;lt;www.openfoam.com&amp;gt;. 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 &amp;lt;www.openfoam.org&amp;gt;.&lt;/p&gt;</dct:description>
    <dct:accessRights rdf:resource="http://publications.europa.eu/resource/authority/access-right/PUBLIC"/>
    <dct:accessRights>
      <dct:RightsStatement rdf:about="info:eu-repo/semantics/openAccess">
        <rdfs:label>Open Access</rdfs:label>
      </dct:RightsStatement>
    </dct:accessRights>
    <dcat:distribution>
      <dcat:Distribution>
        <dct:rights>
          <dct:RightsStatement rdf:about="https://opensource.org/licenses/GPL-3.0">
            <rdfs:label>GNU General Public License v3.0 or later</rdfs:label>
          </dct:RightsStatement>
        </dct:rights>
        <dcat:accessURL rdf:resource="https://doi.org/10.14278/rodare.4566"/>
      </dcat:Distribution>
    </dcat:distribution>
  </rdf:Description>
</rdf:RDF>
17,231
4,885
views
downloads
All versions This version
Views 17,23163
Downloads 4,88515
Data volume 137.0 MB787.6 kB
Unique views 12,49560
Unique downloads 4,40313

Share

Cite as