LCPQ/dft_tools
3
0
Fork 0
mirror of https://github.com/triqs/dft_tools synced 2024-12-23 04:43:42 +01:00
Code Issues Releases Wiki Activity

[doc] Synchronize install page with qmc solvers

Browse Source
This commit is contained in:
Nils Wentzell 2019-04-16 15:04:04 -04:00
parent 57c5c8a892
commit 00b940dc17
1 changed files with 34 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
doc/install.rst
View File

@ -2,32 +2,32 @@
.. _install:
Installation
============
Compiling AP4TRIQS from source
==============================
Prerequisite
-------------------
#. The :ref:`TRIQS <triqslibs:welcome>` toolbox (see :ref:`TRIQS installation instruction <triqslibs:installation>`).
In the following, we will suppose that it is installed in the ``path_to_triqs`` directory.
#. The :ref:`TRIQS <triqslibs:welcome>` library, see :ref:`TRIQS installation instruction <triqslibs:installation>`.
In the following, we assume that Triqs is installed in the ``path_to_triqs`` directory.
Installation steps
------------------
#. Download the sources from github::
#. Download the source code of the latest stable version by cloning the ``TRIQS/app4triqs`` repository from GitHub::
$ git clone https://github.com/triqs/app4triqs.git app4triqs.src
$ git clone https://github.com/TRIQS/app4triqs app4triqs.src
#. Create an empty build directory where you will compile the code::
#. Create and move to a new directory where you will compile the code::
$ mkdir app4triqs.build && cd app4triqs.build
#. Make sure that you have added the TRIQS and Cpp2Py installation to your environment variables::
#. Ensure that your shell contains the TRIQS environment variables by sourcing the ``triqsvars.sh`` file from your TRIQS installation::
$ source path_to_triqs/share/triqsvarsh.sh
#. In the build directory call cmake::
#. In the build directory call cmake, including any additional custom CMake options, see below::
$ cmake ../app4triqs.src
@ -40,22 +40,36 @@ Installation steps
Version compatibility
---------------------
Be careful that the version of the TRIQS library and of the solver must be
Be careful that the version of the TRIQS library and of the application must be
compatible (more information on the :ref:`TRIQS website <triqslibs:versions>`).
As app4triqs is still in alpha phase (unstable), it can only be compiled against the
unstable branch of triqs.
In particular you should make sure that the Major and Minor Version number
of the application and TRIQS agree.
If you want to use a particular version of the application, go into the directory with the sources
and look at all available versions::
$ cd app4triqs.src && git tag
Checkout the version of the code that you want::
$ git checkout 2.1.0
Then follow the steps 2 to 4 described above to compile the code.
Custom CMake options
--------------------
Functionality of ``app4triqs`` can be tweaked using extra compile-time options passed to CMake::
cmake -DOPTION1=value1 -DOPTION2=value2 ... ../app4triqs.src
cmake ../app4triqs.src -DOPTION1=value1 -DOPTION2=value2 ... ../app4triqs.src
+-----------------------------------------------------------------------+-----------------------------------------------+
| Options | Syntax |
+=======================================================================+===============================================+
| Specify an installation path other than path_to_triqs | -DCMAKE_INSTALL_PREFIX=path_to_app4triqs |
+-----------------------------------------------------------------------+-----------------------------------------------+
| Build the documentation locally | -DBuild_Documentation=ON |
+-----------------------------------------------------------------------+-----------------------------------------------+
+-----------------------------------------------------------------+-----------------------------------------------+
| Options | Syntax |
+=================================================================+===============================================+
| Specify an installation path other than path_to_triqs | -DCMAKE_INSTALL_PREFIX=path_to_app4triqs |
+-----------------------------------------------------------------+-----------------------------------------------+
| Build in Debugging Mode | -DCMAKE_BUILD_TYPE=Debug |
+-----------------------------------------------------------------+-----------------------------------------------+
| Disable testing (not recommended) | -DBuild_Tests=OFF |
+-----------------------------------------------------------------+-----------------------------------------------+
| Build the documentation | -DBuild_Documentation=ON |
+-----------------------------------------------------------------+-----------------------------------------------+