MetroFiles

main_directory

demand
- population
- zones
  - zones.geo.parquet
network
- road_network
results
run
- input
- output
- parameters.json
simulation_area.geo.parquet

CarDriverPreferencesFile

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

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

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).

CarShortestDistancesFile

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

Path: demand/population/car_driver_shortest_distances.parquet
Type: DataFrame
Steps: CarShortestDistancesStep

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.

CarDriverWithPassengersPreferencesFile

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

Path: demand/population/car_driver_with_passengers_preferences.parquet
Type: DataFrame
Steps: CarDriverWithPassengersPreferencesStep

Show columns

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

CarFreeFlowDistancesFile

Distance of the fastest free-flow path on the road network of each car trip.

Path: demand/population/car_free_flow_distances.parquet
Type: DataFrame
Steps: CarFreeFlowDistancesStep

Show columns

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

CarFuelFile

Fuel consumption of each car trip, based on the length of the fastest free-flow path.

Path: demand/population/car_fuel_consumption.parquet
Type: DataFrame
Steps: CarFuelStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`trip_id`	string or integer	✕	✕	✓	Identifier of the trip.
`fuel_consumption`	float	✕	✓	✕	Fuel consumption of the trip, in liters.
`fuel_cost`	float	✕	✓	✕	Fuel cost of the trip, in €.

CarODsFile

Origin / destination on the road network for each trip, when traveling by car.

Path: demand/population/car_origins_destinations.parquet
Type: DataFrame
Steps: CustomODMatrixStep, GravityODMatrixStep, ODMatrixEachStep

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.

CarPassengerPreferencesFile

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

Path: demand/population/car_passenger_preferences.parquet
Type: DataFrame
Steps: CarPassengerPreferencesStep

Show columns

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

CarRidesharingPreferencesFile

Preferences to travel by car ridesharing (driver or passenger), for each person.

Path: demand/population/car_ridesharing_preferences.parquet
Type: DataFrame
Steps: CarRidesharingPreferencesStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`person_id`	string or integer	✕	✕	✓	Identifier of the person
`car_ridesharing_cst`	float	✕	✓	✕	Penalty for each trip by car ridesharing (€).
`car_ridesharing_vot`	float	✕	✓	✕	Value of time by car ridesharing (€/h).

HouseholdsFile

Identifiers and characteristics of the simulated households.

Path: demand/population/households.parquet
Type: DataFrame
Steps: GenericPopulationStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`household_id`	string or integer	✕	✕	✓	Identifier of the household.
`number_of_persons`	unsigned integer	✕	✕	✕	Number of persons in the household.
`number_of_vehicles`	unsigned integer	✕	✓	✕	Number of vehicles (cars) owned by the household.
`number_of_bikes`	unsigned integer	✕	✓	✕	Number of bicycles owned by the household.
`income`	float	✕	✓	✕	Monthly disposable income of the household.

LinearScheduleFile

Schedule preferences for each trip, for the linear model.

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

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
Steps: OutsideOptionPreferencesStep

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
Steps: OutsideOptionTravelTimesFromRoadDistancesStep

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.

PersonsFile

Identifiers and characteristics of the simulated persons.

Path: demand/population/persons.parquet
Type: DataFrame
Steps: GenericPopulationStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`person_id`	string or integer	✕	✕	✓	Identifier of the person.
`household_id`	string or integer	✕	✕	✕	Identifier of the household to which the person belongs.
`age`	unsigned integer	✕	✓	✕	Age of the person.
`employed`	boolean	✕	✓	✕	Whether the person is employed.
`woman`	boolean	✕	✓	✕	Whether the person is a woman.
`socioprofessional_class`	unsigned integer	✕	✓	✕	Socioprofessional class of the person.
`has_driving_license`	boolean	✕	✓	✕	Whether the person has a driving license.
`has_pt_subscription`	boolean	✕	✓	✕	Whether the person has a public-transit subscription.

PublicTransitPreferencesFile

Preferences to travel by public transit, for each person.

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

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
Steps: PublicTransitTravelTimesFromRoadDistancesStep

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.

TripsFile

Identifiers and order of the trips for each person.

