dft_tools/doc/documentation.rst

.. 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
   util


FAQs
----

.. toctree::
   :maxdepth: 2

   faqs/faqs
Updating import directives, minor correction to commit 2018-05-01 11:55:31 +02:00			`.. module:: triqs_dft_tools`
updating doc 2013-09-01 17:56:17 +02:00
			`.. _documentation:`

			`Documentation`
			`=============`

[doc] New documentation * restructuring * added user reference * started working on user guide * added schematic to structure 2015-03-12 00:01:12 +01:00			`Basic notions`
			`-------------`

			`.. toctree::`
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-01 23:51:39 +01:00			`:maxdepth: 1`
[doc] New documentation * restructuring * added user reference * started working on user guide * added schematic to structure 2015-03-12 00:01:12 +01:00
[doc] Restructuring doc II * Committing missing files of last commit * Correcting typos * Modifications according to issue #56 2016-07-08 12:04:31 +02:00			`basicnotions/first`
[doc] New documentation * restructuring * added user reference * started working on user guide * added schematic to structure 2015-03-12 00:01:12 +01:00			`basicnotions/dft_dmft`
			`basicnotions/structure`


new structure for doc 2018-08-06 11:44:41 +02:00			`Construction of local orbitals from DFT`
			`---------------------------------------`
updating doc 2013-09-01 17:56:17 +02:00
			`.. toctree::`
[doc] New documentation * restructuring * added user reference * started working on user guide * added schematic to structure 2015-03-12 00:01:12 +01:00			`:maxdepth: 2`

			`guide/conversion`
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-01 23:51:39 +01:00			`h5structure`
new structure for doc 2018-08-06 11:44:41 +02:00

			`DFT+DMFT`
			`--------`

			`.. toctree::`
			`:maxdepth: 2`

[doc] New documentation * restructuring * added user reference * started working on user guide * added schematic to structure 2015-03-12 00:01:12 +01:00			`guide/dftdmft_singleshot`
			`guide/dftdmft_selfcons`
Reshuffled doc on SOC and Basisrotations 2020-02-24 15:42:28 +01:00
			`Advanced Topics`
			`---------------`

			`.. toctree::`
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-01 23:51:39 +01:00			`:maxdepth: 1`
Reshuffled doc on SOC and Basisrotations 2020-02-24 15:42:28 +01:00
[doc] First draft of the blockstructure documentation 2020-02-26 14:06:01 +01:00			`guide/blockstructure`
small bugfix with capital letters in BasisRotation 2020-02-24 15:59:28 +01:00			`guide/BasisRotation`
Reshuffled doc on SOC and Basisrotations 2020-02-24 15:42:28 +01:00			`guide/soc`
new structure for doc 2018-08-06 11:44:41 +02:00
			`Postprocessing`
			`--------------`

			`.. toctree::`
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-01 23:51:39 +01:00			`:maxdepth: 1`
new structure for doc 2018-08-06 11:44:41 +02:00
removed conversion step from dmft single-shot description 2015-08-14 13:53:40 +02:00			`guide/analysis`
[doc] New documentation * restructuring * added user reference * started working on user guide * added schematic to structure 2015-03-12 00:01:12 +01:00			`guide/transport`

updating doc 2013-09-01 17:56:17 +02:00
First draft of reference manual 2014-10-28 09:34:34 +01:00			`Reference manual`
			`----------------`

			`This is the reference manual for the python routines.`

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-01 23:51:39 +01:00			`.. autosummary::`
			`:recursive:`
			`:toctree: _python_api`
			`:template: autosummary_module_template.rst`

			`block_structure`
			`converters`
			`sumk_dft`
			`sumk_dft_tools`
			`symmetry`
			`trans_basis`
[doc] add util module to autodoc 2023-09-03 11:24:56 +02:00			`util`
First draft of reference manual 2014-10-28 09:34:34 +01:00
[doc] New documentation * restructuring * added user reference * started working on user guide * added schematic to structure 2015-03-12 00:01:12 +01:00
First draft of reference manual 2014-10-28 09:34:34 +01:00
[doc] New documentation * restructuring * added user reference * started working on user guide * added schematic to structure 2015-03-12 00:01:12 +01:00			`FAQs`
			`----`

			`.. toctree::`
			`:maxdepth: 2`
First draft of reference manual 2014-10-28 09:34:34 +01:00
[doc] New documentation * restructuring * added user reference * started working on user guide * added schematic to structure 2015-03-12 00:01:12 +01:00			`faqs/faqs`