X-Git-Url: https://scm.cri.mines-paristech.fr/git/linpy.git/blobdiff_plain/25ce908cffca380f930182a77c1e5a4491042a1c..50f0fde4dca3f10e535314b1c9d325cd9283735b:/doc/install.rst?ds=inline diff --git a/doc/install.rst b/doc/install.rst index 35cd056..d1b9f1f 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -2,18 +2,43 @@ Installation ------------ +Source +====== + +Users can install LinPy by cloning the git repository:: + + git clone https://scm.cri.ensmp.fr/git/linpy.git + +Then, execute the following to complete installation:: + + python3 setup.py install + +PyPi +==== + + sudo pip install linpy 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's one mandatory dependency is isl, which can be downloaded from `here`_ or using package manager, e.g for ubuntu:: -Source -====== + sudo apt-get install libisl­-dev + +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`_. -Git -=== +License +======= + +LinPy is a free software, licensed under the `GPLv3 license`_ . .. _here: http://freshmeat.net/projects/isl/ + +.. _download page: http://sympy.org/en/download.html + +.. _link: http://matplotlib.org/faq/installing_faq.html + +.. _GPLv3 license: https://www.gnu.org/licenses/gpl-3.0.txt +