Install soehyb

Compiling soehyb from source

Note

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

Prerequisites

The TRIQS library, see TRIQS installation instruction. In the following, we assume that TRIQS is installed in the directory path_to_triqs.
The pyed package (PYED: Exact diagonalization for finite quantum systems) has to be available in the python environment. This can be tested by running:
```
$ python -c "import pyed.TriqsExactDiagonalization"
```

Note

The pyed python module has to be installed manually. Trying to install it using pip will not work since there is another python module with the same name (doing something completely different) registered in the PIP package index.

Installation steps

Download the source code of the latest stable version by cloning the TRIQS/soehyb repository from GitHub:
```
$ git clone https://github.com/TRIQS/soehyb soehyb.src
```
Create and move to a new directory where you will compile the code:
```
$ mkdir soehyb.build && cd soehyb.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 ../soehyb.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 soehyb must be compatible with your TRIQS library version, see TRIQS website. 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 soehyb.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 soehyb can be configured using CMake-options:

cmake ../soehyb.src -DOPTION1=value1 -DOPTION2=value2 ...

Options	Syntax
Specify an installation path other than path_to_triqs	-DCMAKE_INSTALL_PREFIX=path_to_soehyb
Build in Debugging Mode	-DCMAKE_BUILD_TYPE=Debug
Disable testing (not recommended)	-DBuild_Tests=OFF
Build the documentation	-DBuild_Documentation=ON