MetroFiles

main_directory

demand
- population
- zones
  - zones.geo.parquet
network
- road_network
results
- graphs
  - trip_departure_time_distribution.pdf
- trip_results.parquet
run
- input
- output
  - agent_results.parquet
  - trip_results.parquet
- parameters.json
simulation_area.geo.parquet

CarDriverDistancesFile

Shortest path distance on the road network of each car driver trip.

Path: demand/population/car_driver_distances.parquet
Type: DataFrame

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`trip_id`	string or integer	✕	✕	✓	Identifier of the trip.
`distance`	float	✕	✕	✕	Distance of the shortest path, in meters.

CarDriverODsFile

Origin / destination on the road network for each trip, when traveling as a car driver.

Path: demand/population/car_driver_origins_destinations.parquet
Type: DataFrame

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`trip_id`	string or integer	✕	✕	✓	Identifier of the trip.
`origin_node_id`	string or integer	✕	✕	✕	Identifier of the origin node, on the road network.
`destination_node_id`	string or integer	✕	✕	✕	Identifier of the destination node, on the road network.

CarDriverPreferencesFile

Preferences to travel as a car driver, for each person.

Path: demand/population/car_driver_preferences.parquet
Type: DataFrame

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`person_id`	string or integer	✕	✕	✓	Identifier of the person
`car_driver_cst`	float	✕	✓	✕	Penalty for each trip as a car driver (€).
`car_driver_vot`	float	✕	✓	✕	Value of time as a car driver (€/h).

LinearScheduleFile

Schedule preferences for each trip, for the linear model.

Path: demand/population/linear_schedule_parameters.parquet
Type: DataFrame

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`trip_id`	string or integer	✕	✕	✓	Identifier of the trip.
`beta`	float	✕	✓	✕	Penalty for starting an activity earlier than the desired time (€/h).
`gamma`	float	✕	✓	✕	Penalty for starting an activity later than the desired time (€/h).
`delta`	duration	✕	✓	✕	Length of the desired time window.

OutsideOptionPreferencesFile

Utility of the outside option alternative, for each tour.

Path: demand/population/outside_option_preferences.parquet
Type: DataFrame

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`tour_id`	string or integer	✕	✕	✓	Identifier of the tour.
`outside_option_cst`	float	✕	✓	✕	Utility of the outside option (€).

OutsideOptionTravelTimesFile

Travel time of the outside option alternative, for each tour.

Path: demand/population/outside_option_travel_times.parquet
Type: DataFrame

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`tour_id`	string or integer	✕	✕	✓	Identifier of the tour.
`outside_option_travel_time`	duration	✕	✕	✕	Duration of the tour for the outside option.

PublicTransitPreferencesFile

Preferences to travel by public transit, for each person.

Path: demand/population/public_transit_preferences.parquet
Type: DataFrame

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`person_id`	string or integer	✕	✕	✓	Identifier of the person.
`public_transit_cst`	float	✕	✓	✕	Penalty for each trip in public transit (€).
`public_transit_vot`	float	✕	✓	✕	Value of time in public transit (€/h).

PublicTransitTravelTimesFile

Travel time of each trip, when traveling by public transit.

Path: demand/population/public_transit_travel_times.parquet
Type: DataFrame

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`trip_id`	string or integer	✕	✕	✓	Identifier of the trip.
`public_transit_travel_time`	duration	✕	✕	✕	Duration of the trip by public transit.

TripZonesFile

Origin / destination zones of each trip.

Path: demand/population/trip_zones.parquet
Type: DataFrame

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`trip_id`	string or integer	✕	✕	✓	Identifier of the trip.
`origin_zone_id`	string or integer	✕	✕	✕	Identifier of the origin zone.
`destination_zone_id`	string or integer	✕	✕	✕	Identifier of the destination zone.

TstarsFile

Desired start time for the activity following each trip.

Path: demand/population/tstars.parquet
Type: DataFrame

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`trip_id`	string or integer	✕	✕	✓	Identifier of the trip.
`tstar`	time	✕	✓	✕	Desired start time of the following activity.

ZonesFile

