3
0
mirror of https://github.com/triqs/dft_tools synced 2024-11-01 11:43:47 +01:00
Commit Graph

16 Commits

Author SHA1 Message Date
tayral
edd1ff4529 Restructuring documentation.
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)
2014-10-18 12:21:08 +01:00
tayral
880f30b086 Changed all literalincludes --> runblock / triqs_example
This is to avoid keeping code snippets that do not work in the doc. At least there will be an error message.
2014-10-17 16:50:46 +01:00
Olivier Parcollet
4af1afbdaf hdf5 : clean up
- For users : only change is :
   H5::H5File in apps. to be replaced by triqs::h5::file, same API.

- using only the C API because :
   - it is cleaner, better documented, more examples.
   - it is the native hdf5 interface.
   - simplify the installation e.g. on mac. Indeed, hdf5 is
     usually installed without C++ interface, which is optional.
     E.g. EPD et al., brew by default.
     Also the infamous mpi+ hdf5_cpp bug, for which we have no clean solution.

- clean the notion of parent of a group. Not needed, better iterate function in C LT API.
- modified doc : no need for C++ bindings any more.
- modified cmake to avoid requiring CPP bindings.
2014-06-22 13:57:47 +02:00
Olivier Parcollet
3fe400d34c doc : split c++ code from rst
- examples split from the rst file using a python script (split_code).
- Final result for the doc is unchanged.
- examples are compiled and tested with the other tests.
- examples' code have been clang-formatted, with triqs style.
- doc compiles much faster, and with the same options as the rest of the
  test.
- examples are added as tests, so they are run by make test, as simple C
  tests.
- done for the tutorials and the reference.
- autocompile removed (changed into triqs_example directive).
- add triqs_example :
   - make a literal include of the source code.
   - runs the compiled example
   - add, as before, the result to the source code in the doc.
- added the script split_code, used to make the changes automatically,
  maybe for later reuse. (in _tools)
2014-05-31 23:00:16 +02:00
tayral
2a71d2e54a Changed format of requirement warning in doc
- now more visible
- also added link to applications page
2014-02-18 16:16:14 +01:00
Laura Messio
3437c2dfe9 doc: small tutorial for the GF's 2014-01-20 17:49:47 +01:00
tayral
cd77520a78 Add doc for tightbinding and bravaislattice. 2013-12-31 15:26:20 +01:00
Michel Ferrero
f7fad85fca Iteration over the doc
This is an iteration over the doc mainly thank to Priyanka.
I fixed another couple of details on the way.
2013-12-31 14:22:00 +01:00
Laura Messio
67a1a7c079 doc: cookbooks from det_manip and arrays harmonized 2013-12-18 15:50:18 +01:00
Michel Ferrero
28140f14fb Work on documentation
Mainly on the python part. I had a quick browse through to check if
the scripts were still working.
2013-09-17 14:55:55 +02:00
tayral
e0f0c85c3d doc: fixed a few typos+ put back tutorial for arrays+changed a few titles 2013-09-13 17:46:51 +02:00
Olivier Parcollet
9dc4e0f8cc doc: git only in html mode 2013-09-06 16:00:13 +02:00
Olivier Parcollet
3305185bee Work on doc
- remove empty parts, start to clean the tour.
- added export of _template and _static to reuse in appli doc.
- clean tutorial part. rm cookbook.
2013-08-31 15:22:36 +02:00
Michel Ferrero
768f537f4d Work on documentation
Included logos, added docuentation thumbnail and organized contents
in a way that navigating in the python and c++ reference will be
easier. Applications appear in a special sidebar.
2013-08-28 10:19:34 +02:00
Michel Ferrero
e90bd92d99 Add documentation about operators and IPT
new file:   doc/reference/python/operators/
  new file:   doc/tutorials/python/ipt/
2013-08-21 10:12:15 +02:00
Olivier Parcollet
f2c7d449cc First commit : triqs libs version 1.0 alpha1
for earlier commits, see TRIQS0.x repository.
2013-07-17 19:24:07 +02:00