Skip to content

Road Map (General)

Jump to bottom
Billy Charlton edited this page Nov 2, 2023 · 1 revision

Now that SimWrapper 2.0 is out the door, we are planning a more rigorous "Road Map" to help users understand what to expect from future releases of the product.

This document is a work in progress.

1. Introduction: Project and Goals

There are many options for visualizing transport microsimulation inputs and outputs. SimWrapper aims to complement those options by providing a fully open-source, web-based solution.

Project goals:

  • Support exploring standard MATSim and ActivitySim outputs in an interactive way, whether those files are on a local machine or on server/cloud storage somewhere
  • Publish useful dashboards locally or on the Internet which collate results into cohesive combinations of useful outputs
  • Allow comparison of scenarios as a first-order use case

2. Versions: major releases, feature updates, bugfixes

SimWrapper uses semantic versioning. Major releases have a new version number 2.x, 3.x, etc; while feature additions get point releases 2.1, 2.2, 2.3, and so on. Bug fixes and minor releases are subpoints, e.g. 2.1.1, 2.1.2, 2.1.3.

We strive to keep things backwards-compatible as much as possible; when configuration APIs are "broken" we will do our best to minimize disruption!

The change log keeps a running tab of all changes released in the project.

3. Upcoming features

Features and bugfixes are usually collected into GitHub Milestones before release. Please file issues for bugfixes and to suggest ideas for future versions!

The following features are planned for the near future. Note this is an open-source project and we get things done when they get done...

  • 2.x bugfix release: Version 2 had some regressions compared to release 1; we are trying to iron out the bugs as quickly as possible (see milestone )
  • Standard MATSim dashboard contrib: There is an R library for producing SimWrapper dashboard from MATSim runs but it is not widely used. This feature will create a Java-based contrib that can be added to standard MATSim configurations without extra languages or post-processing. (see milestone )
  • Comparisons and Diffs: some views support "diffs" but the functionality is not consistent and needs a lot of work. This will require some high-level design before coding.

4. How to contribute

The best way to contribute is to file issues on the main SimWrapper repository. Code contributions also welcome!

Clone this wiki locally