Skip to main content

DFTTK: Density Functional Theory Tool Kit

Project Goal

Provide robust density functional theory workflows for calculating thermodynamic properties in temperature and composition space. For detailed documentation of the DFTTK package, see www.dfttk.org

For a given structure and elements, calculate all kinds of thermodynamic properties at finite temperature and pressure by first-principles approach based on density functional theory, including lattice vibration, thermal electron excitation, Seebeck coefficient, Lorenz number, effective charge carrier concentration etc.

The goal of DFTTK is to make high-throughput first-principles calculations as simple as possible. The density functional theory (DFT) based software VASP is employed to perform first-principles calculations. In addition thermodynamic properties via the quasiharmonic approach, we proposed that any property, as long as it is dependent on the volume or stain, can be predicted using a quasi-static approach implemented by our group according to (i) the predicted property-volume/strain relationship from first-principles calculations directly and (ii) the volume/strain-temperature relationship of materials from the quasiharmonic approach.

High-throughput calculations

By its definition, the term of “first-principles” represents a philosophy that the prediction is to be based on a basic, fundamental proposition or assumption that cannot be deduced from any other proposition or assumption. This implies that the computational formulations are based on the most fundamental theory of quantum mechanics - Schrödinger equation or density functional theory (DFT) and the inputs to the calculations must be based on well-defined physical constants – the nuclear and electronic charges. In another word, once the atomic species of an assigned material are known, the theory should predict the energy of all possible crystalline structures, without invoking any phenomenological fitting parameters.

However, to perform DFT calculations in reality, it still needs the user to have extensive experiences on a variety of parameter choices and a lot of human handling on numerical or system exceptions. In the last decade, we have been working on solving the problem by integrating our experiences accumulated on high-throughout DFT calculations into a software package named as DFTTK (DFT based toolkits) and opened to the community (https://www.dfttk.org).

The main functions of DFTTK

  • Structure maker by protype and elemental substitution;

  • Robust 0 K equilibrium volume optimization;

  • Robust 0 K energy-volume curve optimization;

  • Quasiharmonic phonon calculation;

  • Born effective charge calculation;

  • Elastic constant calculations.

  • MongoDB database management

  • Thermodynamic calculations and figure plots

DFTTK features

To perform DFT calculation using DFTTK, the user only needs to name the structure file called POSCAR by VASP, either prepared by user or produced by DFTTK by elemental substation on given prototype. DFTTK is developed on atomate from the Materials Project which is built on three open-source Python libraries. The main benefits of atomate are its flexibility and data management platform, in particular the numerical convergence control and computational exception handling. DFTTK is able to predict properties at finite temperatures by phonon or Debye model for both stoichiometric and solution phases, featured by:

  • High-throughput DFT calculation and postprocess;

  • Postprocess plenty of data stored in MongoDB with one simple command;

  • Compatible with Yphon package and phonopy;

  • Can recover data from certain fizzled calculations;

  • Can account thermal electron contribution to thermodynamic properties;

  • Can calculate thermodynamic properties at 0 K and a few tenth K;

  • Can perform doping calculations for semiconductors or thermoelectric materials under rigid band approximation;

  • Can account the effect of thermal expansion/temperature on Seebeck coefficient, Lorenz number, thermal carrier concentrations;

  • Automatic plot figures for more than 20 thermodynamic properties in the publishable resolution, including atomic volume, free energy, entropy, enthalpy, linear thermal expansion coefficient, isobartic specific heat, constant volume specific heat, lattice only specific heat, bulk modulus, Debye temperature, Seebeck coefficient, Lorenz number, absolute thermal electric force, etc.

Robust relaxation scheme of DFTTK

The purpose of DFTTK robust relaxation is to find the lowerst energy structure within a given threshold of a given sysmmetry. This information is espetically useful in the case, fof example

  1. Random sulution phase;

  2. High temperature phase which is unstable in low temperature;

  3. The calculation of energetics for endnumber for CALPHAD modeling.

The solution is to make the best use of ISIF control parameter in VASP, which controls:

ISIF

calc. force

relax stress tensor

relax ions

change cell shape

change cell volume

0

yes

no

yes

no

no

1

yes

trace only

yes

no

no

2

yes

yes

yes

no

no

3

yes

yes

yes

yes

yes

4

yes

yes

yes

yes

no

5

yes

yes

no

yes

no

6

yes

yes

no

yes

yes

7

yes

yes

no

no

yes

DFTTK makes it automatic to going through these ISIF option.

Metadata

Release files for dfttk 0.3.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for dfttk 0.3.4
File Size Uploaded Provenance
dfttk-0.3.4.tar.gz 560.7 kB Without provenance Details

Release files / dfttk-0.3.4.tar.gz

Download URL dfttk-0.3.4.tar.gz
Size 560.7 kB
Tags Source
SHA-256 checksum
How to use checksums
4768527a9d7ab862cebd79d300c62b4a34549763395e4281ea14d366b12cd1b2
BLAKE2b-256 checksum
How to use checksums
5de37fa7a8a426efc25a598e3b4cb9b4a7cd0b76f9de26a0a2ee92d6f9f4bfc6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.6.1 requests/2.24.0 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.5

Security for dfttk 0.3.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page