.. _installation:

Installation
============

The latest stable version on `https://pypi.org <https://pypi.org>`_ is obtained via:

.. code-block:: bash

   pip install Voiager

You may want to append the ``--user`` flag, or use a virtual environment, in case you are working on a machine without admin rights. The latest development version on github is obtained via:

.. code-block:: bash

   git clone https://github.com/nhamaus/Voiager.git
   cd Voiager
   pip install .

.. note::
   External package requirements are provided in the file `requirements.txt <https://github.com/nhamaus/Voiager/blob/main/requirements.txt>`_. Follow the instructions provided on the `VIDE wiki <https://bitbucket.org/cosmicvoids/vide_public/wiki/Home/>`_ to install VIDE. For correctly rendering the plots you additionally need `LaTeX <https://texblog.org/installing-latex/>`_. To install the necessary LaTeX packages on a linux machine, you can do

.. code-block:: bash

   sudo apt-get install texlive texlive-latex-extra cm-super dvipng