How to install PyECLOUD

Dependencies

PyECLOUD has been tested exclusively on Linux (mainly Ubuntu and SLC distributions).

To operate it needs the following general tools and libraries:

• Python 2.7.XX
• numpy
• scipy
• matplotlib (mainly for examples and tests)
• cython
• f2py
• mpi4py (in case PyPARIS parallelisation is needed)

Preparation of your the python environment

If you are already working with the python script stack you can skip this section

Different options can be used to setup the working environment:

• It is recommended to install Anaconda or Miniconda and use pip to install the missing modules.
• It is possible to compile and install your python and all required packages following the instruction here:
  • Setup python (including mpi4py) without admin rights
• On Ubuntu is is possible to install the required packages following the instruction here:
  • Install PyECLOUD on Ubuntu

Install PyECLOUD and its friend libraries:

For buildup simulations, only PyECLOUD, PyKLU and PyPIC are required:

git clone https://github.com/PyCOMPLETE/PyECLOUD
git clone https://github.com/PyCOMPLETE/PyKLU
git clone https://github.com/PyCOMPLETE/PyPIC

cd PyPIC
make

cd ../PyECLOUD
./setup_pyecloud

cd ../PyKLU
./install
cd ..

To simulate the e-cloud effects on beam dynamics you will also need:

git clone https://github.com/PyCOMPLETE/PyHEADTAIL  
git clone https://github.com/PyCOMPLETE/NAFFlib
git clone https://github.com/PyCOMPLETE/PyPARIS  

cd PyHEADTAIL
make
cd ..
mv PyHEADTAIL PyHEADTAIL_inst
mv PyHEADTAIL_inst/PyHEADTAIL .
    
cd NAFFlib/NAFFlib
make py2
cd ../..
mv NAFFlib NAFFlib_inst
mv NAFFlib_inst/NAFFlib .
cd ..