Make Expression.subs() always return a LinExpr instance
[linpy.git] / doc / install.rst
1
2 .. _install:
3
4 Installation
5 ============
6
7
8 .. _install_dep:
9
10 Dependencies
11 ------------
12
13 LinPy requires Python version 3.4 or above to work.
14
15 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).
16 isl can be downloaded `here <http://freshmeat.net/projects/isl/>`_ or preferably, using your favorite package manager.
17 For Debian or Ubuntu, the command to run is::
18
19 sudo apt-get install libisl-dev
20
21 For Arch Linux, run::
22
23 sudo pacman -S isl
24
25 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/>`_.
26 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.
27
28
29 .. _install_pip:
30
31 Install Using pip
32 -----------------
33
34 This is the recommanded way to install LinPy, with the command::
35
36 sudo pip install linpy
37
38
39 .. _install_source:
40
41 Install From Source
42 -------------------
43
44 Alternatively, LinPy can be installed from source.
45 First, clone the public git repository::
46
47 git clone https://scm.cri.mines-paristech.fr/git/linpy.git
48
49 and build and install as usual with::
50
51 sudo python3 setup.py install