Welcome to the AiiDA-FLEUR’s documentation!¶
The aiida-fleur python package enables the use of the all-electron Density functional theory (DFT) code Fleur (http://www.flapw.de) with the AiiDA framework (http://www.aiida.net). This enables Many-task/High-throuput electronic structure simulations with an all-electron DFT code. The package contains plugins for the FLEUR code, inputgenerator and a datastructure. Further it contains basic workflows and utility. It is open source under the MIT license and is available under (https://github.com/broeder-j/aiida-fleur). The package is developed within the MaX EU Center of Excellence (www.max-center.eu) at Forschungszentrum Jülich GmbH (http://www.fz-juelich.de/pgi/pgi-1/DE/Home/home_node.html), (IAS-1/PGI-1), Germany. Check out the AiiDA registry to find out more about what other packages for AiiDA exists, that might be helpful for you. Further the aiida-fleur package contains AiiDA dependend tools around the workflows and plugins. All tools independend on aiida-core are moved to the masci-tools repository.
If you use this package please cite:
- for the plugin and workflows: (to be published)
- for fleur: http:/www.flapw.de
Features, Illustrations, Usage examples:¶
Example 1, Full Provenance tracking trough AiiDA:
AiiDA graph visualization of a small database containing about 130 000 nodes from Fleur calculations. (Visualized with Gephi)
Example 2, Material screening:
Fleur SCF convergence of 1362 different screened Binary systems managed by the scf workchain
Example 3 Method robustness, tuning:
FLAPW muffin tin radii for all materials (>820000) in the OQMD .
Example 4, DFT Code Interoperability:
If an DFT code has an AiiDA plugin, one can run successiv calculations with different codes. For example perform a structure relaxation with VASP or Quantum Espresso and run some all-electron FLEUR workflow on the output structure.
Example 5, Quick Visualizations:
AiiDA-FLEUR contains one function (‘plot_fleur’) to get a quick visualization of some database node(s). For example quick convergence plot of one or several SCF runs in your scripts, or notebook.:
Some projects which used aiida-fleur include: …
Requirements to use this code:¶
- A running AiiDA version (and postgresql database)
- Executables of the Fleur code
Other packages (in addition to all requirements of AiiDA):
Install from pypi the latest release:
$ pip install aiida-fleur
or from the aiida-fleur source folder any branch:
$ pip install . # or which is very useful to keep track of the changes (developers) $ pip install -e .
- Fleur input generator (link)
- FleurinpData structure (link)
- Fleur code (link)
The overall plugin for Fleur consists out of three AiiDA plugins. One for the Fleur input generator (inpgen), one datastructure (fleurinpData) representing the inp.xml file and a plugin for the Fleur code (fleur, fleur_MPI). See www.flapw.de. Other codes from the Fleur family (GFleur) or which build ontop (Spex) are not supported.
The package also contains workflows
- Fleur scf
- Fleur dos
- Fleur band
- Fleur eos
- Fleur initial corelevel shifts
- Fleur corehole
Further the package contains AiiDA dependend tools around the workflows and plugins. All tools independend on aiida-core are moved to the masci-tools repository, to be available to other non AiiDA related projects and tools.
We acknowledge partial support from the EU Centre of Excellence “MaX – Materials Design at the Exascale” (http://www.max-centre.eu). (Horizon 2020 EINFRA-5, Grant No. 676598) We thank the AiiDA team for their help and work. Also the vial exchange with developers of AiiDA packages for other codes was inspireing.
Everything you need for using AiiDA-FLEUR
- User’s guide
- Getting started
- AiiDA FLEUR Code and Data Plugins
- Fleur input generator plugin
- FLEUR code plugin
- Basic Workflows
- General design
- Fleur self-consistency field workflow
- Fleur dos/band workflows
- Fleur equation of states (eos) workflows
- More advanced Workflows
- Fleur initial core-level shifts workflow
- Fleur core-hole workflow
- Verdi command line extentions
Some things to notice for AiiDA-FLEUR developers. Conventions, programming style, Integrated testing, things that should not be forgotten
Module reference (API)¶
Automatic generated documentation for all modules, classes and functions with reference to the source code. The search is your friend.
- Source code Documentation (API reference)
- Fleur input generator plug-in
- Fleur-code plugin
- Fleur input Data structure
- Fleur tools/utility