Tutorial¶
These tutorials double as a course in computational quantum chemistry. If you are new to vibe-qc or to the field, start with the Introduction for the background, the molecular/periodic split, and the learning path; otherwise work down from wherever you like. Nearly every page is a complete worked example you can paste straight into a Python interpreter; the few conceptual pages say so in their first paragraph. Every method page states the status label of what it runs (production, preview, experimental or gated) in the vocabulary of Methods: theory and status.
Choose a learning path¶
You do not have to read all of the tutorials. Pick the path that matches the calculation you want to perform, and use the user guide when you need a reference table rather than a lesson. If you are choosing between methods, Methods: theory and status summarises every family with its equations and its status label, and links back to the tutorial that derives it.
Path |
Read in order |
You will finish able to… |
|---|---|---|
First calculation, about 45 minutes |
Introduction -> Planning -> Molecular HF -> Molecular DFT |
choose a model, run an SCF calculation, and judge convergence |
Molecular structure and properties |
Molecular HF -> Geometry optimization -> Vibrations -> Thermodynamics |
move from an electronic energy to an optimized, characterized structure |
Correlated molecular energies |
Basis convergence -> RI-MP2 -> CCSD(T) -> DLPNO |
choose a correlation hierarchy and track its cost and approximations |
Periodic materials |
Periodic HF -> Bloch and k-points -> Periodic DFT -> Method routes |
construct a crystal calculation and converge its sampling and Coulomb route |
Converging a calculation |
DFT grid convergence -> Lattice-cutoff convergence -> Symmetry-reduced k meshes |
know which numerical knob limits a molecular or periodic energy and how far to push it |
Correlation on crystals |
run coupled-cluster correlation per cell and read its finite-size behaviour |
|
Inside the SCF |
understand the eigensolvers, their diagnostics and their refusals |
|
Results and visualization |
inspect, compare, export, and archive results |
|
Portable molecular inputs and results |
exchange a molecule and calculation result as JSON and check it against a literature energy |
|
Wavefunction exchange |
export, inspect, convert and restart wavefunctions while retaining default QVF output |
|
Remote operation |
submit, monitor, fetch, and preserve remote calculations |
Molecular path¶
Start with the foundations section, then choose properties, accuracy, or correlation. Read Direct SCF or in-core integrals? before using a large molecular basis: basis growth affects memory much faster than atom count alone suggests.
Periodic path¶
Read the four periodic foundations pages before choosing GDF, BIPOLE, GPW, GAPW, or CCM. A periodic calculation adds lattice sums, k-point sampling, dimensionality, and basis linear-dependence questions that do not occur in an isolated molecule.
What every tutorial tells you¶
A complete tutorial should answer five questions: what physical problem is being solved, which approximations enter, how to run it, what successful output looks like, and what to test before trusting the result. When you only need option names and defaults, jump to the user guide or keyword index.
For downloadable inputs, full logs, QVF archives, and vibe-view captures, see reference outputs and the full example-output catalog. The catalog includes the curated chi-CCM-B periodic QVF validation fixtures for checking finite-BvK cells, torus-aligned grids, and Wannier-centre overlays.
Molecular: foundations
Molecular: properties & workflows
- Post-SCF properties: charges, bonds, dipole
- Orbital and density visualization
- QTAIM: critical points and bond paths
- Energy decomposition and orbital entanglement
- Geometry optimization
- Vibrational frequencies
- Thermodynamics at temperature
- Molecular dynamics (NVE, NVT, NPT)
- Nudged elastic band: reaction paths and transition states
- Following the IRC from a transition state
- Relaxed potential-energy surface scans
- Solvation in water (CPCM)
Molecular: methods & accuracy
- Basis-set convergence
- Pt cluster with LANL2DZ: heavy-element ECPs
- DFT functional comparison
- Microsoft SKALA-1.1 neural XC: a reproducible molecular calculation
- Dispersion corrections (D3-BJ)
- Double hybrid: B2PLYP step by step
- Range-separated hybrids: ωB97X and the HOMO ≈ −IP property
- Modern functionals: VV10 and the ωB97X-V / ωB97M-V wave
- RIJCOSX SCF and analytic gradients on glycine
- Stiff molecular SCF: rescuing oscillation with EDIIS+DIIS
- Letting DIIS choose its own depth: R-CDIIS and AD-CDIIS
- Second-order SCF: Newton, SOSCF, and TRAH
- Eigensolvers and the operator contract
- Molecular SCF with OpenTrustRegion
- OpenTrustRegion restarts and orbital stability
- Excited states with TDDFT
Molecular: correlation & fast methods
- Natural orbitals and the idempotency diagnostic
- Verifying an RI-MP2 auxiliary basis
- Canonical CCSD(T): the gold-standard reference
- The coupled-cluster family: from MP2 to CCSDT
- Ionisation potentials from the electron propagator
- Local correlation with DLPNO
- DLPNO-CCSD(T) on a crystal
- Non-mean-field solvers: Selected-CI, DMRG, v2RDM, and transcorrelated methods
- Multireference: CASSCF, CASPT2, NEVPT2
- MSINDO: semiempirical INDO
- Semiempirical DFTB: fast preoptimization
- More semiempirical methods: PM6 and GFN2-xTB
- GFN2-xTB Workshop
- Periodic semiempirical methods and cross-method validation
- Machine-learning interatomic potentials with MACE
- From a MACE geometry to electronic structure
Periodic: foundations
Periodic: the cyclic cluster model
Periodic: methods
Periodic: electronic structure
- Band structure and density of states
- LiH at multiple k-points: KRHF vs Peintinger 2013
- Symmetry-reduced k meshes for exact exchange
- Lattice-cutoff convergence of periodic Kohn-Sham energies
- Projected density of states (PDOS)
- COOP and COHP: bonding analysis of a periodic system
- Smearing for metals: Fermi-Dirac, Methfessel-Paxton, and cold smearing
- The Gilat-Raubenheimer net: metallic Brillouin-zone integration
- DFT+U for correlated transition-metal oxides
Periodic: basis & real systems
- Why solid-state calculations use
pob-TZVP - Solid-state walkthrough: LiH rocksalt with
pob-TZVP - A gallery of real crystal structures
- Periodic geometry optimization
- MgO from the Materials Project:
vqfetchend-to-end - Slabs and adsorption: the ab-initio surface workflow
- Open-shell Green’s-function surface embedding
Periodic: phenomena, convergence & visualization
- Peierls dimerisation of a 1D H-chain
- Open-shell Mg⁺• in a periodic box: BIPOLE UHF with Makov-Payne
- Periodic orbital cubes and XSF files
- Tight-cell DFT with the periodic Becke partition
- Periodic SCF convergence: damping, DIIS, and level shifts
- Symmetry-aware storage of lattice integrals (SYM3a)
- XSF and BXSF: periodic volumetric visualisation
Operations
- Exchange and restart a molecular wavefunction with TREXIO
- TREXIO for CI wavefunctions and periodic restarts
- Running in parallel
- Submitting a job to a remote machine with
vq - Fetching external data with
vqfetch - Reproducing an example output
- Auto-citations: from
.outto manuscript bibliography - Cross-validating against ORCA, Psi4, and PySCF
Visualization tutorials moved
The QVF and vibe-view tutorials (the file format, job containers, adopting QVF in your own code, the browser walkthrough, terminal mode, the full vibe-view feature tour, and MolTUI) now live together in QVF and vibe-view, alongside the matching reference pages and the format toolkit. The tutorial pages themselves did not move; only their place in the navigation did.
New to vibe-qc or to the field? The Introduction lays out the background, the molecular and periodic tracks, and how to run these examples. The molecular tutorials use the built-in basis sets (STO-3G, 6-31G*, cc-pVDZ) that ship with vibe-qc; the periodic tutorials use the pob-* basis sets designed to avoid linear dependence in crystals.