X-Git-Url: https://scm.cri.ensmp.fr/git/linpy.git/blobdiff_plain/454a26a54cc7ff563ab278567f3bbad9c6ff42bb..a08ebc700e22f6aee8147cb5b5323a6c040b12db:/doc/install.rst diff --git a/doc/install.rst b/doc/install.rst index d1b9f1f..040029d 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -1,38 +1,36 @@ -.. _installation: Installation ------------- -Source -====== +============ -Users can install LinPy by cloning the git repository:: +Dependencies +------------ - git clone https://scm.cri.ensmp.fr/git/linpy.git +LinPy requires Python version 3.4 or above to work. -Then, execute the following to complete installation:: - - python3 setup.py install +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:: -PyPi -==== + sudo apt-get install libisl-dev - sudo pip install linpy +For Arch Linux, run:: -Dependencies -============ + sudo pacman -S isl -LinPy's one mandatory dependency is isl, which can be downloaded from `here`_ or using package manager, e.g for ubuntu:: +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. - sudo apt-get install libisl­-dev +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:`source` section to install LinPy. -LinPy is a free software, licensed under the `GPLv3 license`_ . +LinPy can be installed using pip with the command:: + sudo pip install linpy .. _here: http://freshmeat.net/projects/isl/ @@ -40,5 +38,16 @@ LinPy is a free software, licensed under the `GPLv3 license`_ . .. _link: http://matplotlib.org/faq/installing_faq.html -.. _GPLv3 license: https://www.gnu.org/licenses/gpl-3.0.txt +.. _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