mirror of
https://github.com/triqs/dft_tools
synced 2024-12-25 05:43:40 +01:00
edd1ff4529
A first general restructuration of the doc according to the pattern [tour|tutorial|reference]. In the reference part, objects are documented per topic. In each topic, [definition|c++|python|hdf5] (not yet implemented)
80 lines
1.3 KiB
ReStructuredText
80 lines
1.3 KiB
ReStructuredText
.. _documentation:
|
|
|
|
Documentation
|
|
=============
|
|
|
|
A quick tour
|
|
------------
|
|
|
|
A little tour of some aspects of TRIQS and its applications, at the Python level.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
tour/getting_started/get_started
|
|
tour/green
|
|
tour/tight_binding
|
|
tour/ctqmc
|
|
tour/dmft
|
|
tour/ipt
|
|
|
|
|
|
Tutorials
|
|
----------
|
|
|
|
Learn how to use TRIQS step by step, both in Python and c++ !
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
tutorials/gfs_tutorial
|
|
tutorials/array_tutorial
|
|
tutorials/det_manip_tutorial
|
|
|
|
|
|
Reference manual
|
|
-----------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
reference/using_the_lib/contents
|
|
|
|
Code reference
|
|
~~~~~~~~~~~~~~~~
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
reference/gfs/contents
|
|
reference/lattice_tools/contents
|
|
reference/plotting_protocols/contents
|
|
reference/montecarlo/contents
|
|
reference/operators/contents
|
|
reference/random_generator/contents
|
|
reference/arrays/contents
|
|
reference/clef/contents
|
|
reference/hdf5/contents
|
|
reference/determinant_manipulation/contents
|
|
reference/statistical_analysis/contents
|
|
|
|
|
|
Developer tools
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
reference/conventions
|
|
reference/using_the_lib/profiling
|
|
reference/wrap_generator/contents
|
|
reference/utilities/contents
|
|
|
|
Version compatibility
|
|
---------------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
versions
|
|
|