Doc updates (not complete)
[linpy.git] / doc / install.rst
1 .. _installation:
2
3 Installation
4 ------------
5 Source
6 ======
7
8 Users can install LinPy by cloning the git repository::
9
10 git clone https://scm.cri.ensmp.fr/git/linpy.git
11
12 Then, execute the following to complete installation::
13
14 python3 setup.py install
15
16 PyPi
17 ====
18
19 sudo pip install linpy
20
21 Dependencies
22 ============
23
24 LinPy's one mandatory dependency is isl, which can be downloaded from `here`_ or using package manager, e.g for ubuntu::
25
26 sudo apt-get install libislĀ­-dev
27
28 There are two optional dependencies that will maximize the use of LinPy's
29 functions; SymPy and matplotlib. SymPy installation instructions can be found on the SymPy `download page`_. Matplotlib install information can be found at this `link`_.
30
31 License
32 =======
33
34 LinPy is a free software, licensed under the `GPLv3 license`_ .
35
36
37 .. _here: http://freshmeat.net/projects/isl/
38
39 .. _download page: http://sympy.org/en/download.html
40
41 .. _link: http://matplotlib.org/faq/installing_faq.html
42
43 .. _GPLv3 license: https://www.gnu.org/licenses/gpl-3.0.txt
44