Multiphase Python Repository by HZDR Logo

Contents:

  • Introduction
  • Installation
    • Prerequisites
    • Python Virtual Environment
      • Activate Environment
    • Install from PyPI
    • Install from Source
    • Optional Dependencies
  • Command-Line Tools
    • Available Tools
      • mpyconv
        • Supported Format Conversions
        • Usage
        • Examples
      • mpycopy
        • Usage
        • Examples
        • Template Structure
      • mpydocker
        • Usage
        • Configuration File
      • mpyfuzzy
        • Usage
        • Examples
        • Output
      • mpyhooks
        • Usage
        • Available Hooks
        • Pre-commit Integration
      • mpyidentify
        • Usage
        • Output Format
        • Recognized Additional File Types
        • Gitignore Support
        • Options
      • mpypost
        • Usage
        • Functions
      • mpypublish
        • Usage
        • Examples
      • mpyrpdiff
        • Usage
        • Examples
      • mpyshrun
        • Usage
        • Examples
      • mpytest
        • Usage
        • Functions
        • Examples
      • mpyvisualize
        • Usage
        • Commands
        • Examples
        • Supported File Formats
      • mpywatch
        • Usage
        • Show Progress at Command Line
        • Real-time Plots of Simulation Data
        • Real-time Courant Number Information
        • Offscreen Rendering
      • mpyworkflow
        • Usage
        • Subcommands
    • Autocompletion
    • Verbosity and Logging Options
  • Case Metadata Format
    • File Location
    • File Format
    • Schema
      • name
      • workflow
        • workflow.params
      • validation
      • keywords
  • Simulation batch-processing with Snakemake
    • Prerequisites
      • Installation
      • Case collection structure requirements
      • Simulation setup structure requirements
        • Regular setups
        • Template setups
    • Execution
      • Configuration
        • “What” to process
        • “How” to process
      • General command sequence (for local execution)
        • Quick start
        • Step by step
      • Remote execution on a Slurm HPC cluster
      • Background Execution using tmux
      • Debugging
      • Sending a custom command to all cases of a batch run

