ppMusicaa

User Guide

  • Configuration Guide
    • Configuration Structure
      • Required Keys
      • Optional Keys
    • Configuration Examples
      • Basic Configuration
      • Complete Configuration
      • Configuration for Different Grid Types
        • 2D Curvilinear Grid (Extruded)
        • 3D Curvilinear Grid
    • File Structure Requirements
    • Configuration Validation
    • Next Steps
  • Usage Guide
    • Basic Usage
      • Initialization
    • Working with Statistics
      • Reading Statistics
      • Computing Derived Quantities
    • Working with Snapshots
      • Processing Plane Data
      • Processing Line Data
      • Processing Point Data
    • Advanced Usage
      • Working with Multiple Variables
      • Computing Statistics and Fluctuations
      • Error Handling
    • Performance Tips
  • Data Structures Reference
    • Statistics Data Structure
      • return_stats() Output
    • Computed Quantities Data Structure
      • compute_qty() Output
    • Plane Data Structure
      • planes() Output
    • Line Data Structure
      • lines() Output
    • Point Data Structure
      • points() Output
    • Grid Data Structure
    • Common Array Shapes
      • 2D Curvilinear Grid
      • Variable Naming Conventions

API Reference

  • API Reference
    • ppModule package
      • Subpackages
      • Main Interface Module
    • ppModule.binFiles package
      • Submodules
      • ppModule.binFiles.read_grid module
        • Classes:
        • ReadGrid
      • ppModule.binFiles.read_snapshots module
        • Classes
        • ReadLines
        • ReadPlanes
        • ReadPoints
        • ReadSnapshots
      • ppModule.binFiles.read_stats module
        • ReadStats
    • ppModule.compute package
      • Submodules
      • ppModule.compute.compute_2d_curv module
    • ppModule.iniFiles package
      • Submodules
      • ppModule.iniFiles.read_ini module
        • Classes:
        • FeosReader
        • InfoReader
        • ParamBlockReader
        • Reader
    • ppModule.utils package
      • Submodules
      • ppModule.utils.preprocess_snapshots module
        • PreProcessLines
        • PreProcessPlanes
        • PreprocessPoints
      • ppModule.utils.stats_reader module
        • StatsReader
    • Main Interface
ppMusicaa
  • Search

© Copyright .

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