How hegoimanzano/pycsh works
Project Type and Purpose
• This is a standalone scientific‐computational Python application (“pyCSH”) for automated generation of realistic bulk calcium silicate hydrate structures.
• It reads user parameters, builds atomistic bricks from predefined block templates, assembles them into supercells, optionally validates and visualizes results, and writes output in multiple molecular‐simulation formats (LAMMPS, VASP, EricaFF).
Core Components
a. Command-Line Interface (CLI) / Entry Point
• File: main_brick.py
• Parses CLI flags and loads parameters.py
b. Parameter Manager
• File: parameters.py
c. Sampling Engine
• Module: mod_sample.py
• Computes random Ca/Si, Si–OH, Ca–OH distributions via Gaussian sampling
d. Brick Constructor
• Module: mod_construct_brick.py
• Reads block definitions from Blocks_Renamed/
• Generates individual unit‐cell bricks
e. Supercell Assembler
• Module: mod_construct_supercell.py
f. Validation / Checking
• Module: mod_check.py
• Optional “check” mode: verifies ratio distributions over many samples
g. Graph Generator
• Module: mod_make_graphs.py
• Produces diagnostic plots of distribution accuracy
h. Output Writer
• Module: mod_write.py
• Exports final structures as:
• LAMMPS .data
• LAMMPS+EricaFF .data
• VASP .vasp
Additional resource:
• Blocks_Renamed/ (data folder) containing block files (“<Lo”, “>Ro”, w15, etc.)
External Dependencies & Services
• Python 3 + NumPy (internal library)
• External simulators/readers: LAMMPS, EricaFF, VASP (consumers of the generated files)
Data Flow & Interactions
CLI → Parameter Manager → Sampling Engine → Brick Constructor → Supercell Assembler → [branch → Validation] → Graph Generator
↓
Output Writer → Filesystem → External Simulators
Architectural Patterns & Principles
• Pipeline pattern: each module performs a well‐defined transformation on the structure data.
• Data‐driven: block definitions are externalized in Blocks_Renamed/ for easy extensibility.
• Single Responsibility: each mod_*.py has a focused purpose.