Installation Notes

PyHEADTAIL is written in C and Python. Currently, PyHEADTAIL is compatible with Python v3.6.

Installation for Users

For using PyHEADTAIL without modifying the source code, we recommend to install the latest version via PyPI:

$ pip install PyHEADTAIL

Installation for Developers

For developers of PyHEADTAIL, we recommend to install a stand-alone package from the source code using git. For GPU usage, the developer version is required (the Makefile is included in the source code version only).

$ git clone https://github.com/PyCOMPLETE/PyHEADTAIL

Go to the folder and run the installation script:

$ cd PyHEADTAIL

$ make

Installation for multi-bunch simulations

PyHEADTAIL for single- and multi-bunch simulations is available on the branch release/v1.17.0 as a pre-release version. This version can be downloaded and installed as follows:

$ git clone https://github.com/PyCOMPLETE/PyHEADTAIL

$ cd PyHEADTAIL
$ git checkout release/v1.17.0
$ cd ..

$ pip install -e PyHEADTAIL

Please note that the parallel multi-bunch simulations require a parallel HDF5 installation (you can find instructions on installation from source here).

Installation on MacOS with Anaconda

After cloning the repository and creating a python 3 Anaconda environment, one needs additional packages to be able to compile the code. The following set of commands might work:

$ conda install clang clangdev libclang clangxx clang_osx-64 
$ conda install gfortran_osx-64 libgfortran
$ conda activate <MY_PYTHON3_ENV>
$ pip install cython h5py
$ cd PyHEADTAIL
$ make
$ pip install -e.