About:

  • Contribution Guide
    • Static Code Analysis (Linting)
    • Unit Testing
    • Integration Testing
    • Documentation
    • Copyright Information
  • Changelog
    • 4.2.0 (2026-06-01)
      • Bugfixes
      • Features
      • features
      • bugifx
    • 4.1.0 (2026-05-29)
      • Bugfixes
      • Features
      • Documentation
      • Miscellaneous
    • 4.0.0 (2026-04-22)
      • Features
      • Documentation
      • Testing and CI/CD
    • 3.1.3 (2026-04-16)
      • Documentation
      • Miscellaneous
    • 3.1.2 (2026-04-07)
      • Bugfixes
    • 3.1.1 (2026-04-07)
      • Bugfixes
    • 3.1.0 (2026-04-02)
      • Bugfixes
      • Features
    • 3.0.6 (2026-03-31)
      • Documentation
    • 3.0.5 (2026-03-25)
      • Bugfixes
    • 3.0.4 (2026-03-24)
      • Bugfixes
    • 3.0.3 (2026-03-23)
      • Documentation
    • 3.0.2 (2026-03-23)
      • Bugfixes
      • Documentation
    • 3.0.1 (2026-03-20)
      • Bugfixes
      • Features
      • Documentation
      • Testing and CI/CD
    • 2.12.0 (2026-03-04)
      • Bugfixes
      • Features
    • 2.11.0 (2026-02-23)
      • Features
      • Documentation
      • Testing and CI/CD
    • 2.10.1 (2026-02-16)
      • Bugfixes
    • 2.10.0 (2026-02-09)
      • Bugfixes
      • Features
      • Documentation
    • 2.9.0 (2026-01-23)
      • Bugfixes
      • Features
      • Documentation
    • 2.8.0 (2026-01-21)
      • Bugfixes
      • Features
      • Documentation
    • 2.7.0 (2026-01-15)
      • Features
    • 2.6.2 (2026-01-13)
      • Bugfixes
    • 2.6.1 (2026-01-13)
      • Bugfixes
    • 2.6.0 (2026-01-09)
      • Bugfixes
      • Features
      • Testing and CI/CD
    • 2.5.0 (2025-12-18)
      • Features
      • Testing and CI/CD
    • 2.4.0 (2025-12-08)
      • Documentation
    • 2.3.0 (2025-12-02)
      • Bugfixes
      • Features
    • 2.2.0 (2025-11-27)
      • Bugfixes
      • Features
    • 2.1.3 (2025-11-04)
      • Bugfixes
      • Features
      • Documentation
      • Testing and CI/CD
    • 2.1.2 (2025-10-17)
      • Bugfixes
    • 2.1.1 (2025-10-17)
      • Bugfixes
    • 2.1.0 (2025-10-17)
      • Features
    • 2.0.0 (2025-09-19)
      • Features
    • 1.10.0 (2025-08-12)
      • Bugfixes
      • Miscellaneous
    • 1.9.0 (2025-07-08)
      • Bugfixes
      • Features
    • 1.8.1 (2025-07-01)
      • Bugfixes
      • Features
    • 1.8.0 (2025-05-27)
      • Features
    • 1.7.3 (2025-05-26)
      • Bugfixes
    • 1.7.2 (2025-05-22)
      • Documentation
      • Features
    • 1.7.1 (2025-05-16)
      • Bugfixes
    • 1.7.0 (2025-05-12)
      • Features
      • Miscellaneous
      • Testing and CI/CD
    • 1.6.4 (2025-04-22)
      • Bugfixes
    • 1.6.3 (2025-04-22)
      • Bugfixes
      • Testing and CI/CD
    • 1.6.2 (2025-04-17)
      • Bugfixes
    • 1.6.1 (2025-04-17)
      • Bugfixes
    • 1.6.0 (2025-04-17)
      • Bugfixes
      • Documentation
      • Features
    • 1.5.0 (2025-03-19)
      • Bugfixes
      • Documentation
      • Features
    • 1.4.8 (2025-02-13)
      • Bugfixes
    • 1.4.7 (2025-02-12)
      • Bugfixes
    • 1.4.6 (2025-02-05)
      • Features
      • Testing and CI/CD
    • 1.4.5 (2025-01-15)
      • Bugfixes
      • Features
    • 1.4.4 (2025-01-10)
      • Features
    • 1.4.3 (2024-12-10)
      • Bugfixes
      • Deployment
    • 1.4.2 (2024-11-29)
      • Bugfixes
    • 1.4.1 (2024-11-05)
      • Bugfixes
      • Testing and CI/CD
    • 1.4.0 (2024-10-23)
      • Testing and CI/CD
      • Documentation
      • Features
    • 1.3.1 (2024-10-10)
      • Bugfixes
    • 1.3.0 (2024-10-09)
      • Features
      • Bugfix
    • 1.2.0 (2024-10-02)
      • Testing and CI/CD
      • Features
    • 1.1.3 (2024-09-26)
      • Documentation
    • 1.1.2 (2024-09-24)
      • Bugfixes
      • Documentation
      • Deployment
    • 1.1.1 (2024-09-17)
      • Bugfixes
      • Deployment
    • 1.1.0 (2024-09-17)
      • Bugfixes
      • Testing and CI/CD
      • Miscellaneous
    • 1.0.1 (2024-08-16)
      • Testing and CI/CD
      • Features
      • Deployment
    • 1.0.0 (2024-08-15)
      • Testing and CI/CD
      • Features
    • 0.12.0 (2024-08-02)
      • Bugfixes
      • Documentation
      • Features
    • 0.11.1 (2024-07-24)
      • Bugfixes
      • Miscellaneous
    • 0.11.0 (2024-07-19)
      • Testing and CI/CD
      • Features
      • Deployment
    • 0.10.3 (2024-07-16)
      • Bugfixes
    • 0.10.2 (2024-07-16)
      • Bugfixes
    • 0.10.1 (2024-07-16)
      • Bugfixes
      • Documentation
      • Miscellaneous
    • 0.10.0 (2024-07-13)
      • Documentation
      • Miscellaneous
      • Deployment
      • Testing and CI/CD
      • Features
  • License
Multiphase Python Repository by HZDR
  • Search

© Copyright Department of Computational Fluid Dynamics, Helmholtz-Zentrum Dresden-Rossendorf e.V. (HZDR), Bautzner Landstraße 400, 01328 Dresden, Germany.

Built with Sphinx using a theme provided by Read the Docs.