X-Git-Url: https://scm.cri.mines-paristech.fr/git/linpy.git/blobdiff_plain/a1ffefe911e2309673c57f4766567314713d59aa..b676f2dfbaa1aac981210c603bb6407d357a0340:/doc/install.rst?ds=sidebyside diff --git a/doc/install.rst b/doc/install.rst index 635e9c0..92aad27 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -1,4 +1,6 @@ +.. _install: + Installation ============ @@ -7,9 +9,9 @@ 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 distribution's package manager. -For Ubuntu, the command to run is:: +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 @@ -20,24 +22,24 @@ For Arch Linux, run:: 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. -pip ---- +Install Using pip +----------------- .. warning:: The project has not been published in PyPI yet, so this section is not relevant. - Instead, see the :ref:`source` section to install LinPy. + Instead, see the :ref:`install_source` section to install LinPy. LinPy can be installed using pip with the command:: sudo pip install linpy -.. _source: +.. _install_source: -Source ------- +Install From Source +------------------- -Alternatively, LinPy can be installed from source. +Alternatively, LinPy can be installed from the source. First, clone the public git repository:: git clone https://scm.cri.ensmp.fr/git/linpy.git