How lauragrundy100/vcdsuite-public works
VCDsuite is a notebook-led analysis pipeline for comparing ORCA-calculated and measured VCD/IR spectra, then assessing fit, planning measurements, evaluating evidence tiers, and preparing comparisons or screening predictions. The documented workflow runs setup, plotting, vibrational analysis, optimisation, prediction, evidence analysis, and final comparison; appendices screen unmeasured molecules with theory alone or theory plus IR. Internal edges use the supplied source references; notebook-stage links follow the README. Several notebook and integration implementations were not sampled, so their internal calls are not inferred.
Main entry points: 01_setup.ipynb Data setup · presets.py Molecule constants · stage4.py Fit and scoring · transform.py Spectrum transforms
Components 28
Data and setup
- Spectrum registry
VCDlib/registry.py - Data setup
01_setup.ipynb - ORCA cache
VCDlib/cache_builder.py - Molecule constants
VCDlib/presets.py
Spectra and modes
- Spectrum loading
VCDlib/io_.py - Spectrum transforms
VCDlib/transform.py - Spectrum plotting
02_plotting.ipynb - Figure engine
VCDlib/figures.py - Mode analysis
VAlib/analysis.py - Mode parsing
VAlib/modes.py - Segment boundaries
VAlib/segments.py - Vibrational analysis
03_vibration-analysis.ipynb
Fit and prediction
- IR fit
VCDlib/optimise.py - Fit and scoring
VCDlib/stage4.py - Fit figures
VCDlib/stage4_plots.py - Optimisation stage
04_optimisation.ipynb - Path planning
VCDlib/stage5.py - Prediction stage
05_prediction.ipynb
Evidence and reports
- Evidence tiers
VCDlib/stage6.py - Evidence stage
06_evidence.ipynb - Theory-only screen
VCDlib/appendixA.py - Theory-plus-IR screen
VCDlib/appendixB.py - Final comparison
07_comparison.ipynb - Report figures
VCDlib/figures_report.py
ORCA operations
- ORCA job launcher
00_orca-launch.py
Other components
- Researcher
- Measured spectra
- ORCA calculations
Connections 39
- Researcher → Data setup: starts pipeline
README.md - Measured spectra → Spectrum registry: registered as rows
README.md - ORCA calculations → Data setup: provides calculations
README.md - Data setup → Spectrum registry: validates registry
README.md - Data setup → ORCA cache: builds cache
README.md - Data setup → Molecule constants: writes constants
README.md - Spectrum registry → Spectrum loading: supplies rows
VCDlib/io_.py - Spectrum loading → Spectrum transforms: loads spectra for
VCDlib/transform.py - Spectrum transforms → Figure engine: transforms spectra for
VCDlib/figures.py - Molecule constants → Figure engine: provides settings
VCDlib/figures.py - ORCA cache → Spectrum plotting: feeds plotting
README.md - Molecule constants → Spectrum plotting: provides settings
README.md - Spectrum plotting → Figure engine: renders plots
- Researcher → Vibrational analysis: runs analysis
README.md - ORCA calculations → Mode analysis: supplies mode inputs
README.md - Mode analysis → Mode parsing: produces NMA for parsing
- Mode parsing → Segment boundaries: derives mode character
- Vibrational analysis → Segment boundaries: writes boundaries
README.md - Segment boundaries → Molecule constants: updates molecule data
README.md - IR fit → Spectrum transforms: uses transformations
VCDlib/optimise.py - IR fit → Molecule constants: reads molecule settings
VCDlib/optimise.py - Optimisation stage → IR fit: fits IR widths
- Optimisation stage → Fit and scoring: scores theory
README.md - Fit and scoring → Spectrum transforms: uses transformations
VCDlib/stage4.py - Fit and scoring → Fit figures: supplies fit results
VCDlib/stage4_plots.py - Optimisation stage → Prediction stage: provides frozen fit
README.md - Path planning → Fit and scoring: uses fit computations
VCDlib/stage5.py - Prediction stage → Path planning: plans path lengths
- Path planning → Spectrum transforms: uses transformations
VCDlib/stage5.py - Evidence tiers → Fit and scoring: uses scoring
VCDlib/stage6.py - Evidence tiers → Path planning: uses predictions
VCDlib/stage6.py - Evidence stage → Evidence tiers: computes evidence tiers
- Researcher → Theory-only screen: screens theory alone
README.md - Researcher → Theory-plus-IR screen: screens with IR
README.md - Researcher → Final comparison: reviews results
README.md - Final comparison → Report figures: produces report figures
- Report figures → Figure engine: uses figure engine
VCDlib/figures_report.py - Report figures → IR fit: uses fit results
VCDlib/figures_report.py - Researcher → ORCA job launcher: launches ORCA jobs
README.md