X-Git-Url: https://svn.cri.ensmp.fr/git/linpy.git/blobdiff_plain/25ce908cffca380f930182a77c1e5a4491042a1c..a08ebc700e22f6aee8147cb5b5323a6c040b12db:/doc/install.rst diff --git a/doc/install.rst b/doc/install.rst index 35cd056..040029d 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -1,19 +1,53 @@ -.. _installation: Installation ------------- +============ Dependencies -============ +------------ -Users will first need to install Integer Set Library (isl). The source files of isl are available as a tarball or a git repository. Both -are available `here`_ . +LinPy requires Python version 3.4 or above to work. -Source -====== +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 `_ or preferably, using your favorite distribution's package manager. +For Ubuntu, the command to run is:: + + sudo apt-get install libisl-dev + +For Arch Linux, run:: + + sudo pacman -S isl + +Apart from isl, there are two optional dependencies that will maximize the use of LinPy's functions: `SymPy `_ and `matplotlib `_. +Please consult the `SymPy download page `_ and `matplotlib installation instructions `_ to install these libraries. + +pip +--- + +.. warning:: -Git -=== + The project has not been published in PyPI yet, so this section is not relevant. + Instead, see the :ref:`source` section to install LinPy. +LinPy can be installed using pip with the command:: + + sudo pip install linpy .. _here: http://freshmeat.net/projects/isl/ + +.. _download page: http://sympy.org/en/download.html + +.. _link: http://matplotlib.org/faq/installing_faq.html + +.. _source: + +Source +------ + +Alternatively, LinPy can be installed from source. +First, clone the public git repository:: + + git clone https://scm.cri.ensmp.fr/git/linpy.git + +and build and install as usual with:: + + sudo python3 setup.py install