dftbplus

by dftbplus

dftbplus / dftbplus

DFTB+ general package for performing fast atomistic simulations

142 Stars 88 Forks Last release: 3 months ago (20.1) Other 3.5K Commits 5 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:


DFTB+: general package for performing fast atomistic calculations


|lgpl badge|

DFTB+ is a software package for carrying out fast quantum mechanical atomistic calculations based on the Density Functional Tight Binding method. The most recent features are described in the (open access)

DFTB+ paper
_.

|DFTB+ logo|

DFTB+ can be either used as a standalone program or integrated into other software packages as a library.

Installation

Downloading the binary distribution

Binary (threaded) distribution of the latest stable release can be found on the

stable release page 
_.

Building from source

Note: This section describes the building with default settings (offering only a subset of all possible features in DFTB+) in a typical Linux environment. For more detailed information on the build customization and the build process, consult the

detailed building instructions 
_.

Download the source code from the

stable release page
_.

You need CMake (>= 3.5.0) to build DFTB+. Create a build folder (e.g.

build
) in the source folder and start the configuration from there. Pass your compilers as environment variables (
FC
and
CC
) and the location where the code should be installed (
-DCMAKE_INSTALL_PREFIX
)::

mkdir build cd build FC=gfortran CC=gcc cmake -DCMAKEINSTALLPREFIX=$HOME/opt/dftb+ ..

If the configuration was successful, start the build with ::

make -j

After successful build, you should test the code. First download the SK-files needed for the test ::

cd .. ./utils/getoptexternals slakos cd build

and then run the tests with ::

ctest -j

If the tests were successful, install the package with ::

make install

For further details see the

detailed building instructions 
_.

Parameterisations

In order to carry out calculations with DFTB+, you need according parameterisations (a.k.a. Slater-Koster files). You can download them from

dftb.org 
_.

Documentation

Consult following resources for documentation:

  • Step-by-step instructions with selected examples (DFTB+ Recipes)
    
    _
  • Reference manual describing all features (DFTB+ Manual)
    
    _

Citing

When publishing results obtained with DFTB+, please cite following works:

  • DFTB+, a software package for efficient approximate density functional theory
    based atomistic simulations; J. Chem. Phys. 152, 124101 (2020)
    
    _
  • Reference publications of the Slater-Koster parameterization sets you used. (See

    dftb.org 
    _ for the references.)
  • Methodological papers relevant to your calculations (e.g. excited states, electron-transport, third order DFTB etc.). Those references can be found in the

    DFTB+ manual
    
    _.

Contributing

New features, bug fixes, documentation, tutorial examples and code testing is welcome in the DFTB+ developer community!

The project is

hosted on github 
. Please check
CONTRIBUTING.rst 
and the
DFTB+ developers
guide 
_ for guide lines.

We are looking forward to your pull request!

License

DFTB+ is released under the GNU Lesser General Public License. See the included

LICENSE 
_ file for the detailed licensing conditions.

.. |DFTB+ logo| image:: https://www.dftbplus.org/fileadmin/DFTBPLUS/images/DFTB-Plus-Icon06f_150x150.png :alt: DFTB+ website :scale: 100% :target: https://dftbplus.org/

.. |lgpl badge| image:: http://www.dftbplus.org/fileadmin/DFTBPLUS/images/license-GNU-LGPLv3-blue.svg :alt: LGPL v3.0 :scale: 100% :target: https://opensource.org/licenses/LGPL-3.0

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.