dev_aiosut_ui

AioSUT is a RCF-funded project about developing an AI-based optimization tool for city planning. In this repository reisdes the development code for the AioSUT tool's user interface.

User Guide

1. Install the following pre-requisites:
   • Python: Download the latest Python from Python's official website. Pip is recommended as the package installer.
   • Simulation for Urban MObility (SUMO): Follow the installation instructions from SUMO's official website.
   • Git for Windows, if using Windows: Download the latest Git for Windows from Git's official website.
2. Clone the repository
3. Run sh commands.sh in the command line in the root folder
4. Once the terminal has finished printing the link, click on it
5. Success!

Developer Guide

Contribution pipeline

The project follows a relaxed development pipeline by using issues, pull requests and a project roadmap to keep track of features, bugs, version releases and milestones.

1. Check out the project roadmap. P0 denotes the most urgent issues to be solved for the next milestone, P1 the next most urgent and so on. Milestones are used to keep track of the project-related deadlines, such as the workshops. Version releases denote the overall progress of the UI.
2. Pick an issue to work on by assigning yourself to it.
3. Update the issue and project roadmap. Use the semantic versioning guidelines for the release version column.
4. Solve the issue as you see fit and submit a pull request.
5. Wait patiently until the pull request is merged.
6. Once merged, update the end date to the roadmap and enjoy your work's results! Sara will handle the rest of the roadmap, milestones and version releases ater you.
7. Remember to pass the good on: check and close other people's pull requests when you can!

Structure of the repository

• commands.sh contains the command line script used to run the tool for the first time.
• LICENSE contains the info about the license this project is distributed under.
• requirements.txt contains a list of the required Python libraries for running the tool. The command line script uses this list to install them via the package installer.
• app.ipynb is used as an interface for running the simulation tool and analysing the results.
• The simulation folder contains the simulation loop as a whole.
  • functions.py contains all the functions needed for runing SUMO simulations and fetching the results for visualization.
  • The sub-folders of the simulation folder, eg. kamppi, are area folders that contain the simulation configurations and simulation outputs for each area. The configurations consist mainly of three files:
    • the road network used in the simulation, .net.xml
    • the routes of the vehicles, .rou.xml
    • file configurations for the simulation, .sumocfg
    • In each area folder, there is a sub-folder output for the simulation outputs.

License

Distributed under the MIT License. See the LICENSE -file for more information.