From bb599ff0b7b0b8eb2a75e57ddf466dcc95200ec1 Mon Sep 17 00:00:00 2001 From: Antonio Ragagnin <antonio.ragagnin@inaf.it> Date: Mon, 30 Dec 2024 12:31:36 +0000 Subject: [PATCH] Update install_and_test.md --- install_and_test.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/install_and_test.md b/install_and_test.md index 4a0c46f..d883d5c 100644 --- a/install_and_test.md +++ b/install_and_test.md @@ -13,15 +13,7 @@ pip install 'hotwheels_PM[tested] @ git+ssh://git@git.ia2.inaf.it/hotwheels/PM.g This will install also the following hotwheels packages: core, io, timestep. The `[tested]` tag will install the versions of the dependencies used to test the release (`v0.0.0alpha` in this case). -You can now test the installed modules running the `hotwheels.checkup` script that will execute all `test_*` C,python and bash files: -```bash -python -m hotwheels.checkup hotwheels -``` - -The tests will be run using envirnoment varialbe `CC` for the C ompiler (will default to `gcc`), `MPICC` for the MPI compiler (will default to `mpicc`), `CXX` and `MPICXX` for the c++ version (will default to `g++` and `mpicxx` respectively). - -The PM run needs the `gsl` and `fftw3` to be installed. They should be either in a standard path (`/usr/{lib,include}`) or in your compiler search path (namely, in your `C_INCLUDE_PATH`, `CPLUS_INCLUDE_PATH`, and `LD_LIBRARY_PATH` env variables). # Install custom release versions @@ -50,3 +42,16 @@ pip install -e . cd .. python -m hotwheels.checkup hotwheels #now the tests are run with the new ./hotwheels/timestep/cosmo.c ``` + +# Run tests + +To run the C and python tests of the installed `hotwheels` components, run: + +```bash +python -m hotwheels.checkup hotwheels +``` + +The tests will be run using envirnoment varialbe `CC` for the C ompiler (will default to `gcc`), `MPICC` for the MPI compiler (will default to `mpicc`), `CXX` and `MPICXX` for the c++ version (will default to `g++` and `mpicxx` respectively). + +The PM run needs the `gsl` and `fftw3` to be installed. They should be either in a standard path (`/usr/{lib,include}`) or in your compiler search path (namely, in your `C_INCLUDE_PATH`, `CPLUS_INCLUDE_PATH`, and `LD_LIBRARY_PATH` env variables). + -- GitLab