.. role:: hlpurple .. role:: hlteal .. role:: hlorange .. role:: hlgrey .. role:: hlgreen .. _user interface: User Interface Overview ======================= In this section we introduce the basics of the LUPTAI QGIS plugin's user interface. This includes how to access tools and view inputs and outputs. The LUPTAI QGIS plugin also leverages the GIS capabilities of QGIS to allow the user to edit networks, activity points, etc. To better understand these capabilities check out the QGIS specific documentation, such as the `official QGIS user guide `_. The LUPTAI Menu --------------- All functionality of the LUPTAI accessibility available in the QGIS plugin can be accessed through the LUPTAI Menu. This is accessed menu is accessed through the QGIS menu bar. .. figure:: images/luptai_menu.png :alt: The LUPTAI Menu. The LUPTAI Menu. From the "Project" menu the user can: - Create a new Project - Open a Project For more information on projects, see :ref:`LUPTAI Project Structure`. From the "Scenario" menu the user can: - Create a new Scenario - Load a scenario into QGIS (which allows it's networks, activity points, etc. to be viewed and edited) For more information on scenarios, see :ref:`LUPTAI Scenario Structure`. From the "Import Data" menu the user can: - Load an active transport network into a scenario from either a database, TAB file, or from the QGIS workspace - Load a public transport network into a scenario from either a database, or GTFS files - Load activity points from either a database, or a TAB file - Load activity attributes from either a database, TAB file, or SQLite file For more information on importing data, see :ref:`Importing Model Data`. Using the "Run Model" command will bring up the run model dialog, which allows the user to: - Set-up an accessibility analysis model run (which allows the user to specify modes, activities, parameters, etc.) - Run an accessibility analysis model For more information on running a model, see :ref:`Running a Model`. Using the "About" command will bring up "about" information, such as: - Version information - Copyright information - A link to this documentation Layers Panel ------------ The layer's panel is a standard interface tool in QGIS, the LUPTAI plugin uses this panel to display and organise scenario data. Any number of scenarios from the open project can be open in the layers panel at the same time, the figure below shows a :hlorange:`layers panel` (typically found in bottom right of the QGIS window) with two scenarios and a base map open. A scenario has two main groups of data :hlteal:`Inputs` and :hlgrey:`Results`. The Inputs group contains data that will be input into the accessibility model, while the results contains result data from previous model runs (if no models have been run, the Results group may not appear in the layers panel). .. image:: images/layers_panel.png :alt: Layers panel. Items in the panel can be hidden or shown by selecting/deselecting the checkbox next to it. Groups, such as the Inputs group, can be uncollapsed/collapsed by clicking the arrow next to them. Uncollapsing the :hlorange:`Activity Types` group (part of the inputs group) we can now see two groups: :hlteal:`snapped` and :hlgrey:`unsnapped`. The activities types in the unsnapped group are those that have not successfully been snapped to a node, and will not be included in any model runs. While those that are in the snapped group will all be included in any model runs. Each activity has it's own symbol, and is grouped within a category. In the below image we show the :hlpurple:`Education` category and its :hlgreen:`contained activities`, each with a different symbol. .. image:: images/panel_activity_types.png :alt: Activity types in the layers panel. The Network Nodes item allows the user to display the network nodes. Displaying these can be useful for troubleshooting, but generally add little value and are best left hidden. By right clicking and then clicking 'Open Attribute Table' the user can view the node data in spreadsheet style format. The network links show the active network that will be used in the model. Each type of link has it's own line symbol (varying by colour and dashes). The :hlorange:`Public Transport Network Data` allows the user to visualise the PT network, including stops and routes. The :hlteal:`PT Routes` contains all routes, grouped by mode. Within a mode, each service has has its own line symbol. In the below image we see that :hlgrey:`Light Rail` mode, has :hlpurple:`two services` in this scenario, each have their own line symbol. The :hlgreen:`PT Stops` item is for the PT Stops of all modes. .. image:: images/panel_activity_types.png :alt: Public Transport network data in the layers panel. The :hlorange:`Network Snapping` group within the Public Transport Network Data Group allows the user to explore information on the snapping of PT Stops to the network. This information is worth viewing by the modeller, as poorly snapped stops can lead to unexpected results. The :hlteal:`PT Stops` group shows the stops location according to the imported data, the :hlgrey:`Network Nodes` shows the node that a stop was snapped to, and the :hlpurple:`Snap Lines` provides a line connecting the the Stop to its snapped node, the colour of the line shows the distance of the snap. The :hlgreen:`PT Stops - Unsnapped`, provides the stops that were unable to be snapped to a node. .. image:: images/panel_network_snapping.png :alt: Network snapping in the layers panel. The demographics group, contains the points that are used for employment. It's important for the user to check these over, ensuring that the points used are more-or-less representative of where employment would be located. Outside of the Inputs group is the :hlorange:`Results` group, this contains the results, and allows for results visualisation to be hidden or made visible. In the below image we show two results sets, with :hlteal:`one of the results` uncollapsed, showing :hlgrey:`the key` for its visualisation the key can be different as it depends on the mode. .. image:: images/panel_results.png :alt: The Results group in the layers panel. This completes the overview of the user interface, for more information on building and running models, delve into other subjects on the sidebar.