diff --git a/doc/_static/logo_cea.png b/doc/_static/logo_cea.png new file mode 100644 index 00000000..89b29641 Binary files /dev/null and b/doc/_static/logo_cea.png differ diff --git a/doc/_static/logo_cnrs.png b/doc/_static/logo_cnrs.png new file mode 100644 index 00000000..53c7af0e Binary files /dev/null and b/doc/_static/logo_cnrs.png differ diff --git a/doc/_static/logo_x.png b/doc/_static/logo_x.png new file mode 100644 index 00000000..03d2c29f Binary files /dev/null and b/doc/_static/logo_x.png differ diff --git a/doc/_templates/sideb.html b/doc/_templates/sideb.html new file mode 100644 index 00000000..6aad6bf7 --- /dev/null +++ b/doc/_templates/sideb.html @@ -0,0 +1,15 @@ +

+ CEA + Ecole Polytechnique + CNRS +

+ +

TRIQS applications

+ +

+Some applications are supported by the TRIQS collaboration, +check them out! +Note that you can obtain +bundled sources +that contain both the TRIQS library and the supported applications. +

diff --git a/doc/applications.rst b/doc/applications.rst index c6500c52..6003706f 100644 --- a/doc/applications.rst +++ b/doc/applications.rst @@ -11,7 +11,9 @@ Wien2TRIQS is an interface to Wien2k for LDA+DMFT calculation. It allows you to turn band-structure calculations obtained from the Wien2k package to inputs to full-fledged LDA+DMFT calculations in a few lines! -More info `here `_. +| *Homepage:* ``_ +| *Documentation:* ``_ +| *Installation:* ``_ Hybridization-expansion matrix solver ------------------------------------- @@ -21,7 +23,9 @@ of a quantum impurity embedded in a conduction bath. It is based on a quantum Monte Carlo algorithm that stochastically samples the diagrams of a hybridization expansion of the partition function. -More info here +| *Homepage:* ``_ +| *Documentation:* ``_ +| *Installation:* ``_ Hubbard I solver ---------------- @@ -30,4 +34,6 @@ This solver gives the Hubbard I solution of a quantum impurity problem, i.e. it solves the atomic limit. This simple approximation allows to have very quick answer even for large multiband systems. -More info here +| *Homepage:* ``_ +| *Documentation:* ``_ +| *Installation:* ``_ diff --git a/doc/authors.rst b/doc/authors.rst index 11b2b65c..cc3c0179 100644 --- a/doc/authors.rst +++ b/doc/authors.rst @@ -1,4 +1,3 @@ -:orphan: Authors ======= diff --git a/doc/bugs.rst b/doc/bugs.rst index f09722b3..9753917f 100644 --- a/doc/bugs.rst +++ b/doc/bugs.rst @@ -1,4 +1,3 @@ -:orphan: Reporting bugs ============== diff --git a/doc/conf.py.in b/doc/conf.py.in index 0b34bc9d..9884a5ff 100644 --- a/doc/conf.py.in +++ b/doc/conf.py.in @@ -35,7 +35,7 @@ extensions += [ 'matplotlib.sphinxext.only_directives', 'plot_directive', # 'matplotlib.sphinxext.ipython_directive', - # 'ipython_console_highlighting', + 'ipython_console_highlighting', # 'inheritance_diagram', 'numpydoc'] @@ -61,7 +61,7 @@ autoclass_content = "both" mathjax_path = "@MATHJAX_PATH@/MathJax.js?config=default" # Add any paths that contain templates here, relative to this directory. -#templates_path = ['@TRIQS_SOURCE_DIR@/doc/_templates'] +templates_path = ['@TRIQS_SOURCE_DIR@/doc/_templates'] # The suffix of source filenames. source_suffix = '.rst' @@ -74,7 +74,7 @@ master_doc = 'contents' # General information about the project. project = u'TRIQS' -copyright = u'2011, The TRIQS collaboration' +copyright = u'2011-2013, The TRIQS collaboration' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -83,7 +83,7 @@ copyright = u'2011, The TRIQS collaboration' # The short X.Y version. version = '1.0' # The full version, including alpha/beta/rc tags. -release = '1.0' +release = '1.0.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -144,6 +144,7 @@ doxylink = { 'doxy' : ('@CMAKE_CURRENT_BINARY_DIR@/doxy.tag', 'doxy_triqs') } #html_style = 'default.css' html_theme_path = ["@TRIQS_SOURCE_DIR@/doc/themes/"] html_theme = "triqs" +html_show_sphinx = False #html_theme_options = { "pagewidth": "80em", "documentwidth" : "60em" } @@ -166,11 +167,11 @@ html_theme = "triqs" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -#html_static_path = ['@TRIQS_SOURCE_DIR@/doc/_static'] +html_static_path = ['@TRIQS_SOURCE_DIR@/doc/_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. -html_last_updated_fmt = '%b %d, %Y' +#html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. @@ -178,6 +179,7 @@ html_last_updated_fmt = '%b %d, %Y' # Custom sidebar templates, maps document names to template names. #html_sidebars = {} +html_sidebars = {'index': ['sideb.html', 'searchbox.html']} # Additional templates that should be rendered to pages, maps page names to # template names. diff --git a/doc/contents.rst b/doc/contents.rst index f562b797..d99a9244 100644 --- a/doc/contents.rst +++ b/doc/contents.rst @@ -1,14 +1,15 @@ -.. _documentation: Table of contents ================= .. toctree:: - :maxdepth: 2 + :maxdepth: 2 + + index + install + documentation + applications + bundles + bugs + authors - overview - installation/install - tutorials/contents - reference/python/contents - reference/c++/contents - diff --git a/doc/documentation.rst b/doc/documentation.rst new file mode 100644 index 00000000..6f0fcbed --- /dev/null +++ b/doc/documentation.rst @@ -0,0 +1,29 @@ +.. _documentation: + +Documentation +============= + +A quick tour +------------ + +.. toctree:: + :maxdepth: 1 + + overview + tutorials/contents + +C++ libraries +------------- + +.. toctree:: + :maxdepth: 1 + + reference/c++/contents + +Python modules +-------------- + +.. toctree:: + :maxdepth: 1 + + reference/python/contents diff --git a/doc/index.rst b/doc/index.rst index 23235483..220dcad0 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,27 +1,51 @@ -Welcome to TRIQS -================ +.. _welcome: + +Welcome +======= TRIQS is a scientific project that provides a set of tools for the study of interacting quantum systems. It allows to quickly implement many-body calculations and explore new theoretical and phenomenological ideas within a flexible, easy-to-use python environment (à la Matlab). -Documentation -============= +Powerful c++ libraries +---------------------- -Link to :ref:`documentation `. +.. code-block:: c++ -TRIQS-based applications -======================== + #include + #include + #include -Some applications are supported by the TRIQS collaboration. -Link to :ref:`applications `. + using triqs::arrays::array; using triqs::arrays::matrix; using triqs::clef::placeholder; + int main(){ + placeholder<0> i_; + placeholder<1> j_; + matrix A(2,2); + A(i_,j_) << i_+j_; -Download -======== + matrix B = inverse(A); + double C = determinant(A); -From git as described in :ref:`install `. + std::cout << "A^(-1) = "<< B << std::endl; + std::cout << "det(A) = " <` which provides both the -TRIQS library and all supported applications. +User-friendly python interface +------------------------------ +.. plot:: + :include-source: + :scale: 70 + + from pytriqs.gf.local import * + g = GfReFreq(indices = ['s','d'], window = [-2,2], n_points = 1000) + g['d','d'] = Omega - 0.3 + g['d','s'] = 0.2 + g['s','d'] = 0.2 + g['s','s'] = inverse( Wilson(1.0) ) + g.invert() + + from pytriqs.plot.mpl_interface import oplot + oplot( g['d','d'], '-o', RI = 'S', x_window = (-1.8,1.8), name = "Impurity" ) + oplot( g['s','s'], '-x', RI = 'S', x_window = (-1.8,1.8), name = "Bath" ) diff --git a/doc/reference/c++/contents.rst b/doc/reference/c++/contents.rst index 68cf7292..92eb29f5 100644 --- a/doc/reference/c++/contents.rst +++ b/doc/reference/c++/contents.rst @@ -1,5 +1,6 @@ -C++ librairies -########################## + +C++ libraries +============= .. toctree:: :maxdepth: 1 @@ -13,3 +14,4 @@ C++ librairies parameters/parameters lectures/contents utilities/contents + diff --git a/doc/reference/c++/intro.rst b/doc/reference/c++/intro.rst deleted file mode 100644 index 5061ae0b..00000000 --- a/doc/reference/c++/intro.rst +++ /dev/null @@ -1,8 +0,0 @@ -* At lower level, a few general purpose libraries in Python and C++, e.g. : - - * A new C++ multi-dimensional array library (triqs::arrays). - * A simple dictionary-like python :ref:`interface to HDF5 files`, which is the main data format in TRIQS. - * A thin :ref:`interface to matplotlib` to visualize various objects via the definition of a :ref:`plot protocol`. - - - diff --git a/doc/reference/python/contents.rst b/doc/reference/python/contents.rst index 1b298624..e6699640 100644 --- a/doc/reference/python/contents.rst +++ b/doc/reference/python/contents.rst @@ -1,23 +1,12 @@ -.. role:: red - -.. index:: contents - -.. _contents: - Python libraries -================================ +================ .. toctree:: - :maxdepth: 2 + :maxdepth: 1 - introduction/introduction - install/install green/green + operators/operators lattice/lattice data_analysis/contents - solvers/solvers - wien2k/wien2k - faq/faq - collaboration/collaboration - legal/legal + diff --git a/doc/themes/triqs/layout.html b/doc/themes/triqs/layout.html index ac29452c..f2c03ddc 100644 --- a/doc/themes/triqs/layout.html +++ b/doc/themes/triqs/layout.html @@ -34,11 +34,10 @@ {% endblock %} {% block rootrellink %} - {% if hasdoc('index') %} -
  • Home |
    • -
  • Documentation »
    • + {% if hasdoc('documentation') %} +
  • Home »
    • {% else %} -
  • Documentation »
    • +
  • Documentation »
    • {% endif %} {% endblock %} @@ -46,15 +45,12 @@
    - {% if hasdoc('index') %} -

    TRIQS

    - {% else %} -

    TRIQS

    - {% endif %} +

    TRIQS

    a Toolbox for Research on Interacting Quantum Systems
    diff --git a/doc/tutorials/contents.rst b/doc/tutorials/contents.rst index fb281c53..4ac0aa87 100644 --- a/doc/tutorials/contents.rst +++ b/doc/tutorials/contents.rst @@ -4,7 +4,6 @@ Tutorials .. toctree:: :maxdepth: 2 - intro python/introduction c++/contents diff --git a/doc/tutorials/python/introduction.rst b/doc/tutorials/python/introduction.rst index c25a27ed..644431e6 100644 --- a/doc/tutorials/python/introduction.rst +++ b/doc/tutorials/python/introduction.rst @@ -36,5 +36,6 @@ The goal is not to explain them here in details but to quickly show some of TRIQ tour2 tour3 tour4 + ipt/ipt reading