- Linux distribution
- Nvidia GPU card with CUDA toolkit >= 10.1 (Older versions could be available on request)
Installation of Anaconda/Miniconda
COMPASS binaries, which contain the optimized GPU code, can be installed via Anaconda. Then, you have to install Anaconda 3 or Miniconda 3 (python 3 is required).
We recommend Miniconda instead of Anaconda as it is much lighter, but it’s up to you.
export CONDA_ROOT=$HOME/miniconda3 wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh bash Miniconda3-latest-Linux-x86_64.sh -b -p $CONDA_ROOT
Don’t forget to add your Miniconda or Anaconda directory to your PATH:
Installation of COMPASS via conda
Once Miniconda is installed, installing the COMPASS binaries is easy :
conda install -c compass compass -y
Note: conda main channel is compiled with CUDA 11.3.0, for previous version please use:
conda install -c compass/label/cuda113 compass -y # support for compute capability 3.5 – 8.6 conda install -c compass/label/cuda112 compass -y # support for compute capability 3.5 – 8.6 conda install -c compass/label/cuda111 compass -y # support for compute capability 3.5 – 8.6 conda install -c compass/label/cuda110 compass -y # support for compute capability 3.5 – 8.0 conda install -c compass/label/cuda102 compass -y # support for compute capability 3.5 – 7.5 conda install -c compass/label/cuda101 compass -y # support for compute capability 3.5 – 7.5
This command line will also install dependencies in your conda environment.
Installation of SHESHA package for COMPASS
Finally, you can get the Shesha package of COMPASS. This python package is the user level of COMPASS. It also contains all the initialization functions.
git clone https://github.com/ANR-COMPASS/shesha.git
You will need to set some environment variables:
export SHESHA_ROOT=$HOME/shesha export PYTHONPATH=$SHESHA_ROOT:$PYTHONPATH export PYTHONDONTWRITEBYTECODE=1
Test your installation
Once the installation is complete, verify that everything is working fine :
cd $SHESHA_ROOT/tests ./checkCompass.sh
This test will basically launch fast simulation test cases and it will print if those cases have been correctly initialised.
Run the simulation
You are ready ! You can try it with one of our paramaters file:
cd $SHESHA_ROOT ipython -i shesha/scripts/closed_loop.py data/par/par4bench/scao_sh_16x16_8pix.py
And if you want to launch the GUI:
cd $SHESHA_ROOT ipython -i shesha/widgets/widget_ao.py
Browse through the manual to understand how to use COMPASS.