Skip to content
Snippets Groups Projects
Commit 34fa0f7a authored by Antonio Ragagnin's avatar Antonio Ragagnin :speech_balloon:
Browse files

Update install_and_test.md

parent 2eae7f2d
No related branches found
No related tags found
No related merge requests found
......@@ -23,6 +23,25 @@ To run the C and python tests of the installed `hotwheels` components, run:
python -m hotwheels.checkup hotwheels
```
## Environment variables
Here below some relevant environment variables to change hotwheels default settings:
| Environment Variable | Description |
|----------------------|-------------------------------------------------------------------------------------------------------|
| `CC` | C compiler (defaults to `gcc`). |
| `MPICC` | MPI C compiler (defaults to `mpicc`). |
| `CXX` | C++ compiler (defaults to `g++`). |
| `MPICXX` | MPI C++ compiler (defaults to `mpicxx`). |
| `HW_BUILD` | Folder with runtime-generated headers, and C/C++ compiled object files. |
| `HW_DATA` | Folder where downloaded test initial conditions (ICs) should be placed. |
| `DEBUG` | Set to `1` to enable additional verbose output for debugging purposes. |
| `C_INCLUDE_PATH` | *(used by the gnu compiler)* Search path for C headers, should include paths for required libraries like `gsl` and `fftw3`. |
| `CPLUS_INCLUDE_PATH`| *(used by the gnu compiler)* Search path for C++ headers, should include paths for required libraries like `gsl` and `fftw3`. |
| `LD_LIBRARY_PATH` | *(used by linux)* Search path for runtime libraries, should include paths for required libraries like `gsl` and `fftw3`.|
# Install the developer way
## Install custom versions
......@@ -67,22 +86,3 @@ If you want to also create a multi-windows tmux session where each panel corresp
You can insert a personalised number of repos by running for instance `cloneall.bash [..] -r core octree` (will only download core and octree module).
## Environment variables
Here below some relevant environment variables to change hotwheels default settings:
| Environment Variable | Description |
|----------------------|-------------------------------------------------------------------------------------------------------|
| `CC` | C compiler (defaults to `gcc`). |
| `MPICC` | MPI C compiler (defaults to `mpicc`). |
| `CXX` | C++ compiler (defaults to `g++`). |
| `MPICXX` | MPI C++ compiler (defaults to `mpicxx`). |
| `HW_BUILD` | Folder with runtime-generated headers, and C/C++ compiled object files. |
| `HW_DATA` | Folder where downloaded test initial conditions (ICs) should be placed. |
| `DEBUG` | Set to `1` to enable additional verbose output for debugging purposes. |
| `C_INCLUDE_PATH` | *(used by the gnu compiler)* Search path for C headers, should include paths for required libraries like `gsl` and `fftw3`. |
| `CPLUS_INCLUDE_PATH`| *(used by the gnu compiler)* Search path for C++ headers, should include paths for required libraries like `gsl` and `fftw3`. |
| `LD_LIBRARY_PATH` | *(used by linux)* Search path for runtime libraries, should include paths for required libraries like `gsl` and `fftw3`.|
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment