PuMA Documentation

Quick start:

• Porous Microstructure Analysis (PuMA)
  • System requirements
  • Installation
  • Running PuMA
  • Citing PuMA
  • Common errors and bug reporting
  • Contributing to PuMA
  • Authors
  • Legal / License

Tutorial:

• How to run the PuMA tutorial
• Welcome to the PuMA tutorial
• Installation setup and imports
• Python tutorials
• C++ examples

Python API:

• pumapy.filters
• pumapy.generation
• pumapy.io
• pumapy.materialproperties
• pumapy.physicsmodels
• pumapy.segmentation
• pumapy.utilities
• pumapy.visualization

C++ API:

• Namespace puma
  • Classes
  • Functions
  • Typedefs
• Namespace IterativeSolver
  • Functions