Replace examples by tutorial in documentation
[linpy.git] / doc / install.rst
1
2 .. _install:
3
4 Installation
5 ============
6
7 Dependencies
8 ------------
9
10 LinPy requires Python version 3.4 or above to work.
11
12 LinPy's one mandatory dependency is `isl <http://isl.gforge.inria.fr/>`_ version 0.12 or 0.13 (it may work with other versions of isl, but this has not been tested).
13 isl can be downloaded `here <http://freshmeat.net/projects/isl/>`_ or preferably, using your favorite package manager.
14 For Debian or Ubuntu, the command to run is::
15
16 sudo apt-get install libisl-dev
17
18 For Arch Linux, run::
19
20 sudo pacman -S isl
21
22 Apart from isl, there are two optional dependencies that will maximize the use of LinPy's functions: `SymPy <http://sympy.org/en/index.html>`_ and `matplotlib <http://matplotlib.org/>`_.
23 Please consult the `SymPy download page <http://sympy.org/en/download.html>`_ and `matplotlib installation instructions <http://matplotlib.org/faq/installing_faq.html#how-to-install>`_ to install these libraries.
24
25 Install Using pip
26 -----------------
27
28 .. warning::
29
30 The project has not been published in PyPI yet, so this section is not relevant.
31 Instead, see the :ref:`install_source` section to install LinPy.
32
33 LinPy can be installed using pip with the command::
34
35 sudo pip install linpy
36
37 .. _install_source:
38
39 Install From Source
40 -------------------
41
42 Alternatively, LinPy can be installed from the source.
43 First, clone the public git repository::
44
45 git clone https://scm.cri.ensmp.fr/git/linpy.git
46
47 and build and install as usual with::
48
49 sudo python3 setup.py install