.. _installation:

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


Using Anaconda or Miniconda (recommended)
-----------------------------------------

Using conda_ (latest version recommended), S2 Downloader API is installed as follows:


1. Create virtual environment for s2_downloader_api (optional but recommended):

   .. code-block:: bash

    $ conda create -c conda-forge --name s2_downloader_api python=3
    $ conda activate s2_downloader_api


2. Then clone the S2 Downloader API source code and install S2 Downloader API and all dependencies from the environment_s2_downloader_api.yml file:

   .. code-block:: bash

    $ git clone git@git.gfz-potsdam.de:fernlab/products/data-portal/s2_downloader_api.git
    $ cd s2_downloader_api
    $ conda env update -n s2_downloader_api -f tests/CI_docker/context/environment_s2_downloader_api.yml
    $ pip install .


This is the preferred method to install S2 Downloader API, as it always installs the most recent stable release and
automatically resolves all the dependencies.


Using pip (not recommended)
---------------------------

It is also possible to instal S2 Downloader API via `pip`_. However, please note that S2 Downloader API depends on some
open source packages that may cause problems when installed with pip. Therefore, we strongly recommend
to resolve the following dependencies before the pip installer is run:

    * TODO


Then, the pip installer can be run by:

   .. code-block:: bash

    $ pip install git@git.gfz-potsdam.de:fernlab/products/data-portal/s2_downloader_api.git

If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.



.. note::

    S2 Downloader API has been tested with Python 3.6+., i.e., should be fully compatible to all Python versions from 3.6 onwards.


.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
.. _conda: https://conda.io/docs