Identifiers and characteristics of the zones in the simulated area.

Path: demand/zones/zones.geo.parquet
Type: GeoDataFrame

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`zone_id`	string or integer	✕	✕	✓	Identifier of the zone.
`name`	string	✓	✓	✕	Name of the zone
`original_id`	string or integer	✓	✓	✕	Identifier of the zone in the original data.

AllDistancesFile

Shortest path distance for each pair of nodes on the road network.

Path: network/road_network/all_distances.parquet
Type: DataFrame

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`origin_id`	string or integer	✕	✕	✕	Identifier of the origine node.
`destination_id`	string or integer	✕	✕	✕	Identifier of the destination node.
`distance`	float	✕	✓	✕	Distance of the shortest path, in meters.

AllFreeFlowTravelTimesFile

Free-flow travel time for each pair of nodes on the road network.

Path: network/road_network/all_free_flow_travel_times.parquet
Type: DataFrame

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`origin_id`	string or integer	✕	✕	✕	Identifier of the origine node.
`destination_id`	string or integer	✕	✕	✕	Identifier of the destination node.
`free_flow_travel_time`	duration	✕	✓	✕	Free-flow travel time.

EdgesCapacitiesFile

Bottleneck capacity of each road-network edge.

Path: network/road_network/edges_capacities.parquet
Type: DataFrame

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`edge_id`	string or integer	✕	✕	✓	Identifier of the edge.
`capacity`	float	✕	✓	✕	Bottleneck capacity of the edge, in PCE per hour.
`capacities`	list of floats	✕	✓	✕	Bottleneck capacity of the edge for different time periods, in PCE per hour.
`times`	list of times	✕	✓	✕	Time at which the bottleneck capacity changes on the edge.

CleanEdgesFile

Characteristics of the road-network edges, after clean up.

Path: network/road_network/edges_clean.geo.parquet
Type: GeoDataFrame

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`edge_id`	string or integer	✕	✕	✓	Identifier of the edge.
`source`	string or integer	✕	✕	✕	Identifier of the edge’s first node.
`target`	string or integer	✕	✕	✕	Identifier of the edge’s last node.
`road_type`	string or integer	✓	✕	✕	Identifier of the edge’s road type.
`length`	float	✕	✕	✕	Length of the edge, in meters.
`speed_limit`	float	✕	✕	✕	Speed limit on the edge, in km/h.
`default_speed_limit`	boolean	✕	✕	✕	Whether the edge speed limit is set from the default value.
`lanes`	float	✕	✕	✕	Number of lanes on the edge.
`default_lanes`	boolean	✕	✕	✕	Whether the edge lane number is set from the default value.
`oneway`	boolean	✕	✕	✕	Whether the edge is part of a one-way road.
`toll`	boolean	✕	✕	✕	Whether the edge has toll.
`roundabout`	boolean	✕	✕	✕	Whether the edge is part of a roundabout.
`give_way`	boolean	✕	✕	✕	Whether the edge end intersection has a give-way sign.
`stop`	boolean	✕	✕	✕	Whether the edge end intersection has a stop sign.
`traffic_signals`	boolean	✕	✕	✕	Whether the edge end intersection has traffic signals.
`urban`	boolean	✕	✕	✕	Whether the edge is within a urban area.
`source_in_degree`	unsigned integer	✕	✕	✕	Number of incoming edges for the source node.
`source_out_degree`	unsigned integer	✕	✕	✕	Number of outgoing edges for the source node.
`target_in_degree`	unsigned integer	✕	✕	✕	Number of incoming edges for the target node.
`target_out_degree`	unsigned integer	✕	✕	✕	Number of outgoing edges for the target node.
`name`	string	✓	✓	✕	Name of the edge.
`original_id`	string or integer	✓	✓	✕	Identifier of the edge in the original data.

EdgesPenaltiesFile

Free-flow time penalties of each road-network edge.

Path: network/road_network/edges_penalties.parquet
Type: DataFrame

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`edge_id`	string or integer	✕	✕	✓	Identifier of the edge.
`constant`	float	✕	✓	✕	Constant time penalty of the edge, in seconds.

RawEdgesFile

