Installation¶
Linux, macOS or WSL, Python 3.9–3.11:
Launch:
The PyPI package does not include the notebooks. From a source checkout
(git clone https://github.com/The-Schultz-Lab/QuantUI.git), install with
pip install -e ".[pyscf,ase,app]" and you can also run:
voila notebooks/molecule_computations.ipynb # app mode (code hidden)
jupyter lab notebooks/molecule_computations.ipynb # full JupyterLab
Windows¶
Native Windows runs a PyFock subset (neutral, closed-shell PBE/def2-SVP or def2-TZVP single points and optimizations). Use Python 3.11:
For everything else, use WSL or Apptainer (Platform Support).
Optional extras¶
| Extra | Adds |
|---|---|
pyscf |
PySCF backend (full feature set) |
pyfock |
PyFock backend (native Windows) |
ase |
Geometry optimization (ASE BFGS), trajectory export and structure I/O |
app |
Voilà app server (JupyterLab is installed by default) |
xtb |
GFN-FF pre-optimization for metals (Linux wheels; use conda-forge xtb-python elsewhere) |
ts |
Transition states and IRC via Sella (about 380 MB) |
gpu-cuda12x / gpu-cuda13x |
gpu4pyscf GPU offload — pick the one matching your NVIDIA driver's CUDA version |
pyfock-gpu-cuda12x / pyfock-gpu-cuda13x |
CuPy for PyFock's GPU path |
dev |
Tests and linters (pytest, ruff, black, mypy, pre-commit) |
PNG plot export¶
Saving a spectrum or diagram as PNG uses Plotly's Kaleido engine (installed with QuantUI). Kaleido 1.x does not bundle a browser: it drives a Chrome or Chromium already on the machine. Without one, PNG export fails with "Kaleido requires Google Chrome to be installed". Either install Chrome or Chromium from your OS, or download a private copy with
HTML and CSV exports do not need a browser. The Apptainer image does not include Chrome yet, so use HTML or CSV export there.