.. role:: hlpurple

.. role:: hlteal

.. role:: hlorange

.. role:: hlgrey

.. _installation:

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

To install the LUPTAI QGIS plugin you will require:

* a Windows 10 device
* QGIS 3 installed (we currently recommend version 3.10 as it has long term support)
* a copy of the LUPTAI plugin installer (from :ref:`here<getting luptai>`).

Once you have downloaded the LUPTAI plugin installer, navigate to where you downloaded it, and double click on it.
This should bring up the pop-up shown below.
Read the information displayed and click :hlorange:`Next`:

.. image:: images/first_screen.png
    :alt: First page of installer.

Next, select where QGIS 3 is installed on the local machine.
A default location will be selected and its path visible in the :hlorange:`Select Directory` textbox.
If it is installed elsewhere,
click the :hlteal:`Browse` button to open up a file browser and hunt down the folder that QGIS is installed on.
Typically it will be in “C:\\Program Files”, but if you have installed QGIS with the OSGeo package,
the QGIS folder is likely located in “C:\\OSGeo4W64\\apps”.
After you have selected the QGIS folder, the path to it will appear in the :hlorange:`Select Directory` textbox.
If all looks good click :hlgrey:`Install`.

.. image:: images/choose_qgis.png
    :alt: Select QGIS installation directory.

LUPTAI will begin installing core components of LUTPAI and its dependencies.
Click the :hlorange:`Show details` button, to get the play-by-play of what the installer is doing.
When the installation is complete click :hlteal:`Next`.

.. image:: images/installing.png
    :alt: LUPTAI is installing.

Now we need to place the components necessary to run the QGIS plugin in the correct folder,
this dialog is like the QGIS installation dialog.
The default folder for QGIS plugins is already selected and shown in the :hlorange:`Select Directory` textbox.
If necessary, click the :hlteal:`Browse` button to find the correct folder.
When the correct folder is selected click :hlgrey:`Install`.

.. image:: images/choose_plugin.png
    :alt: Select QGIS plugin directory.

This brings up another installing progress directory. When the installation is complete click next and you should get the following dialog:

.. image:: images/done.png
    :alt: Install complete dialog.

Click :hlorange:`Finish` and we are done getting all the components installed.
Now all we have to do is tell QGIS about LUPTAI.

Open your QGIS 3 software package. In the top menu find and click the :hlorange:`Plugins` menu item.

.. image:: images/qgis_plugin_menu.png
    :alt: Location of "Plugins" menu item.

With the Plugins menu open, click the :hlorange:`Manage and Install Plugins` item.

.. image:: images/qgis_plugin_menu_open.png
    :alt: "Manage and Install Plugins" option, in the "Plugins" menu.

The “Plugins” dialog will open and you will be confronted with a list of all available QGIS plugins. To help us locate the LUPTAI plugin,
type “LUPTAI” into the :hlorange:`search bar`, this should bring up the LUPTAI Plugin. Next, to activate the plugin, click the
:hlteal:`checkbox` next to the plugin name. Now, you can click the :hlgrey:`Close` button and you are good to go.

.. image:: images/activate_plugin.png
    :alt: Activate the LUTPAI QGIS Plugin, in the "Plugins" dialog.

Congratulations, you have now installed the and activated the QGIS plugin.
Follow the rest of this Quick Start Guide to begin performing accessibility analysis.