X-Git-Url: https://scm.cri.mines-paristech.fr/git/linpy.git/blobdiff_plain/d9ce6feb2d36e40e83326744f1d4ff3890d1874f..f99ff4027ef7b2c2895b5b7b84e886bc6f784811:/doc/install.rst diff --git a/doc/install.rst b/doc/install.rst index a19f9ba..2d7883b 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -1,29 +1,56 @@ -.. _installation: + +.. _install: Installation +============ + + +.. _install_dep: + +Dependencies ------------ -Source -====== +LinPy requires Python version 3.4 or above to work. -Users can install Linpy by cloning the git repository:: +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:: - git clone https://scm.cri.ensmp.fr/git/pypol.git + sudo apt-get install libisl-dev -Install -======= +For Arch Linux, run:: -…execute `setup.py` + 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:: + + sudo pip install linpy -Dependencies -============ -Linpy has several 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`_ . +.. _install_source: -To use the Linpy plotting function, users need to install matplotlib using instructions in the following `link`_. +Install From Source +------------------- +Alternatively, LinPy can be installed from the source. +First, clone the public git repository:: + git clone https://scm.cri.mines-paristech.fr/git/linpy.git -.. _here: http://freshmeat.net/projects/isl/ +and build and install as usual with:: -.. _link: http://matplotlib.org/faq/installing_faq.html \ No newline at end of file + sudo python3 setup.py install