From 2632f2c87f36a804f16479ad4ff3947e207f622a Mon Sep 17 00:00:00 2001 From: Nils Wentzell Date: Mon, 4 Jun 2018 15:56:47 -0400 Subject: [PATCH] [doc] Update of install instructions, added changelog --- doc/conf.py.in | 2 +- doc/contents.rst | 1 + doc/guide/dftdmft_selfcons.rst | 2 +- doc/index.rst | 5 +++++ doc/install.rst | 17 ++++++++++++++--- 5 files changed, 22 insertions(+), 5 deletions(-) diff --git a/doc/conf.py.in b/doc/conf.py.in index 2f62391a..28bd6796 100644 --- a/doc/conf.py.in +++ b/doc/conf.py.in @@ -38,4 +38,4 @@ html_sidebars = {'index': ['sideb.html', 'searchbox.html']} htmlhelp_basename = 'TRIQSDftToolsdoc' -intersphinx_mapping = {'python': ('http://docs.python.org/2.7', None), 'triqslibs': ('http://triqs.github.io/triqs', None), 'triqscthyb': ('https://triqs.github.io/cthyb', None)} +intersphinx_mapping = {'python': ('http://docs.python.org/2.7', None), 'triqslibs': ('http://triqs.github.io/triqs/master', None), 'triqscthyb': ('https://triqs.github.io/cthyb/master', None)} diff --git a/doc/contents.rst b/doc/contents.rst index 6afdfc3f..4f990b6a 100644 --- a/doc/contents.rst +++ b/doc/contents.rst @@ -8,4 +8,5 @@ Table of contents install documentation issues + changelog about diff --git a/doc/guide/dftdmft_selfcons.rst b/doc/guide/dftdmft_selfcons.rst index e3288e72..83572ed0 100644 --- a/doc/guide/dftdmft_selfcons.rst +++ b/doc/guide/dftdmft_selfcons.rst @@ -21,7 +21,7 @@ Wien2k + dmftproj :ref:`conversion`, or the extensive :download:`dmftproj manual`. In the following, we discuss how to use the -:ref:`TRIQS ` tools in combination with the :program:`Wien2k` program. +:ref:`TRIQS ` tools in combination with the :program:`Wien2k` program. We can use the DMFT script as introduced in section :ref:`singleshot`, with just a few simple diff --git a/doc/index.rst b/doc/index.rst index 32d930ab..3523ad2a 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -7,6 +7,11 @@ DFTTools ======== +.. sidebar:: DftTools 1.5 + + This is the homepage DftTools Version 1.5 + For the changes in DftTools, Cf :ref:`changelog page ` + This :ref:`TRIQS-based `-based application is aimed at ab-initio calculations for correlated materials, combining realistic DFT band-structure diff --git a/doc/install.rst b/doc/install.rst index a9dbf263..0352ba33 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -1,10 +1,21 @@ - .. highlight:: bash -Installation -============ +.. _install: +Packaged Versions of DftTools +============================= + +A Docker image including the latest version of DftTools is available `here `_. For more information, please see the page on :ref:`TRIQS Docker `. + +We further provide a Debian package for the Ubuntu LTS Versions 16.04 (xenial) and 18.04 (bionic), which can be installed by following the steps outlined :ref:`here `, and the subsequent command:: + + sudo apt-get install -y dft_tools + + +Compiling DftTools from source +============================== + Prerequisites -------------