API Reference

This section contains the complete API reference for ppMusicaa.

• ppModule package
  • Subpackages
  • Main Interface Module
• ppModule.binFiles package
  • Submodules
  • ppModule.binFiles.read_grid module
    • Classes:
    • ReadGrid
      • ReadGrid.directory
      • ReadGrid.read_grid()
  • ppModule.binFiles.read_snapshots module
    • Classes
    • ReadLines
      • ReadLines.read_line()
      • ReadLines.read_line_block()
      • ReadLines.read_line_block()
      • ReadLines.read_lines()
    • ReadPlanes
      • ReadPlanes.read_planes()
      • ReadPlanes.read_2d()
      • ReadPlanes.read_2d()
      • ReadPlanes.read_planes()
    • ReadPoints
      • ReadPoints.read_points()
      • ReadPoints.read_points_block()
    • ReadSnapshots
      • ReadSnapshots.process_snapshots()
      • ReadSnapshots._process_planes()
      • ReadSnapshots._process_lines()
      • ReadSnapshots._process_points()
      • ReadSnapshots._process_volumes()
      • ReadSnapshots.process_lines()
      • ReadSnapshots.process_planes()
      • ReadSnapshots.process_points()
      • ReadSnapshots.process_snapshots()
      • ReadSnapshots.process_volumes()
  • ppModule.binFiles.read_stats module
    • ReadStats
      • ReadStats.case
      • ReadStats.read_stats()
      • ReadStats.stats_orienter()
• ppModule.compute package
  • Submodules
  • ppModule.compute.compute_2d_curv module
• ppModule.iniFiles package
  • Submodules
  • ppModule.iniFiles.read_ini module
    • Classes:
    • FeosReader
      • FeosReader.is_valid_key()
      • FeosReader.read_feos()
    • InfoReader
      • InfoReader.get_value()
      • InfoReader.is_valid_key()
    • ParamBlockReader
      • ParamBlockReader.actions
      • ParamBlockReader.read_block_info()
      • ParamBlockReader.read_snapshots()
    • Reader
      • Reader.file_path
• ppModule.utils package
  • Submodules
  • ppModule.utils.preprocess_snapshots module
    • PreProcessLines
      • PreProcessLines.grid()
      • PreProcessLines.lines()
    • PreProcessPlanes
      • PreProcessPlanes.grid()
      • PreProcessPlanes.planes()
      • PreProcessPlanes.transpose_arrays_in_dict()
    • PreprocessPoints
      • PreprocessPoints.grid()
      • PreprocessPoints.points()
  • ppModule.utils.stats_reader module
    • StatsReader
      • StatsReader.stats_chan()
      • StatsReader.stats_stbl()
      • StatsReader.stats_turb()

Main Interface