Characteristics of the road-network edges, before clean up.

Path: network/road_network/edges_raw.geo.parquet
Type: GeoDataFrame

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`edge_id`	string or integer	✕	✕	✓	Identifier of the edge.
`source`	string or integer	✕	✕	✕	Identifier of the edge’s first node.
`target`	string or integer	✕	✕	✕	Identifier of the edge’s last node.
`road_type`	string or integer	✓	✕	✕	Identifier of the edge’s road type.
`length`	float	✕	✕	✕	Length of the edge, in meters.
`speed_limit`	float	✓	✓	✕	Speed limit on the edge, in km/h.
`lanes`	float	✓	✓	✕	Number of lanes on the edge.
`oneway`	boolean	✓	✓	✕	Whether the edge is part of a one-way road.
`toll`	boolean	✓	✓	✕	Whether the edge has toll.
`roundabout`	boolean	✓	✓	✕	Whether the edge is part of a roundabout.
`give_way`	boolean	✓	✓	✕	Whether the edge end intersection has a give-way sign.
`stop`	boolean	✓	✓	✕	Whether the edge end intersection has a stop sign.
`traffic_signals`	boolean	✓	✓	✕	Whether the edge end intersection has traffic signals.
`urban`	boolean	✓	✓	✕	Whether the edge is within a urban area.
`name`	string	✓	✓	✕	Name of the edge.
`original_id`	string or integer	✓	✓	✕	Identifier of the edge in the original data.

TripDepartureTimeDistributionPlotFile

Histogram of departure time distribution, over trips.

Path: results/graphs/trip_departure_time_distribution.pdf
Type: Plot

TripResultsFile

Clean results for each trip.

Path: results/trip_results.parquet
Type: DataFrame

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`trip_id`	string or integer	✕	✕	✕	Identifier of the trip.
`mode`	string	✕	✕	✕	Mode used for the trip.
`is_road`	boolean	✕	✕	✕	Whether the trip is done on the road network.
`departure_time`	time	✕	✕	✕	Departure time of the trip.
`arrival_time`	time	✕	✕	✕	Arrival time of the trip.
`travel_time`	duration	✕	✕	✕	Travel time of the trip.
`route_free_flow_travel_time`	duration	✕	✓	✕	Free flow travel time of the trip, on the same route.
`global_free_flow_travel_time`	duration	✕	✓	✕	Free flow travel time of the trip, over any route.
`utility`	float	✕	✓	✕	Utility of the trip.
`travel_utility`	float	✕	✓	✕	Travel utility of the trip.
`schedule_utility`	float	✕	✓	✕	Schedule utility of the trip.
`length`	float	✕	✓	✕	Length of the route taken, in meters.
`nb_edges`	unsigned integer	✕	✓	✕	Number of road edges taken.

MetroAgentsFile

Simulated agents, as input to Metropolis-Core.

Path: run/input/agents.parquet
Type: DataFrame

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`agent_id`	string or integer	✕	✕	✓	Identifier of the agent.
`alt_choice.type`	string	✓	✓	✕	Type of choice model for the alternative choice.
`alt_choice.u`	float	✓	✓	✕	Uniform draw to simulate the chosen alternative.
`alt_choice.mu`	float	✓	✓	✕	Variance of the stochastic terms in the utility function.

MetroAlternativesFile

Simulated alternatives, as input to Metropolis-Core

Path: run/input/alts.parquet
Type: DataFrame

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`agent_id`	string or integer	✕	✕	✕	Identifier of the agent.
`alt_id`	string or integer	✕	✕	✕	Identifier of the alternative.
`origin_delay`	float	✓	✓	✕	Extra delay between the chosen departure time and the actual first trip start, in seconds.
`dt_choice.type`	string	✕	✓	✕	Whether departure time is exogenous, random discrete, or random continuous.
`dt_choice.departure_time`	float	✓	✓	✕	Departure time, when exogenous, in seconds after midnight.
`dt_choice.period`	list of floats	✓	✓	✕	Time window in which the departure time is chosen.
`dt_choice.interval`	float	✓	✓	✕	Time between two intervals of departure time, in seconds.
`dt_choice.offset`	float	✓	✓	✕	Offset time added to the selected departure time, in seconds.
`dt_choice.model.type`	string	✓	✓	✕	Type of choice model when departure time is randomly chosen.
`dt_choice.model.u`	float	✓	✓	✕	Uniform draw to simulate the chosen departure time.
`dt_choice.model.mu`	float	✓	✓	✕	Variance of the stochastic terms in the utility function.
`dt_choice.model.constants`	list of floats	✓	✓	✕	Constant value added to the utility of each departure-time interval.
`constant_utility`	float	✓	✓	✕	Constant utility added to the alternative.

