Giter VIP home page Giter VIP logo

recipes's Introduction

DFTB+: general package for performing fast atomistic calculations

LGPL v3.0

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+ website

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

Installation

Obtaining via Conda

The preferred way of obtaining DFTB+ is to install it via the conda package management framework using Miniconda or Anaconda. Make sure to add/enable the conda-forge channel in order to be able to access DFTB+, and ensure that the conda-forge channel is the first repository to be searched for packages. (Please consult the conda documentation for how to set-up your conda environment.)

We recommend the use of the mamba installer, as we have experienced dependency resolution problems with the original conda installer in the past:

conda install -n base mamba

We provide several build variants, choose the one suiting your needs. For example, by issuing

mamba install 'dftbplus=*=nompi_*'

or

mamba install 'dftbplus=*=mpi_mpich_*'

or

mamba install 'dftbplus=*=mpi_openmpi_*'

to get the last stable release of DFTB+ with, respectively, serial (OpenMP-threaded) build or with MPI-parallelized build using either the MPICH or the Open MPI framework.

Downloading the binary

A non-MPI (OpenMP-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 in INSTALL.rst.

Download the source code from the stable release page.

You need CMake (>= 3.16) to build DFTB+. If your environment offers no CMake or only an older one, you can easily install the latest CMake via Python's pip command:

pip install cmake

Start CMake by passing your compilers as environment variables (FC and CC), and the location where the code should be installed and the build directory (_build) as options:

FC=gfortran CC=gcc cmake -DCMAKE_INSTALL_PREFIX=$HOME/opt/dftb+ -B _build .

If the configuration was successful, start the build with:

cmake --build _build -- -j

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

./utils/get_opt_externals slakos
./utils/get_opt_externals gbsa

or

./utils/get_opt_externals ALL

and then run the tests with

pushd _build; ctest -j; popd

If the tests were successful, install the package with

cmake --install _build

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:

Citing

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

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.

recipes's People

Contributors

adrieldom avatar aradi avatar awvwgk avatar bhourahine avatar c3091013 avatar inseonglee avatar pecchia avatar r-gab avatar vanderhe avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

recipes's Issues

Update "Basic usage" sections to current best practices

The "Basic usage" section could benefit from some minor updates. E.g. it refers to deprecated geometry drivers, quite old parser versions,...

I don't have a complete overview of the other sections at the moment, but at least keeping the entry-point for new users up to date would be important in my opinion.

Add tutorial for solvation models

Create a tutorial for usage of solvation models in DFTB+.

Topics:

  • solvent parameters
  • usage of generalized Born type models
  • usage of polarizable continuum models
  • combination with surface area models
  • calculation of solvation free energies, different reference states
  • corrections for charged systems

the details derivation of the local current?

Hi, in the transport example, you show the local current calculation formula as,
image

can you tell me the details of derivation for this formula? in the orthogonal basis set, the local current should be H\rho , where is the -S\epsilon term com form? and how to calculate the \epsilon?

Thanks a lot.

COFs

Hi, I'm having some problems trying to run dftb+ for COFs. The SCC always failed to converge at different steps. And I was wondering is there any problems with my input code.
COFs.txt

Table of contents depth

At the moment this is set at 2, which just gives major section headings. 3 would give more indication of what the various recipes cover (some of the section headings don't give much clue), but a more verbose table of contents. Any views on which is better?

Add tutorial for extended tight-binding

Document the usage of the xTB Hamiltonian in DFTB+.

Topics:

  • using the xTB Hamiltonian group in the input
  • selecting default parametrizations from the library

PyAPI section slightly outdated

E.g. -DENABLE_DYNAMIC_LOADING=1 required in order to be able to make use of the Python API.

Also, merging #1267 will further necessitate some minor changes.

Merge tutorials from DFTB+ school in Daresbury

While not strictly recipes in the Diátaxis sense, the tutorials from the DFTB+ school in Daresbury for the xTB / solvation / CompChem session should be included in the recipes.

A repository is available at https://github.com/awvwgk/daresbury, which contains source files in reStructuredText for all tutorials.

The following additional extensions are needed for a direct copy-in:

  • sphinx_design
  • sphinx_copybutton
  • sphinxcontrib.bibtex

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.