A quantum chemistry engine written in Rust, with Python bindings and a TOML-driven command line. libint2 supplies the integrals and libxc the functionals.
Documentation: https://matthew.thegoldeys.com/ferric/
pip install ferric # Linux x86_64, CPython 3.10–3.13The wheel needs no compiler. To change ferric itself or to use MPI, build from source; see Installation.
import ferric
water = ferric.Molecule.from_xyz_string(
"""3
water
O 0.000000 0.000000 0.117790
H 0.000000 0.755453 -0.471161
H 0.000000 -0.755453 -0.471161
""",
0,
1,
) # charge, multiplicity
rhf = ferric.run_rhf(water, ferric.BasisSet.bundled("sto-3g"))
print(rhf.converged, f"{rhf.energy:.10f}") # True -74.9631468000The same calculation from the command line (ferric is installed with the
wheel):
# water-rhf.toml
[molecule]
xyz = "water.xyz"
[basis]
name = "sto-3g"
[method]
kind = "rhf"printf '3\nwater\nO 0.000000 0.000000 0.117790\nH 0.000000 0.755453 -0.471161\nH 0.000000 -0.755453 -0.471161\n' > water.xyz
OPENBLAS_NUM_THREADS=1 ferric water-rhf.tomlContinue with Your first calculation and the Sharp bits.
| Family | Examples | Page |
|---|---|---|
| SCF and DFT | RHF/UHF/ROHF, RKS/UKS/ROKS via libxc (LDA to meta-GGA, range-separated hybrids, VV10, D3(BJ)), analytic gradients, optimization, finite-difference frequencies, PCM/COSMO solvation | SCF and DFT |
| MP2 family | RI-MP2, attenuated MP2, SCS-MP2 and SCS-MP2(2terfc), OO-MP2, Laplace and SOS-MP2, MP3, local MP2, MP2-V | The MP2 family |
| Coupled cluster | CCD, CCSD, CCSD(T), LinLCCD, double hybrids | Coupled cluster |
| Response | PDEP-RPA, GW (G0W0, COHSEX, evGW), BSE-TDA, TDDFT/TDA, polarizabilities and C6 | RPA and GW |
| Constrained DFT | charge/spin constraints, electron-transfer couplings | Constrained DFT |
| Embedding | QM/MM with link atoms, smeared and polarizable charges | QM/MM |
Which of these run from the CLI, which are Python-only, and which support open shells or gradients is tabulated in Capabilities and validation.
Implemented ≠ validated. Working code is not a checked number. Each capability is graded (Proven / Smoke / Spike) against independent references on the same page. Read it before relying on a result.
ferric is organized around electronic response: how the density reacts to a perturbation, the object behind polarizabilities, dielectric screening and dispersion. Attenuated MP2, PDEP-RPA/GW and constrained DFT are three ways of getting that object right where standard methods get it wrong. See Electronic response.
git clone https://github.com/mgoldey/ferric && cd ferric
scripts/install-libint.sh ~/.local/libint2-2.13.1 # prebuilt libint2, seconds
export LIBINT2_PREFIX=~/.local/libint2-2.13.1
cargo build --release
OPENBLAS_NUM_THREADS=1 ./target/release/ferric examples/water-rhf.toml
OPENBLAS_NUM_THREADS=1 cargo test --workspaceSee CONTRIBUTING.md for the development loop, the Python binding tests and the push gate.
If you use ferric, cite the software (see CITATION.cff) and the papers for the methods you ran, listed in References and citing.
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE)
- MIT license (LICENSE-MIT)
at your option.
crates/ferric-integrals/shim/libecpint/ vendors libecpint
(MIT, Copyright (c) 2021 Robert A. Shaw); its license is retained at
crates/ferric-integrals/shim/libecpint/LICENSE.
ferric links against external libraries with their own licenses, notably libint2 (LGPL-3.0-or-later), libxc (MPL-2.0), OpenBLAS/LAPACK (BSD), and optionally xtb (LGPL-3.0), which govern redistribution of binaries built against them. libint2 is a required dependency, not an optional one: distributing a compiled ferric binary means distributing LGPL-linked code, which carries obligations (relinking, source availability) beyond ferric's own MIT/ Apache-2.0 terms. Building from source for your own use is unaffected.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.