-.. _installation:
Installation
+============
+
+Dependencies
------------
-Source
-======
-Users can install LinPy by cloning the git repository::
+LinPy requires Python version 3.4 or above to work.
- git clone https://scm.cri.ensmp.fr/git/linpy.git
+LinPy's one mandatory dependency is isl version 0.12 or 0.13 (it may work with other versions of isl, but this has not been tested).
+isl can be downloaded `here <http://freshmeat.net/projects/isl/>`_ or preferably, using your favorite distribution's package manager.
+For Ubuntu, the command to run is::
-Then, execute the following to complete installation::
-
- python3 setup.py install
+ sudo apt-get install libisl-dev
-PyPi
-====
+For Arch Linux, run::
- sudo pip install linpy
+ sudo pacman -S isl
-Dependencies
-============
+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/>`_.
+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.
-LinPy's one mandatory dependency is isl, which can be downloaded from `here`_ or using package manager, e.g for ubuntu::
+pip
+---
- sudo apt-get install libislĀ-dev
+.. warning::
-There are two optional dependencies that will maximize the use of LinPy's
-functions; SymPy and matplotlib. SymPy installation instructions can be found on the SymPy `download page`_. Matplotlib install information can be found at this `link`_.
+ The project has not been published in PyPI yet, so this section is not relevant.
+ Instead, see the :ref:`source` section to install LinPy.
-License
-=======
+LinPy can be installed using pip with the command::
-LinPy is a free software, licensed under the `GPLv3 license`_ .
+ sudo pip install linpy
+.. _source:
-.. _here: http://freshmeat.net/projects/isl/
+Source
+------
-.. _download page: http://sympy.org/en/download.html
+Alternatively, LinPy can be installed from the source.
+First, clone the public git repository::
-.. _link: http://matplotlib.org/faq/installing_faq.html
+ git clone https://scm.cri.ensmp.fr/git/linpy.git
-.. _GPLv3 license: https://www.gnu.org/licenses/gpl-3.0.txt
+and build and install as usual with::
+ sudo python3 setup.py install