diff --git a/install_and_test.md b/install_and_test.md index d75461a9672c3abeb439ee45036fceb19371aaf7..ff985e102f31e3a9ea301adaa5d4f7e07d116427 100644 --- a/install_and_test.md +++ b/install_and_test.md @@ -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`.| -