Getting started

Note that the program has dependencies (namely hypothesis, pytest, folium, and pandas). Be sure those are installed prior to running the program.

To run the program, download and extract the zip file to a desired location on your computer. Then, run main.py on your favourite command line interface.

There will be three functions which you can perform with the program, each corresponding to a unique letter.

Table of Contents Program functions Showing all buildings on the main campus Showing all intersections Navigation Amenities

Program functions

Showing all buildings on the main campus

This corresponds with option [A], and is useful for finding out which buildings are on campus.

You can show all buildings listed on the St. George campus by entering [A] followed by pressing the [enter] key (bypassing the amenities filter). You can also filter the buildings shown by amenity. Type in one of the above amenities to filter the buildings shown.

A folium window will appear showing all desired buildings. Click on a point to view more details.

Showing all intersections

This corresponds with option [B]. A folium window will appear showing all intersections which are close to campus buildings; hover on an intersection to view more details.

Navigation

This corresponds with option [C]. A list of building codes will appear. Input the start building code, followed by the end building code.

• If you're not inside a building, input the building which you are closest at.
• If you're unsure what building code is associated with the building you're in, use [ctrl] + [f] / [cmd] + [f].

You will then be given an option to 'stop over' at buildings with various amenities. Input one amenity and press enter. You can do this as many times as needed. If you have no other amenities to add (or just want a direct path) press [enter].

A folium window will appear showing the quickest path determined by the program. The start and end buildings are clearly marked, as are intersections and stopovers (each having a different icon pertaining to the amenity offered). Click on each of the points for more details.

Amenities

• dining
• transportation
• microwave
• study
• atm
• gym
• coffee
• writing centre
• library
• math learning centre