Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/JuliaMolSim/DFTK.jl

Density-functional toolkit
https://github.com/JuliaMolSim/DFTK.jl

ab-initio computational-chemistry density-functional-theory electronic-structure julia kohn-sham materials-science mathematical-analysis numerical-analysis plane-wave toolkit

Last synced: about 2 months ago
JSON representation

Density-functional toolkit

Awesome Lists containing this project

README 

        
dftk logo



# Density-functional toolkit



| **Documentation**                                                                 | **Build Status**                                |  **License**                     |

|:--------------------------------------------------------------------------------- |:----------------------------------------------- |:-------------------------------- |

| [![][docs-img]][docs-url] [![][ddocs-img]][ddocs-url] [![][chat-img]][chat-url] | [![][ci-img]][ci-url] [![][cigpu-img]][cigpu-url] [![][ccov-img]][ccov-url] | [![][license-img]][license-url]  |



[ddocs-img]: https://img.shields.io/badge/docs-dev-blue.svg

[ddocs-url]: https://docs.dftk.org/dev



[docs-img]: https://img.shields.io/badge/docs-stable-blue.svg

[docs-url]: https://docs.dftk.org/stable



[chat-img]: https://img.shields.io/badge/chat-on_zulip-808493.svg?logo=zulip

[chat-url]: https://juliamolsim.zulipchat.com/#narrow/stream/332493-dftk



[ci-img]: https://github.com/JuliaMolSim/DFTK.jl/workflows/CI/badge.svg?branch=master&event=push

[ci-url]: https://github.com/JuliaMolSim/DFTK.jl/actions



[cigpu-img]: https://git.uni-paderborn.de/herbstm/DFTK.jl/badges/master/pipeline.svg?key_text=GPU%20CI

[cigpu-url]: https://git.uni-paderborn.de/herbstm/DFTK.jl/-/pipelines



[ccov-img]: https://codecov.io/gh/JuliaMolSim/DFTK.jl/branch/master/graph/badge.svg?token=A23M0VZ8PQ

[ccov-url]: https://codecov.io/gh/JuliaMolSim/DFTK.jl



[license-img]: https://img.shields.io/github/license/JuliaMolSim/DFTK.jl.svg?maxAge=2592000

[license-url]: https://github.com/JuliaMolSim/DFTK.jl/blob/master/LICENSE



The density-functional toolkit, **DFTK** for short, is a collection of

Julia routines for experimentation with plane-wave density-functional theory (DFT).

The unique feature of this code is its emphasis on simplicity and flexibility

with the goal of facilitating algorithmic and numerical developments as well as

interdisciplinary collaboration in solid-state research.



Having started in 2019 we already support a

[sizeable set of features](https://docs.dftk.org/stable/features/).

Within the system size currently accessible to our code (ca. 1000 electrons)

our performance is of the same order of magnitude as more established packages

such as [Abinit](https://www.abinit.org/) or

[Quantum Espresso](http://quantum-espresso.org/).



For getting started with DFTK, see [our documentation](https://docs.dftk.org):

- [Installation instructions](https://docs.dftk.org/stable/guide/installation/)

- [Tutorial](https://docs.dftk.org/stable/guide/tutorial/)

- [Basic DFT examples](https://docs.dftk.org/stable/examples/metallic_systems/)



Note that at least **Julia 1.9** is required.



## Support and citation

DFTK is mostly developed as part of academic research.

Parts of DFTK have also been discussed in published papers.

If you use our code as part of your research, teaching or other activities,

we would be grateful if you cite them as appropriate.

See the [CITATION.bib](CITATION.bib) in the root of this repo for relevant references.

The current DFTK reference paper to cite is

[![DOI](https://img.shields.io/badge/DOI-10.21105/jcon.00069-blue)](https://doi.org/10.21105/jcon.00069).



## Funding

This project has received funding from the

[Institute of computing and data sciences (ISCD, Sorbonne Université)](https://iscd.sorbonne-universite.fr/),

[École des Ponts ParisTech](https://enpc.fr),

[Inria Research Centre Paris](https://www.inria.fr/fr/centre-inria-de-paris),

[RWTH Aachen University](https://rwth-aachen.de/),

[Swiss National Science Foundation](https://snf.ch/),

and from the European Research Council (ERC) under the European Union's Horizon 2020 research and

innovation program ([grant agreement No 810367](https://cordis.europa.eu/project/id/810367)).



## Contributing

If you stumble across issues in using DFTK

or have suggestions for future developments

we are more than happy to hear about it.

In this case please [open an issue](https://github.com/JuliaMolSim/DFTK.jl/issues)

or contact us ([@mfherbst](https://github.com/mfherbst)

and [@antoine-levitt](https://github.com/antoine-levitt)) directly.



Contributions to the code in any form is very welcome,

just [submit a pull request](https://github.com/JuliaMolSim/DFTK.jl/pulls)

on github. If you want to contribute but are unsure where to start, take a look

at the list of issues tagged [good first issue](https://github.com/JuliaMolSim/DFTK.jl/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)

(relatively easy tasks suitable for newcomers) or [help wanted](https://github.com/JuliaMolSim/DFTK.jl/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)

(more sizeable but well-defined and isolated).

Don't hesitate to ask for help, through github,

email or the [JuliaMolSim zulip][chat-url] channel `#dftk`.