@@ -4,8 +4,27 @@ PyHEADTAIL
44CERN PyHEADTAIL numerical n-body simulation code
55for simulating macro-particle beam dynamics with collective effects.
66
7- Installation
8- ------------
7+ PyHEADTAIL is written in C and Python.
8+ Currently, PyHEADTAIL is compatible with Python v2.7.
9+
10+ Installation for Users
11+ ----------------------
12+
13+ For using PyHEADTAIL without modifying the source code,
14+ we recommend to install the latest version via PyPI:
15+
16+ $ pip install PyHEADTAIL
17+
18+ Installation for Developers
19+ ---------------------------
20+
21+ For developers of PyHEADTAIL, we recommend to install a stand-alone
22+ package from the source code using git. For GPU usage, the developer
23+ version is required (the Makefile is included in the source code
24+ version only).
25+
26+ We recommend to use the Anaconda package manager (for Python 2.7) to simplify installing.
27+ You can obtain it from anaconda.org .
928
1029Installation of PyHEADTAIL on linux (having git installed)
1130is straight forward.
@@ -36,13 +55,7 @@ And there you go, start using PyHEADTAIL!
3655
3756 In [1]: import PyHEADTAIL
3857
39- PyHEADTAIL v1.11.2
40-
41-
42- -------------------------------------------------------------------------------
43-
44- Please use the pre-push script ``prepush.py `` if you want to contribute
45- to the repository. It only lets you push to the develop and master branch if
46- no unit tests fail.
58+ PyHEADTAIL v1.12.2
4759
48- To install (creates a symlink): ``ln -s ../../prepush.py .git/hooks/pre-push ``
60+ For a single installation of PyHEADTAIL we recommended to add
61+ the PyHEADTAIL path to your PYTHONPATH.
0 commit comments