pyFracAggregate
  • Background
  • Installation
  • Generating aggregates
  • Analyzing aggregates
  • Exporting data
  • Tutorial: basic usage
  • API Reference
  • Architecture
  • Contributing
pyFracAggregate
  • pyFracAggregate
  • View page source

pyFracAggregate

A Python library for generating synthetic fractal aggregates (soot-like, aerosol-like) with tunable morphology, unified across four classical generation algorithms.

  • Background
    • Why generate fractal aggregates
    • Morphology parameters
    • Counting versus mass measure
    • Primary particles
    • Two algorithmic families
    • The coordinate system
    • Placement strategies
    • Choosing a method
    • References
  • Installation
    • Requirements
    • Install from PyPI
    • Install from source
    • Verify the installation
  • Generating aggregates
    • Parameters
    • The coordinate system
    • The scaling axis
    • Particle size distributions
    • Overlap tolerance
    • Placement strategy
    • Working with the Aggregate
    • Factory function or generator classes
    • Reproducibility and seeding
  • Analyzing aggregates
    • Interpreting df_num_est, df_mass_est and the r2 fields
    • Individual functions
    • Units
  • Exporting data
    • YAML snapshot
    • VTK point cloud
    • VTM MultiBlock
    • Rendered image
    • Rotation video
    • Viewing VTK/VTM in ParaView
  • Tutorial: basic usage
    • Part 1 — monodisperse PCA aggregate
    • Part 2 — polydisperse FracVAL-coordinate aggregate
    • Where to go next
  • API Reference
    • Top-level API
    • Core
    • Generators
    • Analysis
    • I/O
    • Placement
  • Architecture
    • How a generate() call flows
    • The Aggregate data structure
    • The generator contract
    • Scaling and placement: the division of labor
    • The placement strategy layer
    • Analysis
    • I/O
    • Tests
  • Contributing
    • Development setup
    • Running the tests
    • Lint and type checks
    • Building the documentation
    • Pull request expectations
Next

© Copyright 2026, Fan Zhang.

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