LUPTAI Model Online Documentation
=================================

Overview of the LUPTAI Model
############################

The LUPTAI Model software package contains:

* The Land-use Urban Planning and Transport Accessibility Indicator (LUPTAI) accessibility model.
* A QGIS plugin to create and run models within a user-friendly environment.
* A python API to programmatically interact with the accessibility model.

The LUPTAI accessibility model was developed for the Queensland Department of Transport and Main Roads by
Davidson Consulting in 2009.
From 2009 to 2013 it was extended by Duncan Lowes to include for multi modal and other capabilities.
Initially LUPTAI was packaged as an extension for the proprietary software package ArcGIS.
This iteration of the model, developed by Veitch Lister Consulting, removes the ArcGIS dependency.
Instead, it leverages the open source software package QGIS to provide the GIS tooling,
thus making accessibility analysis more accessible.

The QGIS plugin is designed to be "lightweight", while still retaining the key components users require to perform
accessibility analysis. The plugin also contains some new features,
such as integration with cloud databases for importing and exporting data.

Some of the key features available in the model are:

* A GUI framework within QGIS.
* A python API framework.
* Tools to import data from a number of transport system formats.
* Tools to develop land use and public transport scenarios.
* Tools to calculate walk, cycle, car and public transport accessibility.
* Tools to view the results of the different analyses.

.. _getting luptai:

Getting LUPTAI
##############

The latest copy of the LUPTAI Model and QGIS plugin can be downloaded from: <link not done yet>.

To test out LUPTAI we also have supplied an example project and scenario, which can be downloaded here: <link also not done yet>

Once you have downloaded LUPTAI follow the steps in our :ref:`installation guide<installation>` to get it installed.
Then, check out our :ref:`quick start` to get up running with LUPTAI.

About this Documentation
########################

The purpose of this documentation is threefold:

* To guide new users through the processes required to perform accessibility analysis.
* Providing support for more advanced workflows.
* Providing an API reference which can be used to perform customised analysis and integrations.

For first time users of LUTPAI QGIS we recommend starting with the Quick Start guide.

.. toctree::
   :maxdepth: 2
   :caption: QGIS Interface:

   qgis/installation.rst
   qgis/quick_start.rst
   qgis/interface_overview.rst
   qgis/project_directory_structure.rst
   qgis/importing_data.rst
   qgis/model_running.rst
   qgis/visualising_results.rst

To help the user better understand the underlying model, we provide a brief overview of how it works.
For experienced users seeking comprehensive understand of the model, there is also 
`the original LUPTAI technical documentation, contact TAU for more information. <Transport_Analysis_Requests@tmr.qld.gov.au>`_ 
(targeting LUPTAI ArcGIS, however the core model methodology is unchanged)


.. toctree::
   :maxdepth: 2
   :caption: The LUPTAI Model:

   model/model.rst

For users who are comfortable using Python to interact with the model,
the example Jupyter notebooks combined with the
API documentation should provide the sufficient starting points.

.. toctree::
   :maxdepth: 2
   :caption: Python Interface:

   python/quick_start.rst
   python/sample_notebook.rst
   python/sample_parameters.rst
   python/api.rst

.. toctree::
   :maxdepth: 2
   :caption: Developer Information:

   technical/qgis_installer.rst