X-Git-Url: https://scm.cri.mines-paristech.fr/git/linpy.git/blobdiff_plain/35c965895771a3df79744ae54f1eda91f0b62862..f616f24b32af92e282a30f7161f915b3c334922e:/doc/install.rst diff --git a/doc/install.rst b/doc/install.rst index d1b9f1f..2d7883b 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -1,44 +1,56 @@ -.. _installation: + +.. _install: Installation +============ + + +.. _install_dep: + +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 `_ or preferably, using your favorite package manager. +For Debian or 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 + +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. -Dependencies -============ -LinPy's one mandatory dependency is isl, which can be downloaded from `here`_ or using package manager, e.g for ubuntu:: +.. _install_pip: - sudo apt-get install libisl­-dev +Install Using pip +----------------- -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`_. +.. warning:: -License -======= + 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:: + + sudo pip install linpy -LinPy is a free software, licensed under the `GPLv3 license`_ . +.. _install_source: -.. _here: http://freshmeat.net/projects/isl/ +Install From 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.mines-paristech.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