Installation

General

Tested on Linux local machines and computational clusters and MAC. Ensure you have Conda installed.

Important note on C++ compilation here

Linux

Choose the environment that best fits your needs:

• Full Environment (ppstm):

  conda env create -f environment.yml
  conda activate ppstm
  python -m ipykernel install --user --name=ppstm

• Dev Environment with Intel GPU (ppstm-dev):

  conda env create -f environment_dev_gpu_intel.yml
  conda activate ppstm-dev
  python -m ipykernel install --user --name=ppstm-dev

• Dev Environment with system-wide ICDs (ppstm-dev):

  conda env create -f environment_dev_icd_system.yml
  conda activate ppstm-dev
  python -m ipykernel install --user --name=ppstm-dev

• Minimal Environment (ppstm-min):

  conda env create -f environment_min.yml
  conda activate ppstm-min

MAC:

• Full Environment (ppstm):

  conda env create -f environment_mac.yml
  conda activate ppstm-mac
  python -m ipykernel install --user --name=ppstm-mac

Windows:

• Windows not tested, please contact us, if you run into problems

Serial or OpenMP parallelisation:

• Decided automatically depending on the system OMP_NUM_THREADS variable -- if it is 1, or not set, then serial ; otherwise OpenMP.
• Code is compiled each time it is run,

C++ compilation:

Compiled C++ libraries are necessary for running many parts of the code. They should be compiled automatically, if they are not compiled beforehand. If you want to do development on the C++, consider:

set PPSTM_RECOMPILE=1

So they are compiled automatically anytime the code is run.