MetroEdgesFile

Road-network edges, as input to Metropolis-Core.

Path: run/input/edges.parquet
Type: DataFrame

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`edge_id`	string or integer	✕	✕	✓	Identifier of the edge.
`source`	string or integer	✕	✕	✕	Identifier of the edge’s first node.
`target`	string or integer	✕	✕	✕	Identifier of the edge’s last node.
`length`	float	✕	✕	✕	Length of the edge, in meters.
`speed`	float	✕	✕	✕	Base speed on the edge (m/s).
`lanes`	float	✕	✕	✕	Number of lanes on the edge.
`bottleneck_flow`	float	✓	✓	✕	Maximum incoming and outgoing flow of vehicles at the edge’s entry and exit bottlenecks (PCE/s).
`bottleneck_flows`	list of floats	✓	✓	✕	Time-dependent bottleneck flows.
`bottleneck_times`	list of floats	✓	✓	✕	Timing of the time-dependent bottleneck flows.
`constant_travel_time`	float	✓	✓	✕	Constant travel-time penalty (seconds).
`overtaking`	boolean	✕	✕	✕	Whether vehicles can overtake each other to exit the edge.

MetroTripsFile

Simulated trips, as input to Metropolis-Core.

Path: run/input/trips.parquet
Type: DataFrame

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`agent_id`	string or integer	✕	✕	✕	Identifier of the agent.
`alt_id`	string or integer	✕	✕	✕	Identifier of the alternative.
`trip_id`	string or integer	✕	✕	✕	Identifier of the trip.
`class.type`	string	✕	✕	✕	Type of trip.
`class.origin`	string or integer	✓	✓	✕	Identifier of the origin node of the trip.
`class.destination`	string or integer	✓	✓	✕	Identifier of the destination node of the trip.
`class.vehicle`	string or integer	✓	✓	✕	Identifier of the vehicle type of the trip.
`class.route`	list of strings or integers	✓	✓	✕	List of edge identifiers representing the route itinerary to be followed.
`class.travel_time`	float	✓	✓	✕	Exogenous travel time of the trip, in seconds.
`stopping_time`	float	✓	✓	✕	Time spent at the end of the trip, before the next trip starts, in seconds.
`constant_utility`	float	✓	✓	✕	Constant utility added to the trip utility.
`alpha`	float	✓	✓	✕	Value of time (€/s).
`schedule_utility.type`	string	✓	✓	✕	Type of function used for the schedule delay at trip’s destination.
`schedule_utility.tstar`	float	✓	✓	✕	Desired arrival time at destination, in seconds after midnight.
`schedule_utility.beta`	float	✓	✓	✕	Penalty for arriving earlier than the desired arrival time (€/s).
`schedule_utility.gamma`	float	✓	✓	✕	Penalty for arriving later than the desired arrival time (€/s).
`schedule_utility.delta`	float	✓	✓	✕	Length of the desired arrival-time window, in seconds.

MetroVehicleTypesFile

Simulated vehicle types, as input to Metropolis-Core.

Path: run/input/vehicle_types.parquet
Type: DataFrame

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`vehicle_id`	string or integer	✕	✕	✓	Identifier of the vehicle type.
`headway`	float	✕	✕	✕	Typical length between two vehicles from head to head, in meters.
`pce`	float	✕	✕	✕	Passenger car equivalent of this vehicle type.
`speed_function.type`	string	✓	✓	✕	Type of function used to convert from the base edge speed to the vehicle-specific edge speed.
`speed_function.upper_bound`	float	✓	✓	✕	Maximum speed allowed for this vehicle type (m/s).
`allowed_edges`	list of strings or integers	✓	✓	✕	Identifiers of the edges that this vehicle type is allowed to take.
`restricted_edges`	list of strings or integers	✓	✓	✕	Identifiers of the edges that this vehicle type cannot take.

