X-Git-Url: https://scm.cri.mines-paristech.fr/git/linpy.git/blobdiff_plain/98936866ae400d45b7b74f7ba0d04c66ace0424f..a8257bb17a1098f69625387a467170cac4b9f483:/doc/install.rst diff --git a/doc/install.rst b/doc/install.rst index 545e773..2d7883b 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -1,23 +1,56 @@ -.. _installation: + +.. _install: Installation ------------- +============ + + +.. _install_dep: Dependencies -============ +------------ + +LinPy requires Python version 3.4 or above to work. + +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 package manager. +For Debian or 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. + + +.. _install_pip: + +Install Using pip +----------------- + +.. warning:: + + The project has not been published in PyPI yet, so this section is not relevant. + Instead, see the :ref:`install_source` section to install LinPy. + +LinPy can be installed using pip with the command:: -Pypol requires at least Python3.4. 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`_ . + sudo pip install linpy -Source -====== +.. _install_source: -add link to pypi pypol documentation. +Install From Source +------------------- -Git -=== +Alternatively, LinPy can be installed from the source. +First, clone the public git repository:: -add link to git repo + git clone https://scm.cri.mines-paristech.fr/git/linpy.git +and build and install as usual with:: -.. _here: http://freshmeat.net/projects/isl/ + sudo python3 setup.py install