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

QRDecode installation
=====================

If you are interested in installing the QRDecode module, just install its dependencies and you are good to go.

Dependencies installation
=========================

Using a miniconda environment is recommended. It is recommended to use `Pyenv`_ to create the environment.
Move to the folder where qrdecode is located and type:

.. code-block:: console

   pyenv install miniconda3-4.2.12 # this will install the miniconda environment
   pyenv local miniconda3-4.2.12 # this will tell pyenv that you wish to use miniconda as the pyenv version

The required dependencies are listed in ``requirements.txt``.
To install them, just type:

.. code-block:: console

   while read requirement; do conda install --yes $requirement || pip install $requirement; done < requirements.txt

OpenCV is also needed to execute the code. To install it, it is recommended to use `Conda`_.
Using Conda, type:

.. code-block:: console

   conda install -c menpo opencv3

Now you will have fulfilled the dependencies required to execute QRDecode, and you will be ready to use it.

.. _Pyenv: https://github.com/pyenv/pyenv
.. _Conda: https://conda.io/docs/user-guide/install/linux.html
