ppMusicaa Documentation
Welcome to the ppMusicaa documentation! This package provides a Python interface for post-processing Musicaa simulation data.
API Reference
Overview
ppMusicaa is a post-processing module designed to read and analyze output from Musicaa CFD simulations. It provides:
Grid Reading: Support for 2D curvilinear and 3D grid formats
Statistics Processing: Read and analyze time-averaged flow statistics
Snapshot Analysis: Process instantaneous flow field data (planes, lines, points)
Boundary Layer Analysis: Compute derived quantities like boundary layer thickness, wall shear stress
Visualization Ready: Data structures optimized for matplotlib plotting
Quick Start
from ppModule.interface import PostProcessMusicaa
# Configure the interface
config = {
"directory": "/path/to/simulation/data",
"case": "my_simulation_case"
}
# Initialize the post-processor
pp = PostProcessMusicaa(config)
# Get statistics
stats = pp.return_stats()
# Process plane data for visualization
planes = pp.planes()
# Compute boundary layer quantities
delta = pp.compute_qty('delta')
Installation
Clone the repository:
git clone https://github.com/LouenasZm/ppMusicaa.git
Install dependencies:
pip install -r requirements.txt
Install the package:
pip install -e .