How qtchem/ffprime works
FFprime derives molecular bonded and nonbonded force-field parameters from electronic-structure data and AIM partitioning. The primary nonbonded workflow loads a molecule, partitions its density, derives atomic volumes and multipoles, then computes dispersion and Lennard-Jones parameters; the bonded workflow extracts connectivity and uses a molecular Hessian to calculate force constants. The electrostatics package also offers Cartesian and spherical potential/field evaluation. Sampled source supports the principal nonbonded and bonded calls; other documented capabilities are shown conservatively where implementation detail was not sampled.
Main entry points: nb.py Nonbonded workflow · bond.py Bonded workflow · utils.py Atomic moments · connectivity.py Connectivity parser
Components 20
Parameter derivation
- Nonbonded workflow
ffprime/nb.py - AIM partitioning
ffprime/utils/part.py - Atomic volumes
ffprime/nonbonding/utils.py - TS dispersion
ffprime/nonbonding/vdw.py - Lennard-Jones parameters
ffprime/nonbonding/parameters.py
Electrostatics
- Atomic moments
ffprime/electrostatics/utils.py - Cartesian moments
ffprime/electrostatics/cartesian.py - Spherical moments
ffprime/electrostatics/spherical.py - Electrostatic analysis
ffprime/electrostatics/analysis.py - Multipole expansion
ffprime/electrostatics/expansion.py
Bonded parameters
- Bonded workflow
ffprime/bond.py - Connectivity parser
ffprime/utils/connectivity.py - Bonding analysis notebook
ffprime/bonding/notebook.py - Seminario utilities
ffprime/utils/seminario.py
Evaluation and analysis
- Potential evaluation
ffprime/utils/potentials.py - Parameter output
ffprime/utils/write.py
Other components
- Force-field user
- Electronic structure input
- Derived parameters
- Quantum reference energies
Connections 22
- Force-field user → Nonbonded workflow: requests derivation
README.md - Electronic structure input → Nonbonded workflow: loads molecule
ffprime/nb.py - Nonbonded workflow → AIM partitioning: partitions density
ffprime/nb.py - Nonbonded workflow → Atomic volumes: computes volumes
ffprime/nb.py - Nonbonded workflow → Atomic moments: computes moments
ffprime/nb.py - Nonbonded workflow → TS dispersion: derives dispersion
ffprime/nb.py - Nonbonded workflow → Lennard-Jones parameters: derives LJ values
ffprime/nb.py - Nonbonded workflow → Derived parameters: returns parameters
README.md - Atomic moments → Spherical moments: converts components
ffprime/electrostatics/utils.py - Force-field user → Cartesian moments: evaluates fields
ffprime/electrostatics/cartesian.py - Force-field user → Spherical moments: evaluates fields
ffprime/electrostatics/spherical.py - Force-field user → Bonded workflow: requests derivation
ffprime/bond.py - Electronic structure input → Bonded workflow: loads Hessian
ffprime/bond.py - Bonded workflow → Connectivity parser: parses connectivity
ffprime/bond.py - Bonded workflow → Derived parameters: computes force constants
- Connectivity parser → Bonding analysis notebook: provides connectivity
ffprime/bonding/notebook.py - Force-field user → Potential evaluation: evaluates potentials
README.md - Force-field user → Seminario utilities: derives bonded terms
- Derived parameters → Parameter output: writes parameters
- Derived parameters → Quantum reference energies: benchmarks against
- Force-field user → Electrostatic analysis: analyzes properties
- Force-field user → Multipole expansion: evaluates expansion