licit-lab/symupy

General remarks and future plans

Closed this issue · 0 comments

aladinoster commented

About

This issue is declared to settle a set of activities and provide a general status on how the current package is behaving. The aim is to establish specific activities towards the 0.4.0 version and enable richer documentation as well as useful guidance to the general public. This issue will work as a master plan for the development of the activities

Policy development update: Since the

General remarks

The current software application 0.3.4 has some characteristics that need enhancement:

  • Unit tests are not fully working. They depend on a local installation and test complex functionalities rather than simple ones. Although the simulator is open source no binary files are available at the current moment so full simulation environment are difficult to test. Although this is the case some unit tests can be developed and created.

  • The current documentation for the project is not standard so it is proposed to standardize this via a unique documentation protocol as well as create some specific documentation useful for demonstrating purposes as well as key development factors

  • The purpose of the software is mainly to retrieve data from the Symuvia Traffic simulator. This is done with the help of exposed methods from the shared library compiled for Symuvia. The main current existing Dynamic shared library methods are the following ones:

    • SymLoadNetworkEx: Load a traffic network within the application (XML file).
    • SymRunEx: Run a single simulation without interruption.
    • SymCreateVehicleEx: Create a vehicle in the simulation.
    • SymCreateVehicleWithRouteEx: Creates a vehicle with a specific route.
    • SymDriveVehicleEx: Drives an existing vehicle.
    • SymGetTotalTravelTimeEx: Retrieves the Total Travel Time of a defined zone (set of links).
    • SymGetTotalTravelDistanceEx: Retrieves the Total Travel Distance of a defined zone (set of links).
    • SymApplyControlZonesEx: Assigns and apply a specific vanishing policy to a determined zone (set of links).
    • SymAddControlZoneEx: Creates a new control zone.
    • SymUnloadCurrentNetworkEx: Unload a network, used at end of simulation.

This package has a general-purpose the functionality to wrap and facilitate the interface with the traffic simulator by
providing a set of objects/ methods and data in such a way that it facilitates the simulation runtime, data collection process, data analysis process, derived indicators, modification of specific traffic conditions, etc.

Activities

  • Update and provide contribution guidelines (unit testing development approach)
  • Define a list of objects to tests and unit tests to solve
  • List and define set of current objects and their interactions

Note: This issue will be suffering permanent updates. Specific tasks to be developed will be tied to new issues that will be specifically documented.