X-Git-Url: https://scm.cri.ensmp.fr/git/linpy.git/blobdiff_plain/25ce908cffca380f930182a77c1e5a4491042a1c..23922aa39e585f1e6b11f3479da002c92bebf2a1:/doc/install.rst diff --git a/doc/install.rst b/doc/install.rst index 35cd056..7aba246 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -1,19 +1,47 @@ -.. _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 + +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 +----------------- + +This is the recommanded way to install LinPy, with the command:: + + sudo pip install linpy + + +.. _install_source: -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`_ . +Install From Source +------------------- -Source -====== +Alternatively, LinPy can be installed from source. +First, clone the public git repository:: -Git -=== + 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