X-Git-Url: https://scm.cri.ensmp.fr/git/linpy.git/blobdiff_plain/416e6bd198cde7d0c3506c79e3cbe5c2a44f48b8..23922aa39e585f1e6b11f3479da002c92bebf2a1:/doc/install.rst diff --git a/doc/install.rst b/doc/install.rst index 9b4b97c..7aba246 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -1,46 +1,46 @@ +.. _install: + Installation ============ + +.. _install_dep: + 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:: +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 -For Arch Linux, run:: - - 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. -pip ---- -.. warning:: +.. _install_pip: - The project has not been published in PyPI yet, so this section is not relevant. - Instead, see the :ref:`source` section to install LinPy. +Install Using pip +----------------- -LinPy can be installed using pip with the command:: +This is the recommanded way to install LinPy, with the command:: sudo pip install linpy -.. _source: -Source ------- +.. _install_source: + +Install From Source +------------------- -Alternatively, LinPy can be installed from the source. +Alternatively, LinPy can be installed from source. First, clone the public git repository:: - git clone https://scm.cri.ensmp.fr/git/linpy.git + git clone https://scm.cri.mines-paristech.fr/git/linpy.git and build and install as usual with::