TinyDFT 1.0.0

Minimalistic atomic DFT code.

Tiny DFT

Tiny DFT is a minimalistic atomic Density Functional Theory (DFT) code, mainly for educational purposes. It only supports spherically symmetric atoms and local exchange-correlation functionals (at the moment only Dirac exchange).

The code is designed with the following criteria in mind:

• It depends only on established scientific Python libraries: numpy, scipy, matplotlib and (the lesser known) autograd. The latter is a library for algorithmic differentiation, used to compute the analytic exchange(-correlation) potential and the grid transformation.

• The numerical integration and differentiation algorithms should be precise enough to at least 6 significant digits for the total energy, but in many cases the numerical precision is better. Some integrals over Gaussian basis functions are computed analytically. The pseudo-spectral method with Legendre polynomials is used for the Poisson solver.

• The total number of lines should be minimal and the source-code should be easy to understand, provided some background in DFT and spectral methods. As in most atomic DFT codes, the occupation numbers of the orbitals are all given the same value within one pair of angular and principal quantum number, to obtain a spherically symmetric density. The code only keeps track of the total number of electrons for each pair of quantum numbers.

Installation

It is recommended to install Tiny DFT in a Python virtual environment, to avoid conflicts with other packages. The details of setting up such an environment depend on your operating system and Python installation.

Hackable setup

1. Download the Tiny DFT repository. This can be done with your browser, after which you unpack the archive: https://github.com/theochem/tinydft/archive/main.zip. Or you can use git:

   git clone https://github.com/theochem/tinydft.git
   cd tinydft
   

2. Install the tinydft package from source in development mode:

   pip install -e .
   

User setup

If you only intended to use the package, e.g. for making figures, you can install it from PyPI:

pip install tinydft

Usage

To run a series of atomic DFT calculation, up to argon, run the Mendelejev demo

tinydft-demo-mendelejev

This generates some screen output with SCF convergence, energy contributions and the figures rho_z0*.png with the radial electron densities on a semi-log plot. To modify the settings for these calculations, you can directly edit the source code.

When you make serious modifications to Tiny DFT, you can run the unit tests to make sure the original features still work.

For this, you first need to install pytest in a development setup. For example:

git clone [e-mail]:theochem/tinydft.git
cd tinydft
python3 -m venv venv
source venv/bin/activate
python3 -m pip install -e .[dev]
pre-commit install
pytest

See the QC-Devs Contributor Guide for more details.

Programming assignments

In order of increasing difficulty:

1. Change tinydft/demo_mendelejev.py to also make plots of the radial probability density, the occupied orbitals, the potentials (external, Kohn-Sham) with horizontal lines for the (higher but still negative) energy levels. Does this code reproduce the Rydberg spectral series well? (See https://en.wikipedia.org/wiki/Hydrogen_spectral_series#Rydberg_formula)

2. Add a second unit test for the Poisson solver in tests/test_tinydft.py. The current unit test checks if the Poisson solver can correctly compute the electrostatic potential of a spherical exponential density distribution (Slater-type). Add a similar test for a Gaussian density distribution. Use the erf function from scipy.special to compute the analytic result.

3. At the moment, the DFT calculations assume spin-unpolarized densities, which mainly affects the exchange-correlation energy. Change the code to work with spin-polarized densities. For this, also the occupation numbers for each angular momentum and principal quantum number should be split into a spin-up and spin-down occupation number.

4. Change the external potential to take into account the finite extent of the nucleus. You can use a Gaussian density distribution. Write a python script that combines isotope abundancies from NUBASE2016 and nucleotide radii from ADNDT to build a table of abundance-averaged nuclear radii.

5. Add a correlation energy density to the function excfunction and check if it improves the results in assignment (2). The following correlation functional has a good compromise between simplicity and accuracy:

   • https://aip.scitation.org/doi/10.1063/1.4958669 and
   • https://aip.scitation.org/doi/full/10.1063/1.4964758

6. The provided implementation has a rigid algorithm to assign occupation numbers using the Klechkowski rule. Replace this by an algorithm that just looks for all the relevant lowest-energy orbitals at every SCF iteration.

7. Implement an SCF convergence test, which checks if the new Fock operator, in the basis of occupied orbitals from a previous iteration, is diagonal with orbital energies from the previous iteration on the diagonal

8. Implement the zeroth-order regular approximation to the Dirac equation (ZORA). ZORA needs a pro-atomic Kohn-Sham potential as input, which remains fixed during the SCF cycle. Add an outer loop where the first iteration is without ZORA and subsequent iterations use the Kohn-Sham potential from the previous SCF loop as pro-density for ZORA. (To avoid that the density diverges at the nucleus, assignment 4 should be implemented first.)

   In ZORA, the following operator should be added to the Hamiltonian:

   

   where the first factors are the gradients of the basis functions (similar to the kinetic energy operator). The Kohn-Sham potential from the previous outer iteration can be used. The parameter alpha is the dimensionless inverse fine-structure constant, see https://physics.nist.gov/cgi-bin/cuu/Value?alphinv and https://docs.scipy.org/doc/scipy/reference/constants.html (inverse fine-structure constant). Before ZORA can be implemented, the formula needs to be worked out in spherical coordinates, separating it in a radial and an angular contribution.

9. Extend the program to perform unrestricted Spin-polarized KS-DFT calculations. (Assignment 6 should be done prior to this one.) In addition to the Aufbau rule, you now also have to implement the Hund rule. You also need to keep track of spin-up and spin-down orbitals. The original code uses the angular momentum quantum number, angqn as keys in the eps_orbs_u dictionary. Instead, you can now use (angqn, spinqn) keys.

10. Extend the program to support (fractional) Hartree-Fock exchange.

11. Extend the program to support (meta) generalized gradient functionals.

Dictionary of variable names

The variable names are not always the shortest possible, e.g. atnum instead of z, to make them more self-explaining and to comply with good practices.

• alphas: Gaussian exponents in basis functions
• atcharge: Atomic charge
• atnum: Atomic number
• angqn: Angular momentum (or azimuthal) quantum number
• coeffs: Expansion coefficients of a function in Gaussian primitives or Legendre polynomials.
• econf: Electronic configuration
• energy_hartree: Hartree energy, i.e. classical electron-electron repulsion.
• eps: Orbital energies
• eps_orbs_u: A list of tuples of (orbital energy, orbital coefficients). One tuple for each angular momentum quantum number. The orbital coefficients represent the radial solutions U = R/r.
• energy_xc: Exchange-correlation energy
• exc: Exchange-correlation energy density
• evals: Eigenvalues
• evecs: Eigenvectors
• ext: Integrals for interaction with the external field (proton)
• fnvals: Function values on grid points
• fock: Fock operator
• iscf: Current SCF iteration
• jxc: Hartree-Exchange-Correlation operator
• kin_rad: Radial kinetic energy integrals
• kin_ang: Angular kinetic energy integrals
• maxangqn: Maximum angular quantum number of the occupied orbitals
• nbasis: Number of basis functions
• nelec: Number of electrons
• nscf: Number of SCF iterations
• occups: Occupation numbers
• olp: Overlap integrals
• orb_u: Orbital divided by r: U = R/r
• orb_r: Orbital: R = U*r
• priqn: Primary quantum numbers
• rho: Electron density on grid points
• vhartree: Hartree potential, i.e. minus classical electrostatic potential due to the electrons.
• vol: Volume element in spherical coordinates
• vxc: Exchange-correlation potential