Skip to content

Files

64 lines (41 loc) · 2.58 KB

install.rst

File metadata and controls

64 lines (41 loc) · 2.58 KB

Install nda

Compiling nda from source

Note

To guarantee reproducibility in scientific calculations we strongly recommend the use of a stable release of both TRIQS and its applications.

Installation steps

  1. Download the source code of the latest stable version by cloning the TRIQS/nda repository from GitHub:

    $ git clone https://github.com/TRIQS/nda nda.src
  2. Create and move to a new directory where you will compile the code:

    $ mkdir nda.build && cd nda.build
  3. In the build directory call cmake, including any additional custom CMake options, see below:

    $ cmake -DCMAKE_INSTALL_PREFIX=path_to_install_dir ../nda.src
  4. Compile the code, run the tests and install the application:

    $ make
    $ make test
    $ make install

Versions

To use a particular version, go into the directory with the sources, and look at all available versions:

$ cd nda.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 nda can be configured using CMake-options:

cmake ../nda.src -DOPTION1=value1 -DOPTION2=value2 ...
Options Syntax
Specify an installation path -DCMAKE_INSTALL_PREFIX=path_to_nda
Build in Debugging Mode -DCMAKE_BUILD_TYPE=Debug
Disable testing (not recommended) -DBuild_Tests=OFF
Build the documentation -DBuild_Documentation=ON