Skip to main content

Ab-Initio Molecular Dynamics Potential Development

Project description

All issues and contributions should be done on Gitlab. Github is used only as a mirror for visibility

DFTFIT

DFTFIT is a python code that used Ab Initio data from DFT calculations such as VASP, Quantum Espresso, and Siesta to develop molecular dynamic potentials. Our package differs from other similar codes in that we leverage LAMMPS as a calculator enabling a wide variety of potentials. The potentials include custom python functions and a wide variety or three-body interactions including the Tersoff, Stillinger-Weber, Gao-Weber, Vashishta, and COMB Potentials. All of which can be combined to have for example a Buckingham + Coulomb + ZBL potential. We also have an extensive set of multi-objective and single-objective optimizers.

In general three things are required from the user.

  • Ab-Initio Training Data includes VASP, Siesta, and Quantum Espresso Calculations.
  • configuration: specifies optimization algorithm and number of steps, sqlite database to store results, and MD calculator to use.
  • Potential among a rich set of two and three body potentials. Including a custom python function.
Latest Release latest release
Package Status status
License license
Build Status gitlab pipeline status
Documentation readthedocs documentation

Presentations:

Potentials

Any combination of the following potentials is a valid potential in DFTFIT.

Two-Body Potentials

  • custom python function
  • ZBL
  • Buckingham
  • Beck
  • coulombic interaction
  • Lennard Jones

Three-Body Potentials

  • Tersoff
  • Stillinger Weber
  • Gao Weber
  • Vashishta
  • COMB/COMB3

Algorithm

We use generalized least squares method for finding the optimal parameters for a proposed potential. DFTFIT integrates with existing MD software as a potential calculator. Currently only LAMMPS is supported. This means the user has the freedom to use any of the potentials available in LAMMPS.

Our algorithm follows a highly cited publication that proposes a method for determining a new potential for Silicon using the force matching of DFT calcultions.

Optimization Equation

Parameters

  • n_c: number of system configurations
  • N number of atoms in each configuration
  • α, β: tensor with 3D dimensions [x, y, z]
  • cl: classical results from molecular dynamics potential
  • ai: ab initio results from dft simulation
  • w_f, w_s, w_e: weights to assign respectively for force, stress, energy
  • F, S, E: force, stress, and energy respectively.

Dependencies

Installation

For pypi installation. Note that installation of lammps-cython may fail and is required. You will need to install LAMMPS as documented here. You may have to do pip install numpy cython.

pip install dftfit

For conda installation

conda install -c costrouc dftfit

For docker installation

docker pull costrouc/dftfit

Documentation

The official documentation is hosted on readthedocs.org: https://dftfit.readthedocs.io/en/latest/

Running

DFTFIT provides a command line interface. Of course the package can be used as a standard python package.

Tutorial and Documentation

Contributing

All contributions, bug reports, bug fixes, documentation improvements, enhancements and ideas are welcome. These should be submitted at the Gitlab repository. Github is only used for visibility.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dftfit-0.4.7.tar.gz (38.6 kB view details)

Uploaded Source

Built Distribution

dftfit-0.4.7-py3-none-any.whl (48.0 kB view details)

Uploaded Python 3

File details

Details for the file dftfit-0.4.7.tar.gz.

File metadata

  • Download URL: dftfit-0.4.7.tar.gz
  • Upload date:
  • Size: 38.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for dftfit-0.4.7.tar.gz
Algorithm Hash digest
SHA256 1b23b2231914ab6fb0597a45485d820f46be6339300d2bca2def5bf30041ed7c
MD5 75cd58b62435432bdcfe714afd8939b2
BLAKE2b-256 05543a3386f56ff7f56642ab2674efb4d93d86f916554cbd5b940a267b981d85

See more details on using hashes here.

File details

Details for the file dftfit-0.4.7-py3-none-any.whl.

File metadata

File hashes

Hashes for dftfit-0.4.7-py3-none-any.whl
Algorithm Hash digest
SHA256 d5684986ba4e4b67917b4315220e00cba390056a940dc5cf28128496e1f3bf94
MD5 79a1c30802c10111c8366b928682ce27
BLAKE2b-256 ad649e196d65ca781b85720901c18f136e4433f0d0d19e8197afdf36ce6b0c3a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page