How aoneillmark/capstone works
Main Components
• Simulation Engines & Modules: Your codebase contains multiple simulation scripts (e.g., VOTPP_[n-e]-(n).py, VOTPP_[n-e]-(e).py, VOTPP_class.py, and their revised versions). These encapsulate the core physics calculations using the Cluster Correlation Expansion method (PyCCE) and implement the analytical product rule.
– Convergence Data (e.g., Revised_VOTPP/Results_revised/Pickle_files/Convergence)
– Simulation Results (found under both Revised_VOTPP and VOTPP folder subdirectories)
– Fit and Post-processing Results (such as files in “Fits” directories)
• Plotting and Analysis Module: Several scripts are dedicated to plotting (plotter_script.py, VOTPP_results_and_fit_plotter.py, and visualization scripts in the Results/Plots_editing/ folder). This component represents the post-simulation analysis that interprets and visualizes the simulation outputs.
• Configuration and Input Files: Files like VOTPP_opt.Atens, VOTPP_opt.gtens, and .xyz files serve as configuration or input data (spin system configurations or material properties). This component should feed simulation modules with the necessary initial conditions.
Relationships and Interactions
• Data Flow: Begin with input data/configuration files feeding into the simulation modules. These, running under an MPI-managed environment, process the physics simulation and then output results as pickle files into the Data Storage component.
Architectural Patterns & Design Principles
• Data Pipeline Flow: Emphasize an end-to-end workflow from input configuration through simulation, storage, and analysis.
• Scalability: Note that the MPI-based design allows scaling to multiple cores/nodes and that the system is designed to run on large HPC clusters (e.g., Boyle cluster).
Technologies/Frameworks Highlight
• Python as the primary language.
• mpi4py for parallel processing.
• PyCCE for simulating the quantum dynamics.
• Pickle module for data storage.
• Plotting libraries (likely matplotlib or similar tools) for visualization.
Elements
– From “Input” to “Simulation Engine”
– From “Simulation Engine” to “Data Storage”
– From “Data Storage” to “Visualization & Analysis”