3
0
mirror of https://github.com/triqs/dft_tools synced 2024-12-22 12:23:41 +01:00
dft_tools/doc/documentation.rst
Alexander Hampel c4db7e6867 update documentation to use autosummary
* remove manual module reference files
* move hdf5 structure reference to guide
* fix various doc strings
* remove very old update_archive python script for triqs 1.2
* refine main documentation.rst file -> better overview
2022-03-02 14:13:12 -05:00

84 lines
1.0 KiB
ReStructuredText

.. module:: triqs_dft_tools
.. _documentation:
Documentation
=============
Basic notions
-------------
.. toctree::
:maxdepth: 1
basicnotions/first
basicnotions/dft_dmft
basicnotions/structure
Construction of local orbitals from DFT
---------------------------------------
.. toctree::
:maxdepth: 2
guide/conversion
h5structure
DFT+DMFT
--------
.. toctree::
:maxdepth: 2
guide/dftdmft_singleshot
guide/dftdmft_selfcons
Advanced Topics
---------------
.. toctree::
:maxdepth: 1
guide/blockstructure
guide/BasisRotation
guide/soc
Postprocessing
--------------
.. toctree::
:maxdepth: 1
guide/analysis
guide/transport
Reference manual
----------------
This is the reference manual for the python routines.
.. autosummary::
:recursive:
:toctree: _python_api
:template: autosummary_module_template.rst
block_structure
converters
sumk_dft
sumk_dft_tools
symmetry
trans_basis
FAQs
----
.. toctree::
:maxdepth: 2
faqs/faqs