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

============
Requirements
============
You need to have installed `QGIS <https://www.qgis.org>`_ in your computer.
This plugin was tested on Windows using QGIS 3.28.9-Firenze.

.. csv-table:: QGIS versions and operating systems tested
   :file: ../res/qgis_versions.csv
   :align: center
   :header-rows: 1

===================
Plugin installation
===================

TreeEyed plugin is now available directly in the `QGIS Python Plugins Repository <https://plugins.qgis.org/plugins/tree_eyed/>`_ and can be installed using the plugin manager in QGIS.

.. image:: ../res/plugin_install.gif
   :alt: Plugin Installation

For the QGIS plugin installation using a compressed file follow the next steps:

#. Download the latest zip file of the plugin available in the `repository <https://github.com/afruizh/TreeEyed/releases>`_.
#. In QGIS open the **Plugins Manager**
#. Go to the **Install from ZIP** section and install the plugin using the zip file
#. A message to install additional packages may appear, click yes to install

==============================
Required additional packages
==============================

This plugin requires additional python packages that can be installed by using the plugin and following the instructions:

* rasterio
* pycocotools
* opencv-python
* onnxruntime-gpu

A **dependencies** folder with the required packages will be added in the plugin root folder.

===================
Installation video
===================

.. raw:: html

   <div style="text-align:center;width:100%;">
      <iframe width="560" height="315" src="https://www.youtube.com/embed/h6xQASCDE_M?si=QVFi7gYWH0nFyuOD" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
   </div>