3
0
mirror of https://github.com/triqs/dft_tools synced 2024-12-14 00:13:44 +01:00

[doc] Update of install instructions, added changelog

This commit is contained in:
Nils Wentzell 2018-06-04 15:56:47 -04:00
parent 67957c3c06
commit 2632f2c87f
5 changed files with 22 additions and 5 deletions

View File

@ -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)}

View File

@ -8,4 +8,5 @@ Table of contents
install
documentation
issues
changelog
about

View File

@ -21,7 +21,7 @@ Wien2k + dmftproj
:ref:`conversion`, or the extensive :download:`dmftproj manual<images_scripts/TutorialDmftproj.pdf>`.
In the following, we discuss how to use the
:ref:`TRIQS <triqslibs:install>` tools in combination with the :program:`Wien2k` program.
:ref:`TRIQS <triqslibs:installation>` 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

View File

@ -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 <changelog>`
This :ref:`TRIQS-based <triqslibs:welcome>`-based application is aimed
at ab-initio calculations for
correlated materials, combining realistic DFT band-structure

View File

@ -1,10 +1,21 @@
.. highlight:: bash
Installation
============
.. _install:
Packaged Versions of DftTools
=============================
A Docker image including the latest version of DftTools is available `here <https://hub.docker.com/r/flatironinstitute/triqs>`_. For more information, please see the page on :ref:`TRIQS Docker <triqslibs: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 <triqslibs:triqs_debian>`, and the subsequent command::
sudo apt-get install -y dft_tools
Compiling DftTools from source
==============================
Prerequisites
-------------