mirror of
https://github.com/triqs/dft_tools
synced 2024-10-31 11:13:46 +01:00
79789512bf
Co-authored-by: Dylan Simon <dylan@dylex.net> Co-authored-by: Alexander Hampel <ahampel@flatironinstitute.org>
78 lines
3.3 KiB
ReStructuredText
78 lines
3.3 KiB
ReStructuredText
.. highlight:: bash
|
|
|
|
.. _install:
|
|
|
|
Install app4triqs
|
|
*******************
|
|
|
|
Compiling app4triqs from source
|
|
===============================
|
|
|
|
.. note:: To guarantee reproducibility in scientific calculations we strongly recommend the use of a stable `release <https://github.com/TRIQS/triqs/releases>`_ of both TRIQS and its applications.
|
|
|
|
Prerequisites
|
|
-------------
|
|
|
|
#. The :ref:`TRIQS <triqslibs:welcome>` library, see :ref:`TRIQS installation instruction <triqslibs:installation>`.
|
|
In the following, we assume that TRIQS is installed in the directory ``path_to_triqs``.
|
|
|
|
Installation steps
|
|
------------------
|
|
|
|
#. Download the source code of the latest stable version by cloning the ``TRIQS/app4triqs`` repository from GitHub::
|
|
|
|
$ git clone https://github.com/TRIQS/app4triqs app4triqs.src
|
|
|
|
#. Create and move to a new directory where you will compile the code::
|
|
|
|
$ mkdir app4triqs.build && cd app4triqs.build
|
|
|
|
#. Ensure that your shell contains the TRIQS environment variables by sourcing the ``triqsvars.sh`` file from your TRIQS installation::
|
|
|
|
$ source path_to_triqs/share/triqs/triqsvars.sh
|
|
|
|
#. In the build directory call cmake, including any additional custom CMake options, see below::
|
|
|
|
$ cmake ../app4triqs.src
|
|
|
|
#. Compile the code, run the tests and install the application::
|
|
|
|
$ make
|
|
$ make test
|
|
$ make install
|
|
|
|
Version compatibility
|
|
---------------------
|
|
|
|
Keep in mind that the version of ``app4triqs`` must be compatible with your TRIQS library version,
|
|
see :ref:`TRIQS website <triqslibs:versions>`.
|
|
In particular the Major and Minor Version numbers have to be the same.
|
|
To use a particular version, 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
|
|
|
|
and follow steps 2 to 4 above to compile the code.
|
|
|
|
Custom CMake options
|
|
--------------------
|
|
|
|
The compilation of ``app4triqs`` can be configured using CMake-options::
|
|
|
|
cmake ../app4triqs.src -DOPTION1=value1 -DOPTION2=value2 ...
|
|
|
|
+-----------------------------------------------------------------+-----------------------------------------------+
|
|
| 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 |
|
|
+-----------------------------------------------------------------+-----------------------------------------------+
|