PAGenT-v0.3.0-alpha

PAGenT v0.3.0‑alpha (2025‑04‑22)

Note: The core fractal‐aggregation engine remains under active development; this release delivers a fully functional image‑mask & noise pipeline and GUI front‑end.

✨ New Features

• Command‑Line Pipeline (image_mask_generation/pipeline.py):

  • Parse XML clusters into data.csv
  • Generate 1‑bit particle and cluster masks (1024×1024 px)
  • Render base cluster images and apply selectable noise:
    • Gaussian (gauss), Poisson (poisson), Combined (combined), TEM‐style background (tem)
  • Full CLI flags for --mask_type, --noise_types, --tem_style, --tem_mean, --tem_std, --tem_color

• PyQt5 GUI (image_mask_generation/gui.py):

  • Browse working directory & XML folder (defaults to <wd>/xmls/)
  • File name filters, Particle/Cluster mask toggles
  • Multi‐select noise options with spinboxes for TEM mean/std
  • RGBA color picker (with alpha) for TEM overlay
  • Light/Dark theme switch
  • Threaded execution with live log panel and completion status

• Documentation:

  • Updated README with installation steps, CLI examples, GUI screenshots, and configuration reference.

---

v0.2.0

PAGenT: Particle Aggregate Generator Tool

PAGenT is a simple, tunable Python tool for generating fractal particle aggregates. It leverages Particle Cluster and Cluster-Cluster aggregation algorithms to create customizable fractal structures with adjustable parameters such as particle radii, radius of gyration, and fractal dimension.

Method

PAGenT implements the aggregation method described in:

Morán, J., Fuentes, A., Liu, F., & Yon, J. (2019). FracVAL: An improved tunable algorithm of cluster–cluster aggregation for generation of fractal structures formed by polydisperse primary particles. Comput. Phys. Commun., 239, 225–237. doi: 10.1016/j.cpc.2019.01.015

This algorithm allows for the generation of fractal aggregates formed by polydisperse primary particles, making it ideal for various computational physics and simulation applications.

Usage

Get started with PAGenT by following these steps:

1. Clone the repository:

   git clone git@github.com:comp-comb/PAGenT.git

2. Navigate to the repository directory:

   cd PAGenT

3. Run the tool:

   python PAGenT.py

Current Status

Note: This is an initial, untested release. Contributions, bug reports, and feedback are highly appreciated!

Acknowledgment

This work was supported by the National Science Foundation under Grant No. 2144290. The opinions, findings, and conclusions or recommendations expressed herein are those of the author(s) and do not necessarily reflect the views of the National Science Foundation.

Contributing

Contributions to enhance PAGenT's functionality, performance, and usability are welcome. Please feel free to open an issue or submit a pull request with your suggestions and improvements.

v0.1.0-alpha (pre-release)

This is an initial release with limited functionalities.