API Reference

The full Rust API documentation for the omecp crate is generated from source code comments and is available at:

View API Reference →


Module Overview

ModulePurpose
configConfiguration structures: Config, QMProgram, RunMode, Thresholds
parserInput file parser — section-based format with key-value parameters
optimizerBFGS, GDIIS, GEDIIS, hybrid optimization algorithms
geometryCore types: Geometry, State, unit conversion utilities
gdiisGDIIS algorithm with SR1 updates and step validation
gediisGEDIIS algorithm — RFO, energy, and simultaneous variants
constraintsGeometric constraint system with Lagrange multipliers
hessian_updateBFGS, Bofill, Powell, PSB, and adaptive Hessian updates
qm_interfaceUnified QMInterface trait and program adapters
ioFile I/O: XYZ, Gaussian formats, checkpoint files
lstLST/QST interpolation with Kabsch alignment
pes_scan1D and 2D PES scan implementation
reaction_pathCoordinate driving and NEB optimization
checkpointJSON checkpoint system for restart capability
cleanupAutomated temporary file management
settingsHierarchical INI configuration system
namingDynamic file naming based on input basename
template_generatorInput template generation from geometry files
validationRun mode and program combination validation
helpBuilt-in help system text

Generating API Docs Locally

cargo doc --no-deps --all-features --open

This builds and opens the full API documentation in your browser.