huynvuong / traffic-simulator

Source code of city traffic simulation

CSCE 361 - City Traffic Simulator

• Contributors:
  • Huy Vuong
  • Mohammad Majid
  • Bryan Chavéz
  • Brian Nguyen

Getting started

• Clone down the project
• Having either Python 3.6 or later version on your device
• Install dependencies : pip install -r requirements.txt
  • Note : If your device doesn't have built-in Python tkinter, also run the following commnad : apt-get install python3-tk

Milestone

Increment 1 : Analysis

• An initial version of RAD is attached in Requirements directory

Increment 2 : Object oriented Analysis and UML

• An initial version of Class and sequence digram
• Tools : draw.io
  • Display : (*.png)
  • Editable : (*.xml)
• Target platform : Web Application / Application
• Implementation language : Python, Django (maybe), HTML, XML, UML

Increment 3 : Design

• An initial version of Software Design Document is in the Design directory
• • Modules added numpy
• Main frame prototype is added. Prototype right now is stored in src directory
  • If the user has all the requirements python modules, just simply double click Simulation.py (main method)
  • If the user unable to execute Simulation.py by double-clicking, just navigate to the src and execute
    • sh run.sh

Increment 4 : Object Design Development and Coding

• Class Diagram updated, some Sequence Diagram modified
• Program is stored in the src, structure are designed based solely on Object Oriented Paradigm
• A small testing framework, is set up for testing along with designing
• New modules added : pytest, Pillow
• Features developed:
  • Application is readable and usable as a GUI application.
  • Cars and City is viewable and understandable, car is able to move around the city when start button is triggered
• Try it!
  • Window Users: Simulation.exe is located in src/dist
  • Build it your self: Build your own runnable by execute sim_build.c Note : Some path in Simulation.spec will need to be modified
  • Downloadable content can be found at https://cse.unl.edu/~hvuong/traffic-simulation/

Increment 5 : Coding and System Testing

• RAD (Requirement Analysis Document) version 2.3 added with some updates and modification
• Test Plan and Test Report added
• More code, implementations added
• pytest is used as a main frame for testing
• Modified Breath First Search (BFS) is used to implement car path finding. Algorithm implementation is in Map.optimal_path()
• To run pytest : py.test -v --doctest-modules test_simulation_data.py
  • -v : A more verbose output
  • --doctest-modules : BONUS, flags for doctest in Python

Increment 6 : Maintenance

• 2 bot created : gitlab-ci and travis to help automate daily program testing and maintenance