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

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

To install the package with pip, run the following command:

.. code-block:: shell

    pip install py3dic

This should install all package dependencies automatically.

Alternatively if you want to upgrade an existing installation:

.. code-block:: shell

    pip install --upgrade py3dic

Verify installation
-------------------

To check if the installation is ok use

.. code-block:: python

    import py3dic as mlt
    mlt.__version__

Creating a new environment (recommended)
----------------------------------------

This is the recommended method:

.. code-block::shell

    conda create -n py3dic python=3
    conda activate py3dic     

.. note::

    Alternatively *if you are running low on space on an SSD* drive you can use the prefix option (**IMPORTANT:** read through the following `StackOverflow Question: how to specify new environment location for conda create <https://stackoverflow.com/questions/37926940/how-to-specify-new-environment-location-for-conda-create>`__)


Install dependencies
~~~~~~~~~~~~~~~~~~~~~~

If the pip method is used the dependencies should be installed automatically.

Activate the new conda environment and install the following:

.. code-block::shell

    conda activate materialslab
    conda install numpy scipy
    conda install matplotlib  pandas seaborn
    conda install ipython jupyter
    conda install openpyxl tqdm
    
seperately install opencv-python with pip. This is crucial because the conda version of opencv-python 
is not compatible with the current version of py3dic.


.. code-block::shell

    pip install opencv-python

From source
-----------
Since version 0.4.1 the py3dic uses a ``pyproject.toml`` file for compliance with PEP 517 and PEP 518.
To install the package from source, clone the repository and run the following command: 

.. code-block:: shell

    pip install .