Skip to content

Commit

Permalink
Merge pull request #27 from BauhausLuftfahrt/documentationUpdate
Browse files Browse the repository at this point in the history
Update DOCUMENTATION.md
  • Loading branch information
RRothfeld authored Sep 17, 2019
2 parents 63e20df + 404471f commit ce93e42
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# UAM-MATSim Input Files
* UAM-MATSim Version: uam-1.0-SNAPSHOT

Expand Down Expand Up @@ -36,7 +35,7 @@ A UAM-enabled MATSim network is required to run a UAM-enabled MATSim simulation.
Use [RunCreateUAMScenario](#runcreateuamscenario) to generate UAM-enabled MATSim network.

## 2. UAM Vehicles
A UAM vehicles file is required to run a UAM-enabled MATSim simulation. As shown in the script excerpt below, a UAM vehicles file contains attribute values for stations, vehicle types, and vehicles.
A UAM vehicles file (or simply, uam file) is required to run a UAM-enabled MATSim simulation. As shown in the script excerpt below, a UAM vehicles file contains attribute values for stations, vehicle types, and vehicles.

Use [RunCreateUAMScenario](#runcreateuamscenario) to generate UAM vehicles file.
### Structure
Expand Down Expand Up @@ -131,7 +130,7 @@ Creates UAM-including MATSim network and corresponding uam-vehicles file, which
* (optional) flight-links.csv header [format]: node_from [`String`], node_to [`String`], link_capacity [`double`], link_freespeed [`double` m/s]

### RunAddModeToNetwork
(**???**) Adds a specified mode to an existing network if another specified mode is present. (**???**)
Adds specified mode(s) to an existing network if other specified mode(s) is (are) present.
* Location: net.bhl.matsim.uam.scenario.utils.network.RunAddModeToNetwork
* Arguments: `PATH/network.xml(.gz)`

Expand All @@ -155,7 +154,10 @@ Generates a shape file of a given network in MATSim format.
### ConfigAddUAMParameters
Adds UAM parameters to an existing configuration file
* Location: net.bhl.matsim.uam.scenario.utils
* Arguments: TODO
* Arguments: `PATH/config.xml NAME-uam-file(.xml) allowed-modes threads search-radius walk-distance routing-strategy pt-simulation PATH/output-file.xml`
* allowed-modes example: `car,pt,uam`
* Possible routing strategies: `MAXUTILITY`, `MAXACCESSUTILITY`, `MINTRAVELTIME`, `MINACCESSTRAVELTIME`, `MINDISTANCE`, `MINACCESSDISTANCE`, `PREDEFINED`
* pt-simulation: `true`, `false`

## 3. Analysis Scripts
### RunCalculatePTTravelTimes
Expand Down

0 comments on commit ce93e42

Please sign in to comment.