Path: demand/population/trips.parquet
Type: DataFrame
Steps: GenericPopulationStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`trip_id`	string or integer	✕	✕	✓	Identifier of the trip.
`person_id`	string or integer	✕	✕	✕	Identifier of the person performing the trip.
`household_id`	string or integer	✕	✕	✕	Identifier of the household to which the person performing the trip belongs.
`trip_index`	unsigned integer	✕	✓	✕	Index of the trip in the trip chain of the person, starting at 1.
`tour_id`	string or integer	✕	✕	✕	Identifier of the home-tour this trip is part of.

TstarsFile

Desired start time for the activity following each trip.

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

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.

UniformDrawsFile

Draws for the inverse transform sampling of mode choice and departure-time choice, of each tour.

Path: demand/population/uniform_draws.parquet
Type: DataFrame
Steps: UniformDrawsStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`tour_id`	string or integer	✕	✕	✓	Identifier of the tour.
`mode_u`	float	✕	✕	✕	Random uniform draw for mode choice.
`departure_time_u`	float	✕	✕	✕	Random uniform draw for departure-time choice.

ZonesFile

Identifiers and characteristics of the zones in the simulated area.

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

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.

AllRoadDistancesFile

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

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

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
Steps: AllFreeFlowTravelTimesStep

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
Steps: ExogenousCapacitiesStep

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
Steps: PostprocessRoadNetworkStep

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.
`hov_lanes`	float	✕	✕	✕	Number of HOV lanes on the edge (among the edge’s lanes).
`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.

EdgesFreeFlowTravelTimeFile

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

Path: network/road_network/edges_free_flow_travel_time.parquet
Type: DataFrame
Steps: EdgesFreeFlowTravelTimesStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`edge_id`	string or integer	✕	✕	✓	Identifier of the edge.
`free_flow_travel_time`	duration	✕	✕	✕	Free-flow travel time of the edge.

EdgesPenaltiesFile

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

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

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
Steps: CircularNetworkStep, CustomRoadImportStep, GridNetworkStep

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.

ExpectedRoadTravelTimesConvergencePlotFile

RMSE of expected edge-level travel times from one iteration to another.

Path: results/graphs/convergence_expected_road_travel_times.png
Type: Plot
Steps: ConvergencePlotStep

SimulatedRoadTravelTimesConvergencePlotFile

RMSE of simulated edge-level travel times from one iteration to another.

Path: results/graphs/convergence_simulated_road_travel_times.png
Type: Plot
Steps: ConvergencePlotStep

TourDepartureTimeConvergencePlotFile

RMSE of departure-time shift from one iteration to another.

Path: results/graphs/convergence_tour_departure_time.png
Type: Plot
Steps: ConvergencePlotStep

ExpectedRoadNetworkCongestionFunctionPlotFile

Expected congestion function over all edges of the road network. Values are computed as Σ exp travel time / Σ free-flow travel time - 1, with the sumations over all edges.

Path: results/graphs/network_congestion_function_expected.png
Type: Plot
Steps: RoadNetworkCongestionFunctionPlotsStep

SimulationRoadNetworkCongestionFunctionPlotFile

Simulated congestion function over all edges of the road network. Values are computed as Σ sim travel time / Σ free-flow travel time - 1, with the sumations over all edges.

Path: results/graphs/network_congestion_function_simulated.png
Type: Plot
Steps: RoadNetworkCongestionFunctionPlotsStep

TripDepartureTimeDistributionPlotFile

Histogram of departure time distribution, over trips.

Path: results/graphs/trip_departure_time_distribution.png
Type: Plot
Steps: TripDepartureTimeDistributionStep

IterationResultsFile

Clean aggregate results over iterations.

Path: results/iteration_results.parquet
Type: DataFrame
Steps: IterationResultsStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`iteration`	unsigned integer	✕	✕	✓	Iteration counter.
`mean_surplus`	float	✕	✕	✕	Mean surplus (or expected utility) over agents.
`std_surplus`	float	✕	✕	✕	Standard-deviation of surplus (or expected utility) over agents. This can be an indicator of equity.
`mean_tour_departure_time`	time	✕	✓	✕	Mean tour-level departure time.
`mean_tour_arrival_time`	time	✕	✓	✕	Mean tour-level arrival time.
`mean_tour_travel_time`	duration	✕	✓	✕	Mean tour-level travel time.
`mean_tour_simulated_utility`	float	✕	✓	✕	Mean tour-level simulated utility.
`mean_tour_expected_utility`	float	✕	✓	✕	Mean tour-level expected utility of the selected mode.
`mean_tour_departure_time_shift`	duration	✕	✓	✕	Mean tour-level departure-time shift compared to the previous iteration, for tours with no mode shift.
`rmse_tour_departure_time`	duration	✕	✓	✕	RMSE of tour-level departure-time shifts for tours with no mode shift.
`nb_road_trips`	unsigned integer	✕	✕	✕	Total number of road trips.
`nb_non_road_trips`	unsigned integer	✕	✕	✕	Total number of non-road trips.
`nb_outside_options`	unsigned integer	✕	✕	✕	Number of tours choosing the outside option.
`mean_trip_departure_time`	time	✕	✓	✕	Mean departure time from origin of all trips.
`mean_trip_arrival_time`	time	✕	✓	✕	Mean arrival time at destination of all trips.
`mean_trip_travel_time`	duration	✕	✓	✕	Mean trip-level travel time of all trips.
`mean_trip_utility`	float	✕	✓	✕	Mean simulated utility of all trips.
`mean_road_trip_departure_time`	time	✕	✓	✕	Mean departure time from origin of road trips.
`mean_road_trip_arrival_time`	time	✕	✓	✕	Mean arrival time at destination of road trips.
`mean_road_trip_travel_time`	duration	✕	✓	✕	Mean trip-level travel time of road trips.
`mean_road_trip_route_free_flow_travel_time_mean`	duration	✕	✓	✕	Mean free-flow travel time of road trips, on the selected route.
`mean_road_trip_global_free_flow_travel_time`	duration	✕	✓	✕	Mean travel time of road trips, on the fastest free-flow route.
`mean_road_trip_route_congestion_time`	duration	✕	✓	✕	Mean time lost in congestion of road trips, for the selected route.
`mean_road_trip_global_congestion_time`	duration	✕	✓	✕	Mean time lost in congestion of road trips, compared to the fastest free-flow route.
`mean_road_trip_length`	float	✕	✓	✕	Mean length of the selected route for road trips (in meters).
`mean_road_trip_edge_count`	float	✕	✓	✕	Mean number of edges of the selected route for road trips.
`mean_road_trip_utility`	float	✕	✓	✕	Mean simulated utility of road trips.
`mean_road_trip_exp_travel_time`	duration	✕	✓	✕	Mean expected travel time of road trips.
`mean_road_trip_exp_travel_time_abs_diff`	duration	✕	✓	✕	Mean absolute difference between expected and simulated travel time of road trips.
`rmse_road_trip_exp_travel_time_diff`	duration	✕	✓	✕	RMSE of the difference between the expected and simulated travel time of road trips.
`mean_road_trip_length_diff`	float	✕	✓	✕	Mean length of the selected route that was not selected during the previous iteration, for road trips.
`rmse_simulated_road_travel_times`	duration	✕	✓	✕	RMSE between the simulated edge-level travel-time function for the current iteration and the expected edge-level travel-time function for the previous iteration. The mean is taken over all edges and vehicle types.
`rmse_expected_road_travel_times`	duration	✕	✓	✕	RMSE between the expected edge-level travel-time function for the current iteration and the expected edge-level travel-time function for the previous iteration. The mean is taken over all edges and vehicle types.

TripResultsFile

Clean results for each trip.

Path: results/trip_results.parquet
Type: DataFrame
Steps: TripResultsStep

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
Steps: WriteMetroAgentsStep

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
Steps: WriteMetroAlternativesStep

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
Steps: WriteMetroEdgesStep

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
Steps: WriteMetroTripsStep

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
Steps: WriteMetroVehicleTypesStep

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
Steps: RunSimulationStep

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.

MetroIterationResultsFile

Aggregate results over iterations from the Metropolis-Core simulation.

Path: run/output/iteration_results.parquet
Type: DataFrame
Steps: RunSimulationStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`iteration_counter`	unsigned integer	✕	✕	✕	Iteration counter
`surplus_mean`	float	✕	✕	✕	Mean surplus (or expected utility) over agents.
`surplus_std`	float	✕	✕	✕	Standard-deviation of surplus (or expected utility) over agents.
`surplus_min`	float	✕	✕	✕	Minimum surplus (or expected utility) over agents.
`surplus_max`	float	✕	✕	✕	Maximum surplus (or expected utility) over agents.
`trip_alt_count`	unsigned integer	✕	✕	✕	Number of agents who chose an alternative with at least 1 trip.
`alt_departure_time_mean`	float	✕	✓	✕	Mean departure time of the first trip, over agents (number of seconds since midnight).
`alt_departure_time_std`	float	✕	✓	✕	Standard-deviation of departure time of the first trip, over agents (number of seconds since midnight).
`alt_departure_time_min`	float	✕	✓	✕	Minimum departure time of the first trip, over agents (number of seconds since midnight).
`alt_departure_time_max`	float	✕	✓	✕	Maximum departure time of the first trip, over agents (number of seconds since midnight).
`alt_arrival_time_mean`	float	✕	✓	✕	Mean arrival time of the last trip, over agents (in number of seconds since midnight).
`alt_arrival_time_std`	float	✕	✓	✕	Standard-deviation of arrival time of the last trip, over agents (in number of seconds since midnight).
`alt_arrival_time_min`	float	✕	✓	✕	Minimum arrival time of the last trip, over agents (in number of seconds since midnight).
`alt_arrival_time_max`	float	✕	✓	✕	Maximum arrival time of the last trip, over agents (in number of seconds since midnight).
`alt_travel_time_mean`	float	✕	✓	✕	Mean total travel time (i.e., for all trips), over agents (in seconds).
`alt_travel_time_std`	float	✕	✓	✕	Standard-deviation of total travel time (i.e., for all trips), over agents (in seconds).
`alt_travel_time_min`	float	✕	✓	✕	Minimum total travel time (i.e., for all trips), over agents (in seconds).
`alt_travel_time_max`	float	✕	✓	✕	Maximum total travel time (i.e., for all trips), over agents (in seconds).
`alt_utility_mean`	float	✕	✓	✕	Mean simulated utility of the selected alternative, over agents.
`alt_utility_std`	float	✕	✓	✕	Standard-deviation of simulated utility of the selected alternative, over agents.
`alt_utility_min`	float	✕	✓	✕	Minimum simulated utility of the selected alternative, over agents.
`alt_utility_max`	float	✕	✓	✕	Maximum simulated utility of the selected alternative, over agents.
`alt_expected_utility_mean`	float	✕	✓	✕	Mean surplus (or expected utility) for the selected alternative, over agents.
`alt_expected_utility_std`	float	✕	✓	✕	Standard-deviation of surplus (or expected utility) for the selected alternative, over agents.
`alt_expected_utility_min`	float	✕	✓	✕	Minimum surplus (or expected utility) for the selected alternative, over agents.
`alt_expected_utility_max`	float	✕	✓	✕	Maximum surplus (or expected utility) for the selected alternative, over agents.
`alt_dep_time_shift_mean`	float	✕	✓	✕	Mean departure-time shift of the first trip compared to the previous iteration, over agent keeping the same alternative (in seconds).
`alt_dep_time_shift_std`	float	✕	✓	✕	Standard-deviation of departure-time shift of the first trip compared to the previous iteration, over agent keeping the same alternative (in seconds).
`alt_dep_time_shift_min`	float	✕	✓	✕	Minimum departure-time shift of the first trip compared to the previous iteration, over agent keeping the same alternative (in seconds).
`alt_dep_time_shift_max`	float	✕	✓	✕	Maximum departure-time shift of the first trip compared to the previous iteration, over agent keeping the same alternative (in seconds).
`alt_dep_time_rmse`	float	✕	✓	✕	RMSE of first-trip departure-time shift over agents keeping the same alternative.
`road_trip_count`	unsigned integer	✕	✓	✕	Total number of road trips in the selected alternatives.
`nb_agents_at_least_one_road_trip`	unsigned integer	✕	✓	✕	Number of agents with at least one road trip in their selected alternative.
`nb_agents_all_road_trips`	unsigned integer	✕	✓	✕	Number of agents with only road trips in their selected alternative.
`road_trip_count_by_agent_mean`	float	✕	✓	✕	Mean number of road trips, over all agents with at least one road trip.
`road_trip_count_by_agent_std`	float	✕	✓	✕	Standard-deviation of number of road trips, over all agents with at least one road trip.
`road_trip_count_by_agent_min`	float	✕	✓	✕	Minimum number of road trips, over all agents with at least one road trip.
`road_trip_count_by_agent_max`	float	✕	✓	✕	Maximum number of road trips, over all agents with at least one road trip.
`road_trip_departure_time_mean`	float	✕	✓	✕	Mean departure time from origin, over all road trips (in number of seconds after midnight).
`road_trip_departure_time_std`	float	✕	✓	✕	Standard-deviation of departure time from origin, over all road trips (in number of seconds after midnight).
`road_trip_departure_time_min`	float	✕	✓	✕	Minimum departure time from origin, over all road trips (in number of seconds after midnight).
`road_trip_departure_time_max`	float	✕	✓	✕	Maximum departure time from origin, over all road trips (in number of seconds after midnight).
`road_trip_arrival_time_mean`	float	✕	✓	✕	Mean arrival time at destination, over all road trips (in number of seconds after midnight).
`road_trip_arrival_time_std`	float	✕	✓	✕	Standard-deviation of arrival time at destination, over all road trips (in number of seconds after midnight).
`road_trip_arrival_time_min`	float	✕	✓	✕	Minimum arrival time at destination, over all road trips (in number of seconds after midnight).
`road_trip_arrival_time_max`	float	✕	✓	✕	Maximum arrival time at destination, over all road trips (in number of seconds after midnight).
`road_trip_road_time_mean`	float	✕	✓	✕	Mean time spent on the road segments (i.e., travel time excluding bottleneck delays), over all road trips (in seconds).
`road_trip_road_time_std`	float	✕	✓	✕	Standard-deviation of time spent on the road segments (i.e., travel time excluding bottleneck delays), over all road trips (in seconds).
`road_trip_road_time_min`	float	✕	✓	✕	Minimum time spent on the road segments (i.e., travel time excluding bottleneck delays), over all road trips (in seconds).
`road_trip_road_time_max`	float	✕	✓	✕	Maximum time spent on the road segments (i.e., travel time excluding bottleneck delays), over all road trips (in seconds).
`road_trip_in_bottleneck_time_mean`	float	✕	✓	✕	Mean delay at entry bottlenecks, over all road trips (in seconds).
`road_trip_in_bottleneck_time_std`	float	✕	✓	✕	Standard-deviation of delay at entry bottlenecks, over all road trips (in seconds).
`road_trip_in_bottleneck_time_min`	float	✕	✓	✕	Minimum delay at entry bottlenecks, over all road trips (in seconds).
`road_trip_in_bottleneck_time_max`	float	✕	✓	✕	Maximum delay at entry bottlenecks, over all road trips (in seconds).
`road_trip_out_bottleneck_time_mean`	float	✕	✓	✕	Mean delay exit bottlenecks, over all road trips (in seconds).
`road_trip_out_bottleneck_time_std`	float	✕	✓	✕	Standard-deviation of delay exit bottlenecks, over all road trips (in seconds).
`road_trip_out_bottleneck_time_min`	float	✕	✓	✕	Minimum delay exit bottlenecks, over all road trips (in seconds).
`road_trip_out_bottleneck_time_max`	float	✕	✓	✕	Maximum delay exit bottlenecks, over all road trips (in seconds).
`road_trip_travel_time_mean`	float	✕	✓	✕	Mean trip travel time, over all road trips (in seconds).
`road_trip_travel_time_std`	float	✕	✓	✕	Standard-deviation of trip travel time, over all road trips (in seconds).
`road_trip_travel_time_min`	float	✕	✓	✕	Minimum trip travel time, over all road trips (in seconds).
`road_trip_travel_time_max`	float	✕	✓	✕	Maximum trip travel time, over all road trips (in seconds).
`road_trip_route_free_flow_travel_time_mean`	float	✕	✓	✕	Mean free-flow travel time of the selected route, over all road trips (in seconds).
`road_trip_route_free_flow_travel_time_std`	float	✕	✓	✕	Standard-deviation of free-flow travel time of the selected route, over all road trips (in seconds).
`road_trip_route_free_flow_travel_time_min`	float	✕	✓	✕	Minimum free-flow travel time of the selected route, over all road trips (in seconds).
`road_trip_route_free_flow_travel_time_max`	float	✕	✓	✕	Maximum free-flow travel time of the selected route, over all road trips (in seconds).
`road_trip_global_free_flow_travel_time_mean`	float	✕	✓	✕	Mean travel time of the fastest free-flow route, over all road trips (in seconds).
`road_trip_global_free_flow_travel_time_std`	float	✕	✓	✕	Standard-deviation of travel time of the fastest free-flow route, over all road trips (in seconds).
`road_trip_global_free_flow_travel_time_min`	float	✕	✓	✕	Minimum travel time of the fastest free-flow route, over all road trips (in seconds).
`road_trip_global_free_flow_travel_time_max`	float	✕	✓	✕	Maximum travel time of the fastest free-flow route, over all road trips (in seconds).
`road_trip_route_congestion_mean`	float	✕	✓	✕	Mean share of extra time spent in congestion for the selected route, over all road trips (in seconds).
`road_trip_route_congestion_std`	float	✕	✓	✕	Standard-deviation of share of extra time spent in congestion for the selected route, over all road trips (in seconds).
`road_trip_route_congestion_min`	float	✕	✓	✕	Minimum share of extra time spent in congestion for the selected route, over all road trips (in seconds).
`road_trip_route_congestion_max`	float	✕	✓	✕	Maximum share of extra time spent in congestion for the selected route, over all road trips (in seconds).
`road_trip_global_congestion_mean`	float	✕	✓	✕	Mean share of extra time spent in congestion compared to the fastest free-flow route, over all road trips (in seconds).
`road_trip_global_congestion_std`	float	✕	✓	✕	Standard-deviation of share of extra time spent in congestion compared to the fastest free-flow route, over all road trips (in seconds).
`road_trip_global_congestion_min`	float	✕	✓	✕	Minimum share of extra time spent in congestion compared to the fastest free-flow route, over all road trips (in seconds).
`road_trip_global_congestion_max`	float	✕	✓	✕	Maximum share of extra time spent in congestion compared to the fastest free-flow route, over all road trips (in seconds).
`road_trip_length_mean`	float	✕	✓	✕	Mean length of the selected route, over all road trips (in meters).
`road_trip_length_std`	float	✕	✓	✕	Standard-deviation of length of the selected route, over all road trips (in meters).
`road_trip_length_min`	float	✕	✓	✕	Minimum length of the selected route, over all road trips (in meters).
`road_trip_length_max`	float	✕	✓	✕	Maximum length of the selected route, over all road trips (in meters).
`road_trip_edge_count_mean`	float	✕	✓	✕	Mean number of edges of the selected route, over all trips.
`road_trip_edge_count_std`	float	✕	✓	✕	Standard-deviation of number of edges of the selected route, over all trips.
`road_trip_edge_count_min`	float	✕	✓	✕	Minimum number of edges of the selected route, over all trips.
`road_trip_edge_count_max`	float	✕	✓	✕	Maximum number of edges of the selected route, over all trips.
`road_trip_utility_mean`	float	✕	✓	✕	Mean simulated utility, over all road trips.
`road_trip_utility_std`	float	✕	✓	✕	Standard-deviation of simulated utility, over all road trips.
`road_trip_utility_min`	float	✕	✓	✕	Minimum simulated utility, over all road trips.
`road_trip_utility_max`	float	✕	✓	✕	Maximum simulated utility, over all road trips.
`road_trip_exp_travel_time_mean`	float	✕	✓	✕	Mean expected travel time when departing, over all road trips (in seconds).
`road_trip_exp_travel_time_std`	float	✕	✓	✕	Standard-deviation of expected travel time when departing, over all road trips (in seconds).
`road_trip_exp_travel_time_min`	float	✕	✓	✕	Minimum expected travel time when departing, over all road trips (in seconds).
`road_trip_exp_travel_time_max`	float	✕	✓	✕	Maximum expected travel time when departing, over all road trips (in seconds).
`road_trip_exp_travel_time_rel_diff_mean`	float	✕	✓	✕	Mean relative difference between the expected and simulated travel time, over all road trips.
`road_trip_exp_travel_time_rel_diff_std`	float	✕	✓	✕	Standard-deviation of relative difference between the expected and simulated travel time, over all road trips.
`road_trip_exp_travel_time_rel_diff_min`	float	✕	✓	✕	Minimum relative difference between the expected and simulated travel time, over all road trips.
`road_trip_exp_travel_time_rel_diff_max`	float	✕	✓	✕	Maximum relative difference between the expected and simulated travel time, over all road trips.
`road_trip_exp_travel_time_abs_diff_mean`	float	✕	✓	✕	Mean absolute difference between the expected and simulated travel time, over all trips (in seconds).
`road_trip_exp_travel_time_abs_diff_std`	float	✕	✓	✕	Standard-deviation of absolute difference between the expected and simulated travel time, over all trips (in seconds).
`road_trip_exp_travel_time_abs_diff_min`	float	✕	✓	✕	Minimum absolute difference between the expected and simulated travel time, over all trips (in seconds).
`road_trip_exp_travel_time_abs_diff_max`	float	✕	✓	✕	Maximum absolute difference between the expected and simulated travel time, over all trips (in seconds).
`road_trip_exp_travel_time_diff_rmse`	float	✕	✓	✕	RMSE of the absolute difference between the expected and simulated travel time, over all road trips (in seconds).
`road_trip_length_diff_mean`	float	✕	✓	✕	Mean length of the selected route that was not selected during the previous iteration, over all road trips.
`road_trip_length_diff_std`	float	✕	✓	✕	Standard-deviation of length of the selected route that was not selected during the previous iteration, over all road trips.
`road_trip_length_diff_min`	float	✕	✓	✕	Minimum length of the selected route that was not selected during the previous iteration, over all road trips.
`road_trip_length_diff_max`	float	✕	✓	✕	Maximum length of the selected route that was not selected during the previous iteration, over all road trips.
`virtual_trip_count`	float	✕	✓	✕	Total number of virtual trips in the selected alternatives.
`nb_agents_at_least_one_virtual_trip`	float	✕	✓	✕	Number of agents with at least one virtual trip in their selected alternative.
`nb_agents_all_virtual_trips`	float	✕	✓	✕	Number of agents with only virtual trips in their selected alternative.
`virtual_trip_count_by_agent_mean`	float	✕	✓	✕	Mean number of virtual trips, over all agents with at least one virtual trip.
`virtual_trip_count_by_agent_std`	float	✕	✓	✕	Standard-deviation of number of virtual trips, over all agents with at least one virtual trip.
`virtual_trip_count_by_agent_min`	float	✕	✓	✕	Minimum number of virtual trips, over all agents with at least one virtual trip.
`virtual_trip_count_by_agent_max`	float	✕	✓	✕	Maximum number of virtual trips, over all agents with at least one virtual trip.
`virtual_trip_departure_time_mean`	float	✕	✓	✕	Mean departure time from origin, over all virtual trips (in number of seconds after midnight).
`virtual_trip_departure_time_std`	float	✕	✓	✕	Standard-deviation of departure time from origin, over all virtual trips (in number of seconds after midnight).
`virtual_trip_departure_time_min`	float	✕	✓	✕	Minimum departure time from origin, over all virtual trips (in number of seconds after midnight).
`virtual_trip_departure_time_max`	float	✕	✓	✕	Maximum departure time from origin, over all virtual trips (in number of seconds after midnight).
`virtual_trip_arrival_time_mean`	float	✕	✓	✕	Mean arrival time at destination, over all virtual trips (in number of seconds after midnight).
`virtual_trip_arrival_time_std`	float	✕	✓	✕	Standard-deviation of arrival time at destination, over all virtual trips (in number of seconds after midnight).
`virtual_trip_arrival_time_min`	float	✕	✓	✕	Minimum arrival time at destination, over all virtual trips (in number of seconds after midnight).
`virtual_trip_arrival_time_max`	float	✕	✓	✕	Maximum arrival time at destination, over all virtual trips (in number of seconds after midnight).
`virtual_trip_travel_time_mean`	float	✕	✓	✕	Mean travel time, over all virtual trips (in seconds).
`virtual_trip_travel_time_std`	float	✕	✓	✕	Standard-deviation of travel time, over all virtual trips (in seconds).
`virtual_trip_travel_time_min`	float	✕	✓	✕	Minimum travel time, over all virtual trips (in seconds).
`virtual_trip_travel_time_max`	float	✕	✓	✕	Maximum travel time, over all virtual trips (in seconds).
`virtual_trip_global_free_flow_travel_time_mean`	float	✕	✓	✕	Mean of the smallest possible travel time, over all virtual trips (in seconds). Only relevant for time-dependent virtual trips. Only relevant for time-dependent virtual trips.
`virtual_trip_global_free_flow_travel_time_std`	float	✕	✓	✕	Standard-deviation of of the smallest possible travel time, over all virtual trips (in seconds). Only relevant for time-dependent virtual trips. Only relevant for time-dependent virtual trips.
`virtual_trip_global_free_flow_travel_time_min`	float	✕	✓	✕	Minimum of the smallest possible travel time, over all virtual trips (in seconds). Only relevant for time-dependent virtual trips. Only relevant for time-dependent virtual trips.
`virtual_trip_global_free_flow_travel_time_max`	float	✕	✓	✕	Maximum of the smallest possible travel time, over all virtual trips (in seconds). Only relevant for time-dependent virtual trips. Only relevant for time-dependent virtual trips.
`virtual_trip_global_congestion_mean`	float	✕	✓	✕	Mean share of extra time spent in congestion compared to the smallest possible travel time, over all road trips. Only relevant for time-dependent virtual trips.
`virtual_trip_global_congestion_std`	float	✕	✓	✕	Standard-deviation of share of extra time spent in congestion compared to the smallest possible travel time, over all road trips. Only relevant for time-dependent virtual trips.
`virtual_trip_global_congestion_min`	float	✕	✓	✕	Minimum share of extra time spent in congestion compared to the smallest possible travel time, over all road trips. Only relevant for time-dependent virtual trips.
`virtual_trip_global_congestion_max`	float	✕	✓	✕	Maximum share of extra time spent in congestion compared to the smallest possible travel time, over all road trips. Only relevant for time-dependent virtual trips.
`virtual_trip_utility_mean`	float	✕	✓	✕	Mean simulated utility, over all virtual trips.
`virtual_trip_utility_std`	float	✕	✓	✕	Standard-deviation of simulated utility, over all virtual trips.
`virtual_trip_utility_min`	float	✕	✓	✕	Minimum simulated utility, over all virtual trips.
`virtual_trip_utility_max`	float	✕	✓	✕	Maximum simulated utility, over all virtual trips.
`no_trip_alt_count`	unsigned integer	✕	✕	✕	Number of agents with no trip in their selected alternative.
`sim_road_network_cond_rmse`	float	✕	✓	✕	RMSE between the simulated edge-level travel-time function for the current iteration and the expected edge-level travel-time function for the previous iteration. The mean is taken over all edges and vehicle types.
`exp_road_network_cond_rmse`	float	✕	✓	✕	RMSE between the expected edge-level travel-time function for the current iteration and the expected edge-level travel-time function for the previous iteration. The mean is taken over all edges and vehicle types.

MetroExpectedTravelTimeFunctionsFile

Expected travel time functions of the road-network edges for the last iteration, represented as a list of breakpoints.

Path: run/output/net_cond_exp_edge_ttfs.parquet
Type: DataFrame
Steps: RunSimulationStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`vehicle_id`	string or integer	✕	✕	✕	Identifier of the vehicle type.
`edge_id`	string or integer	✕	✕	✕	Identifier of the edge.
`departure_time`	float	✕	✕	✕	Departure time of the breakpoint, in number of seconds after midnight.
`travel_time`	float	✕	✕	✕	Travel time of the breakpoint, in number of seconds.

MetroNextExpectedTravelTimeFunctionsFile

Expected travel time functions of the road-network edges for the next iteration, represented as a list of breakpoints.

Path: run/output/net_cond_next_exp_edge_ttfs.parquet
Type: DataFrame
Steps: RunSimulationStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`vehicle_id`	string or integer	✕	✕	✕	Identifier of the vehicle type.
`edge_id`	string or integer	✕	✕	✕	Identifier of the edge.
`departure_time`	float	✕	✕	✕	Departure time of the breakpoint, in number of seconds after midnight.
`travel_time`	float	✕	✕	✕	Travel time of the breakpoint, in number of seconds.

MetroSimulatedTravelTimeFunctionsFile

Simulated travel time functions of the road-network edges for the last iteration, represented as a list of breakpoints.

Path: run/output/net_cond_sim_edge_ttfs.parquet
Type: DataFrame
Steps: RunSimulationStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`vehicle_id`	string or integer	✕	✕	✕	Identifier of the vehicle type.
`edge_id`	string or integer	✕	✕	✕	Identifier of the edge.
`departure_time`	float	✕	✕	✕	Departure time of the breakpoint, in number of seconds after midnight.
`travel_time`	float	✕	✕	✕	Travel time of the breakpoint, in number of seconds.

MetroTripResultsFile

Trip-level results from the Metropolis-Core simulation.

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

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
Steps: WriteMetroParametersStep

SimulationAreaFile

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

Path: simulation_area.geo.parquet
Type: GeoDataFrame
Max rows: 1
Steps: SimulationAreaFromAAVStep, SimulationAreaFromBboxStep, SimulationAreaFromOSMStep, SimulationAreaFromPolygonsStep

Keyboard shortcuts

METROPOLIS2 The Book