Merge pull request #3193 from matsim-org/addSmallScaleCommercialContr…

…ibToWorkflow Add small scale commercial contrib to workflow
matsim-org · Mar 28, 2024 · fbdee21 · fbdee21
2 parents b243edc + 9db3e93
commit fbdee21
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 7 deletions.
diff --git a/.github/workflows/verify-push.yaml b/.github/workflows/verify-push.yaml
@@ -66,6 +66,7 @@ jobs:
           - contribs/simwrapper
           - contribs/sbb-extensions
           - contribs/simulatedannealing
+          - contribs/small-scale-traffic-generation
           - benchmark
 
     steps:

diff --git a/contribs/README.md b/contribs/README.md
@@ -46,6 +46,7 @@ The MATSim core development team cannot make any guarantee that these extensions
 | [shared_mobility](shared_mobility/README.md)                             | Simulate human-driven shared mobility (i.e., micromobility)
 | [signals](signals/README.md)                                             | Simulate traffic lights microscopically
 | [simwrapper](simwrapper/README.md)                                       | Creates dashboards automatically with [SimWrapper](https://simwrapper.github.io/)
+| [small-scale-traffic-generation](small-scale-traffic-generation/README.md)       | Tool to generate small-scale commercial traffic
 | [socnetsim](socnetsim/README.md)                                         | Social network simulation
 | [sumo](sumo/README.md)                                                   | Converter and integrations for [SUMO](https://sumo.dlr.de/])
 | [taxi](taxi/README.md)                                                   | Taxi service functionality

diff --git a/contribs/small-scale-traffic-generation/README.md b/contribs/small-scale-traffic-generation/README.md
@@ -21,18 +21,18 @@ The tool provides two different model types of small-scale commercial traffic. T
 - The generation model uses only open data.
   - zone shape file:
     - contains the zones for each region
-    - should contain columns: `areaID`, `region`
+    - the user can define the column of the name of the zone
   - structure data:
-    - *dataDistributionPerZone.csv*
       - contains numbers of inhabitants and employees per sector for each `region`
-      - this file should be located next to the config file
   - OSM data:
+    - Regions
+      - shape contains the regions related to the regions in the structure data
+      - the user can define the column of the name of the region
     - Landuse
-      - should contain the following columns: `fclass`
+      - the user can define the column of landuse categories
     - Buildings
-      - should contain the following columns: `type`, `levels`, `area`
-- Remarks:
-  - The zone shape file and the structure data should have the same regions.
+      - should contain the following columns: `levels`, `area`
+      - the user can define the column of the buildings categories
 
 ## Usage
 For generating the traffic, the following steps are necessary: