doc/install.rst

   1
   2 Installation
   3 ============
   4
   5 Dependencies
   6 ------------
   7
   8 LinPy requires Python version 3.4 or above to work.
   9
  10 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).
  11 isl can be downloaded `here <http://freshmeat.net/projects/isl/>`_ or preferably, using your favorite distribution's package manager.
  12 For Ubuntu, the command to run is::
  13
  14     sudo apt-get install libisl-dev
  15
  16 For Arch Linux, run::
  17
  18     sudo pacman -S isl
  19
  20 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/>`_.
  21 Please consult the `SymPy download page <http://sympy.org/en/download.html>`_ and `matplotlib installation instructions <http://matplotlib.org/faq/installing_faq.html>`_ to install these libraries.
  22
  23 pip
  24 ---
  25
  26 .. warning::
  27
  28     The project has not been published in PyPI yet, so this section is not relevant.
  29     Instead, see the :ref:`source` section to install LinPy.
  30
  31 LinPy can be installed using pip with the command::
  32
  33     sudo pip install linpy
  34
  35 .. _here: http://freshmeat.net/projects/isl/
  36
  37 .. _download page: http://sympy.org/en/download.html
  38
  39 .. _link: http://matplotlib.org/faq/installing_faq.html
  40
  41 .. _source:
  42
  43 Source
  44 ------
  45
  46 Alternatively, LinPy can be installed from source.
  47 First, clone the public git repository::
  48
  49     git clone https://scm.cri.ensmp.fr/git/linpy.git
  50
  51 and build and install as usual with::
  52
  53     sudo python3 setup.py install