Poraquê
Poraquê learns maps between the three-dimensional scalar fields of density-functional theory. Given only a crystal geometry it predicts the valence charge density and the kinetic energy density — no wavefunctions, no self-consistency cycle.
{POSCAR, INCAR, POTCAR} --analytic--> EXTCAR --Model 1--> CHGCAR --Model 2--> TAUCAR
|
integrate v
energy
The first step is closed-form; only the two field-to-field maps are learned. They are not unrelated regressions: the first is the Hohenberg–Kohn map, whose existence is a theorem, and the second is the kinetic energy density functional, the missing ingredient of orbital-free DFT.
Install
git clone https://github.com/seixas-research/poraque.git
cd poraque
pip install -e .
Python 3.11 or newer. Installing registers three console commands —
poraque-train, poraque-inference and poraque-committee — which run from
any directory once the environment is active. Each is the main() of the
script of the same name under scripts/, so python scripts/poraque_train.py
is equivalent to poraque-train and needs nothing installed.
Use
# 1. train one ext2chg and one chg2tau model on all structures
poraque-train --write-config configs/train_config.yaml
poraque-train --config configs/train_config.yaml
# 2. measure generalisation
poraque-train --config configs/train_config.yaml --kfold --k-folds 5
# 3. predict a structure that has never been computed
poraque-inference new_structure/ --output predictions/new_structure
Every predicted field is written in CHGCAR format and opens in VESTA.
Or drive it from ASE:
from ase.build import bulk
from poraque.calculator import Poraque
atoms = bulk("Au", "fcc", a=4.08, cubic=True)
atoms.calc = Poraque("models/poraque_models.pfno", potcar="POTCAR")
atoms.get_potential_energy()
print(atoms.calc.components) # T_s, E_ext, alpha Z, E_H, E_xc, Ewald
Forces and stress are not implemented, so this is single points, not relaxations.
What is in here
| Path | Contents |
|---|---|
src/poraque/fields/ |
Shared-grid scalar fields, VASP I/O, pluggable ingestion |
src/poraque/ml/ |
Fourier neural operators, differentiable DFT operators, training |
src/poraque/physics/ |
Total-energy components integrated from the predicted fields |
src/poraque/calculator.py |
ASE calculator wrapping the whole chain |
src/poraque/vis/ |
Figures and automatic PDF reports |
scripts/ |
Validation, training, inference, experiments |
configs/ |
YAML run definitions |
docs/source/ |
Sphinx documentation |
docs/notes/ |
Design and analysis notes — start at roadmap.md |
latex/user_guide/ |
User guide (how to run it) |
latex/technical_guide/ |
Technical guide (physics and architecture) |
Design points
- The external potential is computed natively. Poraquê reconstructs it from
the
POTCARtables on any standard VASP output, matching a reference potential to a relative 5×10⁻⁵. There is no option to import one: the training input must be exactly what inference produces. - Grids may differ between materials. One model serves all of them: the operator's weights live in Fourier-mode space, and batches are bucketed by grid shape.
- Constraints are structural where possible. For
chg2tau, τ = τ_vW[ρ] + softplus(·) makes the Hoffmann-Ostenhof bound hold by construction rather than by penalty. - Resampling is spectral. Fourier truncation is the exact band-limited projection for a plane-wave field; interpolation would alias and shift the electron count.
- CUDA, Apple Metal and CPU, selected automatically.
Status
Twelve gold supercells — ten 27-atom cells and two 32-atom cells, spanning four grid shapes. 5-fold cross-validation, whole structures held out:
| Model | relative L² | R² |
|---|---|---|
ext2chg |
0.0245 ± 0.0130 | 0.9987 |
chg2tau |
0.0444 ± 0.0271 | 0.9951 |
The learned kinetic functional beats the analytic orbital-free functionals by a
wide margin on this system — Thomas-Fermi scores 1.348 and von Weizsäcker
0.738 on the same fields, so chg2tau is 30× and 17× better
respectively.
Cell size dominates the error
The aggregate above hides the only interesting thing in it. Split by cell size:
| Subset | ext2chg |
chg2tau |
|---|---|---|
| 27-atom (10 structures) | 0.0205 ± 0.0064 | 0.0355 ± 0.0069 |
| 32-atom (2 structures) | 0.0445 ± 0.0182 | 0.0894 ± 0.0420 |
Held out, a 32-atom cell is 2.2–2.5× harder than a 27-atom one. That is the first transfer measurement this project has: with only two examples of that cell size, holding one out leaves a single sibling, and the operator has to extrapolate to a grid shape it has barely seen.
Within a familiar cell size, more data helps monotonically — the 27-atom numbers are the best yet recorded:
| Dataset | ext2chg |
chg2tau |
|---|---|---|
| 5 structures | 0.0295 ± 0.0025 | 0.0525 ± 0.0031 |
| 9 structures | 0.0219 ± 0.0046 | 0.0400 ± 0.0069 |
| 12 structures, 27-atom subset | 0.0205 ± 0.0064 | 0.0355 ± 0.0069 |
The three rows differ in protocol as well as in data — the 12-structure run holds out 3 structures per fold against 1 for the 5-structure run, and uses early stopping, which the earlier runs predate. Read the trend, not the third decimal.
Still one element. These numbers measure interpolation between geometries of gold and now, weakly, extrapolation across cell size. They say nothing about transfer to other chemistry. Growing the dataset remains the main open item — see
docs/notes/roadmap.md.
Energies are not there yet. The total energy is a sum of terms of order
10⁴ eV whose physically relevant variation is a fraction of an eV per atom — a
relative ~10⁻⁴ — and a field-level error of 2×10⁻² cannot survive that
cancellation. Across the twelve structures the true spread is 0.27 eV/atom and
the error on predicted differences is 0.29 eV/atom, a ratio of 1.06 with
correlation r ≈ −0.1. That is an improvement on the previous 3× ratio, but an
error equal to the signal and no correlation still means the predicted energy
ordering carries no information. The energy module itself is validated against
exact Madelung constants and uniform-electron-gas limits; it is the fields
that are not yet accurate enough. See docs/source/energy/index.md.
License
MIT. See LICENSE.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file poraque-26.8.17.tar.gz.
File metadata
- Download URL: poraque-26.8.17.tar.gz
- Upload date:
- Size: 3.1 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
56b7c6a8b0450e5e076a30b2d69b2a9adc3be19a71c9be2c5a665aa8c72ea387
|
|
| MD5 |
c9a90fb83ecb5ee6bae1a9064d58b4c1
|
|
| BLAKE2b-256 |
cb27d747dccbaf8f57d61aabb1233f8042acf64e6dcd531539e0b26e4a65bfc1
|
File details
Details for the file poraque-26.8.17-py3-none-any.whl.
File metadata
- Download URL: poraque-26.8.17-py3-none-any.whl
- Upload date:
- Size: 227.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4e93c4e91b722960c3b0f979d80cc73a9178356bf81714de902cffb11730a63c
|
|
| MD5 |
195e6e75f79075ac54a4fd1d0c93d0cd
|
|
| BLAKE2b-256 |
12c49f75f9a41e22c736da43f1fba4307bbf0ee1226b44101aed6a8c22a460d8
|