MetroAgentResultsFile

Agent-level results from the Metropolis-Core Simulation.

Path: run/output/agent_results.parquet
Type: DataFrame

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`agent_id`	string or integer	✕	✕	✕	Identifier of the agent.
`selected_alt_id`	string or integer	✕	✕	✕	Identifier of the alternative chosen.
`expected_utility`	float	✕	✕	✕	Expected utility of the agent.
`shifted_alt`	boolean	✕	✕	✕	Whether the agent shifted chosen alternative compared to the previous iteration.
`departure_time`	float	✕	✓	✕	Departure time of the trip, in seconds after midnight.
`arrival_time`	float	✕	✓	✕	Arrival time of the trip, in seconds after midnight.
`total_travel_time`	float	✕	✓	✕	Total travel time spent over all the trips of the agent, in seconds.
`utility`	float	✕	✕	✕	Realized utility of the agent.
`alt_expected_utility`	float	✕	✕	✕	Expected utility of the agent for the chosen alternative.
`departure_time_shift`	float	✕	✓	✕	By how much departure time changed compared to the previous iteration, in seconds.
`nb_road_trips`	unsigned integer	✕	✕	✕	Number of road trips taken.
`nb_virtual_trips`	unsigned integer	✕	✕	✕	Number of virtual trips taken.

MetroTripResultsFile

Trip-level results from the Metropolis-Core simulation.

Path: run/output/trip_results.parquet
Type: DataFrame

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`agent_id`	string or integer	✕	✕	✕	Identifier of the agent performing the trip.
`trip_id`	string or integer	✕	✕	✕	Identifier of the trip.
`trip_index`	unsigned integer	✕	✕	✕	Index of the trip in the agent’s trip chain.
`departure_time`	float	✕	✕	✕	Departure time of the trip, in seconds after midnight.
`arrival_time`	float	✕	✕	✕	Arrival time of the trip, in seconds after midnight.
`travel_utility`	float	✕	✕	✕	Travel utility of the trip.
`schedule_utility`	float	✕	✕	✕	Schedule utility of the trip.
`departure_time_shift`	float	✕	✕	✕	By how much departure time changed compared to the previous iteration, in seconds.
`road_time`	float	✕	✓	✕	Time spent traveling on the road segments, in seconds.
`in_bottleneck_time`	float	✕	✓	✕	Time spent waiting at an entry bottleneck, in seconds.
`out_bottleneck_time`	float	✕	✓	✕	Time spent waiting at an exit bottleneck, in seconds.
`route_free_flow_travel_time`	float	✕	✓	✕	Free flow travel time of the trip, on the same route, in seconds.
`global_free_flow_travel_time`	float	✕	✓	✕	Free flow travel time of the trip, over any route, in seconds.
`length`	float	✕	✓	✕	Length of the route taken, in meters.
`length_diff`	float	✕	✓	✕	Length of the route taken that was not taken during the previous iteration, in meters.
`pre_exp_departure_time`	float	✕	✕	✕	Expected departure time of the trip before the iteration started, in seconds after midnight.
`pre_exp_arrival_time`	float	✕	✕	✕	Expected arrival time of the trip before the iteration started, in seconds after midnight.
`exp_arrival_time`	float	✕	✕	✕	Expected arrival time of the trip at trip start, in seconds after midnight.
`nb_edges`	unsigned integer	✕	✓	✕	Number of road edges taken.

MetroParametersFile

JSON file with the parameters for the Metropolis-Core simulation.

Path: run/parameters.json
Type: Text

SimulationAreaFile

Single-feature file with the geometry of the simulation area.

Path: simulation_area.geo.parquet
Type: GeoDataFrame
Max rows: 1

Keyboard shortcuts

METROPOLIS2 The Book