.. _installation:

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

--------------
Stable release
--------------

With pip
--------

CARS is available on Pypi and can be installed with pip.

It is recommended to use a virtual environment :

.. code-block:: console

    python -m venv cars_env
    source cars_env/bin/activate
    pip install cars

Optional edge detection integration can be installed with:

.. code-block:: console

    pip install "cars[edge-detection]"

When the edge detection plugin is installed, the default CARS pipeline
automatically enables edge detection. If it is not installed, CARS runs
without edge detection.

This is the preferred method to install CARS, but it is required to have a Linux system.

With Docker
-----------

Alternatively, you can download the Docker image from Docker Hub

.. code-block:: console

    docker pull cnes/cars

------------
From sources
------------

The sources for CARS can be downloaded from the `Github repo <https://github.com/CNES/cars>`_.

Clone the repository:

.. code-block:: console

    git clone https://github.com/CNES/cars.git

Install CARS with the Makefile :

.. code-block:: console

    make install

Then activate the environment : 

.. code-block:: console

    source venv/bin/activate