3
0
mirror of https://github.com/triqs/dft_tools synced 2024-06-02 11:25:29 +02:00
dft_tools/doc/install.rst
Olivier Parcollet de15cf5267 updating doc
2013-09-01 17:56:17 +02:00

53 lines
1.5 KiB
ReStructuredText

.. highlight:: bash
Installation
============
Prerequisite
-------------------
#. The :ref:`TRIQS <triqslibs:welcome>` toolkit (see :ref:`TRIQS installation instruction <triqslibs:installation>`).
In the following, we will suppose that it is installed in the ``path_to_triqs`` directory.
#. Likely, you will also need at least one impurity solver, e.g. the The :ref:`CTHYB_matrix solver <triqscthybmatrix:welcome>`.
Installation steps
------------------
#. Download the sources of the solver from github::
$ git clone git@github.com:TRIQS/dft_tools.git src
#. Create an empty build directory where you will compile the code::
$ mkdir build && cd build
#. In the build directory call cmake specifying where the TRIQS library is installed::
$ cmake -DTRIQS_PATH=path_to_triqs ../src
#. Compile the code, run the tests and install the application::
$ make
$ make test
$ make install
Version compatibility
---------------------
Be careful that the version of the TRIQS library and of the solver must be
compatible (more information on the `TRIQS website
<http://ipht.cea.fr/triqs/versions.html>`_). If you want to use a version of
the solver that is not the latest one, go into the directory with the sources
and look at all available versions::
$ cd src && git tag
Checkout the version of the code that you want::
$ git co 1.0.0
Then follow the steps 2 to 4 described above to compile the code.