MetroFiles

A MetroFile is a single file produced and/or consumed by the Pymetropolis pipeline — an intermediate result reused by another Step, or a final simulation output. Every MetroFile is stored under main_directory, at a fixed path relative to it, typically as a Parquet or GeoParquet file.

The tree below gives an overview of every MetroFile Pymetropolis can produce, organized by their path under main_directory (not every file is necessarily produced by a given configuration — only the ones whose Steps actually run). Click on a file name to jump to its full documentation, which lists:

a short description;
its Path, relative to main_directory;
its Type, i.e. the storage format (DataFrame/GeoDataFrame for a Parquet/GeoParquet file, Text, Plot, or ML Estimator);
the Steps that produce it (as an output) or consume it (as an input);
for DataFrame/GeoDataFrame files, the list of columns with their data type and constraints.

Some paths contain a {population} placeholder (e.g. demand/{population}/trips/trips.parquet): these files exist once for every simulated demand population, and the placeholder is replaced by the actual population’s name — population for the main population defined directly in the configuration file, or the population_name of an extra population. See the Multiple-demand page for more details.

main_directory

areas
calibration
- road
- survey
demand
- routing
- {population}
  - households
    
    homes.geo.parquet
    
    homes_urban_type.parquet
    
    households.parquet
    
    zones.parquet
  - metro_input
    
    agents.parquet
    
    alts.parquet
    
    trips.parquet
  - modes
    
    bicycle
    
    preferences.parquet
    
    travel_times.parquet
    
    car
    
    car_driver_preferences.parquet
    
    car_driver_with_passengers_preferences.parquet
    
    car_passenger_preferences.parquet
    
    car_ridesharing_preferences.parquet
    
    fuel_consumption.parquet
    
    outside_option
    
    preferences.parquet
    
    travel_times.parquet
    
    public_transit
    
    preferences.parquet
    
    walking
    
    preferences.parquet
    
    travel_times.parquet
  - persons
    
    persons.parquet
  - schedule
    
    activity_locations.geo.parquet
    
    linear_schedule_parameters.parquet
    
    tstars.parquet
  - tours
    
    joint_tours.parquet
    
    modes.parquet
    
    tours.parquet
  - trips
    
    bicycle
    
    costs.parquet
    
    origins_destinations.parquet
    
    pedestrian
    
    distances.parquet
    
    origins_destinations.parquet
    
    public_transit
    
    itineraries.parquet
    
    road
    
    free_flow_travel_times.parquet
    
    non_primary_car_trips.parquet
    
    origin_destination_matrix.parquet
    
    origins_destinations.parquet
    
    primary_car_trips_access_egress.parquet
    
    destinations.geo.parquet
    
    distances.parquet
    
    origin_destination_urban_type.parquet
    
    origins.geo.parquet
    
    trips.parquet
    
    zones.parquet
  - cars.parquet
  - uniform_draws.parquet
network
- bicycle_network
- pedestrian_network
  - edges_clean.geo.parquet
  - edges_raw.geo.parquet
- road_network
results
- graphs
  - convergence
    
    expected_road_travel_times.png
    
    mean_surplus.png
    
    route_length_diff.png
    
    simulated_road_travel_times.png
    
    tour_departure_time.png
  - road_network
    
    congestion_function_expected.png
    
    congestion_function_simulated.png
  - {population}
    
    trips
    
    departure_time_distribution.png
    
    mode_shares.png
- {population}
- iteration_results.parquet
run

SimulationAreaFile

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

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

UrbanAreasFile

Single-feature file with a Polygon or MultiPolygon geometry representing the areas classified as urban.

Path: areas/urban_areas.geo.parquet
Type: GeoDataFrame
Max rows: 1
Steps: OpenStreetMapUrbanAreasStep

ZonesLevel1File

Level-1 zones in the simulated area.

Path: areas/zones/zones1.geo.parquet
Type: GeoDataFrame
Steps: CustomZonesLevel1Step, FrenchZonesStep

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.
`within_area`	boolean	✓	✓	✕	Whether the zone is in the simulation area.

ZonesLevel2File

Level-2 zones in the simulated area.

Path: areas/zones/zones2.geo.parquet
Type: GeoDataFrame
Steps: CustomZonesLevel2Step, FrenchZonesStep

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.
`within_area`	boolean	✓	✓	✕	Whether the zone is in the simulation area.

ZonesLevel3File

Level-3 zones in the simulated area.

Path: areas/zones/zones3.geo.parquet
Type: GeoDataFrame
Steps: CustomZonesLevel3Step, FrenchZonesStep

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.
`within_area`	boolean	✓	✓	✕	Whether the zone is in the simulation area.

ZonesLevel4File

Level-4 zones in the simulated area.

Path: areas/zones/zones4.geo.parquet
Type: GeoDataFrame
Steps: CustomZonesLevel4Step, FrenchZonesStep

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.
`within_area`	boolean	✓	✓	✕	Whether the zone is in the simulation area.

ZonesLevel5File

Level-5 zones in the simulated area.

Path: areas/zones/zones5.geo.parquet
Type: GeoDataFrame
Steps: CustomZonesLevel5Step

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.
`within_area`	boolean	✓	✓	✕	Whether the zone is in the simulation area.

RoadEdgesVariablesFile

Edge-level variables available for calibration. Defined columns depend on the configuration.

Path: calibration/road/edges_variables.parquet
Type: DataFrame
Steps: RoadEdgesVariablesStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`edge_id`	string or integer	✕	✕	✓	Identifier of the edge.
`base_free_flow_tt`	float	✕	✓	✕	Free-flow travel time on the edge, based on speed limit, in seconds.

AllRoadFreeFlowTravelTimesFile

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

Path: calibration/road/free_flow/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.

RoadEdgesFreeFlowTravelTimeFile

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

Path: calibration/road/free_flow/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.

RoadEdgesPenaltiesFile

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

Path: calibration/road/free_flow/edges_penalties.parquet
Type: DataFrame
Steps: EdgePenaltiesFromCoefficientsStep, 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.
`speed_multiplier`	float	✕	✓	✕	By how much edge speed limit is multiplied to get edge free-flow speed.

RoadEdgesPenaltyCoefficientsFile

Coefficients for free-flow time penalties of road-network edges.

Path: calibration/road/free_flow/penalty_coefficients.parquet
Type: DataFrame
Steps: FreeFlowLassoStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`type`	string	✕	✕	✕	Penalty type: `"additive"` or `"multiplicative"`.
`variable1`	string	✕	✕	✕	Name of the variable to which the coefficient applies.
`variable2`	string	✕	✓	✕	Name of the second variable to which the coefficient applies, for interactions only.
`penalty`	float	✕	✕	✕	Value of the penalty.

FreeFlowTravelTimeComparisonPlotFile

Scatter plot comparing TomTom-observed and Metropolis-simulated free-flow travel times at the OD level.

Path: calibration/road/free_flow/travel_time_comparison.png
Type: Plot
Steps: FreeFlowTravelTimeComparisonStep

TomTomRoutesFile

Results of the routing requests from TomTom API.

Path: calibration/road/tomtom_routes.geo.parquet
Type: GeoDataFrame
Steps: TomTomRequestsStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`tomtom_id`	string or integer	✕	✕	✓	Identifier of the request.
`source`	string or integer	✕	✕	✕	Identifier of the request first node.
`target`	string or integer	✕	✕	✕	Identifier of the request last node.
`length`	float	✕	✕	✕	Length of the returned path, in meters.
`departure_time`	datetime	✕	✕	✕	Departure time of the request.
`tt_no_traffic`	duration	✕	✕	✕	Travel time on the returned path, under free-flow conditions.
`tt_traffic`	duration	✕	✕	✕	Travel time on the returned path, under congested conditions.

TomTomRoutesMatchedFile

Results of the routing requests from TomTom API after map matching.

Path: calibration/road/tomtom_routes_matched.parquet
Type: DataFrame
Steps: MapMatchingStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`tomtom_id`	string or integer	✕	✕	✓	Identifier of the request.
`length`	float	✕	✕	✕	Length of the matched path, in meters.
`length_tomtom`	float	✕	✕	✕	Length of the TomTom path, in meters.
`rel_length_diff`	float	✕	✕	✕	Relative difference between matched and TomTom length.
`path`	list of strings or integers	✕	✕	✕	Sequence of road network ids that compose the path.

SurveyedCarsFile

Cars in the survey file. Variables are documented in the MobiSurvStd documentation for cars.

Path: calibration/survey/cars.parquet
Type: DataFrame
Steps: MobiSurvStdImportStep

SurveyedDetailedZonesFile

Detailed zones in the survey file. Variables are documented in the MobiSurvStd documentation for zones.

Path: calibration/survey/detailed_zones.geo.parquet
Type: GeoDataFrame
Steps: MobiSurvStdImportStep

SurveyedDrawZonesFile

Draw zones in the survey file. Variables are documented in the MobiSurvStd documentation for zones.

Path: calibration/survey/draw_zones.geo.parquet
Type: GeoDataFrame
Steps: MobiSurvStdImportStep

SurveyedHouseholdsFile

Households in the survey file. Variables are documented in the MobiSurvStd documentation for households.

Path: calibration/survey/households.parquet
Type: DataFrame
Steps: MobiSurvStdImportStep

JointTourEstimatorFile

ML estimator for the classification of joint tours.

Path: calibration/survey/joint_tour_estimator.joblib
Type: ML Estimator (joblib)
Steps: EstimateJointToursClassifierStep, ExternalJointToursClassifierStep

SurveyedLegsFile

Legs in the survey file. Variables are documented in the MobiSurvStd documentation for legs.

Path: calibration/survey/legs.parquet
Type: DataFrame
Steps: MobiSurvStdImportStep

ModeEstimatorFile

ML estimator for the classification of tours’ mode.

Path: calibration/survey/mode_estimator.joblib
Type: ML Estimator (joblib)
Steps: EstimateModeClassifierStep, ExternalModeClassifierStep

SurveyedMotorcyclesFile

Motorcycles in the survey file. Variables are documented in the MobiSurvStd documentation for motorcycles.

Path: calibration/survey/motorcycles.parquet
Type: DataFrame
Steps: MobiSurvStdImportStep

SurveyedPersonsFile

Persons in the survey file. Variables are documented in the MobiSurvStd documentation for persons.

Path: calibration/survey/persons.parquet
Type: DataFrame
Steps: MobiSurvStdImportStep

SurveyedSpecialLocationsFile

Special locations in the survey file. Variables are documented in the MobiSurvStd documentation for zones.

Path: calibration/survey/special_locations.geo.parquet
Type: GeoDataFrame
Steps: MobiSurvStdImportStep

SurveyedToursFile

Home-based tours in the survey file.

Path: calibration/survey/tours.parquet
Type: DataFrame
Steps: CleanSurveyToursStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`tour_id`	string or integer	✕	✕	✕	Identifier of the tour.
`survey_name`	string	✕	✓	✕	Name of the survey the tour comes from.
`household_id`	string or integer	✕	✕	✕	Identifier of the household of the person who did the tour.
`person_id`	string or integer	✕	✕	✕	Identifier of the person who did the tour.
`nb_trips`	unsigned integer	✕	✕	✕	Number of trips in the tour.
`nb_activities`	unsigned integer	✕	✕	✕	Number of activities in the tour.
`modes`	list of strings	✓	✓	✕	Main mode taken for each trip of the tour.
`first_purpose`	string	✓	✓	✕	Purpose of the first activity in the tour.
`last_purpose`	string	✓	✓	✕	Purpose of the last activity in the tour.
`purposes`	list of strings	✓	✓	✕	Purpose of each activity in the tour.
`durations`	list of times	✓	✓	✕	Duration of each activity in the tour.
`first_departure_time`	duration	✓	✓	✕	Departure time from the first origin of the tour.
`last_arrival_time`	duration	✓	✓	✕	Arrival time at the last destination of the tour.
`first_activity_start`	duration	✓	✓	✕	Start time of the first activity of the tour.
`last_activity_end`	duration	✓	✓	✕	End time of the last activity of the tour.
`travel_times`	list of times	✓	✓	✕	Duration of each trip of the tour.
`distances`	list of floats	✓	✓	✕	Euclidean distance of each trip of the tour, in meters.
`trip_weekday`	string	✓	✓	✕	Weekday during which the tour took place.
`outside_perimeter`	boolean	✓	✓	✕	Whether the tour has trips outside the survey perimeter.
`total_tour_duration`	duration	✓	✓	✕	Duration of the tour, from departure from first origin to arrival at last destination.
`total_activity_duration`	duration	✓	✓	✕	Total duration of all activities in the tour.
`total_travel_time`	duration	✓	✓	✕	Total travel time of all trips in the tour.
`total_distance`	float	✓	✓	✕	Total Euclidean distance of all trips in the tour, in meters.
`has_home_purpose`	boolean	✓	✓	✕	Whether the tour has at least one activity with ‘home’ purpose.
`has_work_purpose`	boolean	✓	✓	✕	Whether the tour has at least one activity with ‘work’ purpose.
`has_education_purpose`	boolean	✓	✓	✕	Whether the tour has at least one activity with ‘education’ purpose.
`has_shopping_purpose`	boolean	✓	✓	✕	Whether the tour has at least one activity with ‘shopping’ purpose.
`has_task_purpose`	boolean	✓	✓	✕	Whether the tour has at least one activity with ‘task’ purpose.
`has_leisure_purpose`	boolean	✓	✓	✕	Whether the tour has at least one activity with ‘leisure’ purpose.
`has_escort_purpose`	boolean	✓	✓	✕	Whether the tour has at least one activity with ‘escort’ purpose.
`has_other_purpose`	boolean	✓	✓	✕	Whether the tour has at least one activity with ‘other’ purpose.
`tour_mode`	string	✓	✓	✕	Main mode used for the tour.
`other_person_ids`	list of strings or integers	✓	✓	✕	List of ids of household members who did the same tour.
`other_modes`	list of strings	✓	✓	✕	Main tour mode of the household members who did the same tour.
`joint_tour`	boolean	✓	✓	✕	Whether the tour was made jointly with other household members.
`lowest_density`	enum	✓	✓	✕	Lowest urban density category over activity locations.
`highest_density`	enum	✓	✓	✕	Highest urban density category over activity locations.
`lowest_urban_type`	enum	✓	✓	✕	Lowest urban type over activity locations.
`highest_urban_type`	enum	✓	✓	✕	Highest urban type over activity locations.
`lowest_functional_area_type`	enum	✓	✓	✕	Lowest functional area type over activity locations.
`highest_functional_area_type`	enum	✓	✓	✕	Highest functional area type over activity locations.
`lowest_functional_area_category`	enum	✓	✓	✕	Lowest functional area category over activity locations.
`highest_functional_area_category`	enum	✓	✓	✕	Highest functional area category over activity locations.
`home_density`	enum	✓	✓	✕	Urban density category of the household municipality.
`home_urban_type`	enum	✓	✓	✕	Urban type of the household municipality.
`home_functional_area_type`	enum	✓	✓	✕	Type of the municipality within its functional area.
`home_functional_area_category`	enum	✓	✓	✕	Category of the functional area of the home municipality.
`nb_cars`	unsigned integer	✓	✓	✕	Number of cars owned by the household.
`nb_motorcycles`	unsigned integer	✓	✓	✕	Number of motorcycles owned by the household.
`nb_bicycles`	unsigned integer	✓	✓	✕	Number of bicycles owned by the household.
`nb_persons`	unsigned integer	✓	✓	✕	Number of persons living in the household.
`nb_majors`	unsigned integer	✓	✓	✕	Number of persons 18 or older living in the household.
`nb_minors`	unsigned integer	✓	✓	✕	Number of persons 17 or younger living in the household.
`nb_surveyed`	unsigned integer	✓	✓	✕	Number of persons surveyed for trips in the household.
`nb_women`	unsigned integer	✓	✓	✕	Number of women living in the household.
`nb_major_women`	unsigned integer	✓	✓	✕	Number of women 18 or older living in the household.
`nb_men`	unsigned integer	✓	✓	✕	Number of men living in the household.
`nb_major_men`	unsigned integer	✓	✓	✕	Number of men 18 or older living in the household.
`nb_driving_licenses`	unsigned integer	✓	✓	✕	Number of driving-license holders living in the household.
`household_type`	string	✓	✓	✕	Type of household structure (single, couple, singleparent, etc.).
`minor_ratio`	float	✓	✓	✕	Share of household members 17 or younger.
`car_ratio`	float	✓	✓	✕	Number of cars per person in the household.
`driving_license_ratio`	float	✓	✓	✕	Number of cars per driving-license holder.
`household_fully_surveyed`	boolean	✓	✓	✕	Whether all persons in the household were surveyed for trips.
`household_surveyed_on_same_day`	boolean	✓	✓	✕	Whether all persons surveyed for trips in the household were surveyed for trips during the same day.
`woman`	boolean	✓	✓	✕	Whether the person is a woman.
`age`	unsigned integer	✓	✓	✕	Age of the person.
`oldest_age_diff`	unsigned integer	✓	✓	✕	Age difference to the oldest person in the household.
`education_level`	string	✓	✓	✕	Education level of the person.
`professional_activity`	string	✓	✓	✕	Professional activity of the person (e.g., worker, student, retiree).
`socioprofessional_class`	unsigned integer	✓	✓	✕	Socioprofessional class (job type) of the person.
`has_driving_license`	boolean	✓	✓	✕	Whether the person has a driving license.
`has_public_transit_subscription`	boolean	✓	✓	✕	Whether the person has a public-transit subscription.
`nb_tours`	unsigned integer	✓	✓	✕	Number of tours that the person did during the surveyed day.
`weight`	float	✕	✓	✕	Statistical survey weight of the person / tour.
`weighted_distance`	float	✕	✓	✕	Statistical survey weight of the person / tour, multiplied by the total Euclidean distance of trips in the tour.

SurveyedTripsFile

Trips in the survey file. Variables are documented in the MobiSurvStd documentation for trips.

Path: calibration/survey/trips.parquet
Type: DataFrame
Steps: MobiSurvStdImportStep

ZoneODLevel1CongestedTravelTimesFile

Congested travel time by car between each pair of Level-1 zones, aggregatedover a given time window.

Path: demand/routing/zone1_od_congested_travel_times.parquet
Type: DataFrame
Steps: ZonesODCongestedTravelTimesStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`origin_zone_id`	string or integer	✕	✕	✕	Identifier of the origin zone.
`destination_zone_id`	string or integer	✕	✕	✕	Identifier of the destination zone.
`congested_travel_time`	duration	✕	✕	✕	Travel time by car between the two zones’ road nodes, under congested conditions, aggregated (median) over the configured time window.
`congested_travel_time_min`	duration	✕	✕	✕	Minimum travel time over the congested breakpoints falling within the time window.
`congested_travel_time_max`	duration	✕	✕	✕	Maximum travel time over the congested breakpoints falling within the time window.
`congested_travel_time_std`	duration	✕	✕	✕	Standard deviation of the travel time over the congested breakpoints falling within the time window. Zero when only one breakpoint falls in the window.

ZoneODLevel1FreeFlowTravelTimesFile

Travel time by car under free-flow conditions between each pair of Level-1 zones.

Path: demand/routing/zone1_od_free_flow_travel_times.parquet
Type: DataFrame
Steps: ZonesODFreeFlowTravelTimesStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`origin_zone_id`	string or integer	✕	✕	✕	Identifier of the origin zone.
`destination_zone_id`	string or integer	✕	✕	✕	Identifier of the destination zone.
`free_flow_travel_time`	duration	✕	✕	✕	Travel time by car between the two zones’ road nodes, under free-flow conditions.

ZonesLevel1RoadNodeFile

Road network node representative of Level-1 zones.

Path: demand/routing/zone1_road_node.parquet
Type: DataFrame
Steps: ZonesLevel1RoadNodesStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`zone_id`	string or integer	✕	✕	✓	Identifier of the zone
`road_node`	string or integer	✕	✓	✕	Identifier of the road node representative of the zone.

ZoneODLevel2CongestedTravelTimesFile

Congested travel time by car between each pair of Level-2 zones, aggregatedover a given time window.

Path: demand/routing/zone2_od_congested_travel_times.parquet
Type: DataFrame
Steps: ZonesODCongestedTravelTimesStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`origin_zone_id`	string or integer	✕	✕	✕	Identifier of the origin zone.
`destination_zone_id`	string or integer	✕	✕	✕	Identifier of the destination zone.
`congested_travel_time`	duration	✕	✕	✕	Travel time by car between the two zones’ road nodes, under congested conditions, aggregated (median) over the configured time window.
`congested_travel_time_min`	duration	✕	✕	✕	Minimum travel time over the congested breakpoints falling within the time window.
`congested_travel_time_max`	duration	✕	✕	✕	Maximum travel time over the congested breakpoints falling within the time window.
`congested_travel_time_std`	duration	✕	✕	✕	Standard deviation of the travel time over the congested breakpoints falling within the time window. Zero when only one breakpoint falls in the window.

ZoneODLevel2FreeFlowTravelTimesFile

Travel time by car under free-flow conditions between each pair of Level-2 zones.

Path: demand/routing/zone2_od_free_flow_travel_times.parquet
Type: DataFrame
Steps: ZonesODFreeFlowTravelTimesStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`origin_zone_id`	string or integer	✕	✕	✕	Identifier of the origin zone.
`destination_zone_id`	string or integer	✕	✕	✕	Identifier of the destination zone.
`free_flow_travel_time`	duration	✕	✕	✕	Travel time by car between the two zones’ road nodes, under free-flow conditions.

ZonesLevel2RoadNodeFile

Road network node representative of Level-2 zones.

Path: demand/routing/zone2_road_node.parquet
Type: DataFrame
Steps: ZonesLevel2RoadNodesStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`zone_id`	string or integer	✕	✕	✓	Identifier of the zone
`road_node`	string or integer	✕	✓	✕	Identifier of the road node representative of the zone.

ZoneODLevel3CongestedTravelTimesFile

Congested travel time by car between each pair of Level-3 zones, aggregatedover a given time window.

Path: demand/routing/zone3_od_congested_travel_times.parquet
Type: DataFrame
Steps: ZonesODCongestedTravelTimesStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`origin_zone_id`	string or integer	✕	✕	✕	Identifier of the origin zone.
`destination_zone_id`	string or integer	✕	✕	✕	Identifier of the destination zone.
`congested_travel_time`	duration	✕	✕	✕	Travel time by car between the two zones’ road nodes, under congested conditions, aggregated (median) over the configured time window.
`congested_travel_time_min`	duration	✕	✕	✕	Minimum travel time over the congested breakpoints falling within the time window.
`congested_travel_time_max`	duration	✕	✕	✕	Maximum travel time over the congested breakpoints falling within the time window.
`congested_travel_time_std`	duration	✕	✕	✕	Standard deviation of the travel time over the congested breakpoints falling within the time window. Zero when only one breakpoint falls in the window.

ZoneODLevel3FreeFlowTravelTimesFile

Travel time by car under free-flow conditions between each pair of Level-3 zones.

Path: demand/routing/zone3_od_free_flow_travel_times.parquet
Type: DataFrame
Steps: ZonesODFreeFlowTravelTimesStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`origin_zone_id`	string or integer	✕	✕	✕	Identifier of the origin zone.
`destination_zone_id`	string or integer	✕	✕	✕	Identifier of the destination zone.
`free_flow_travel_time`	duration	✕	✕	✕	Travel time by car between the two zones’ road nodes, under free-flow conditions.

ZonesLevel3RoadNodeFile

Road network node representative of Level-3 zones.

Path: demand/routing/zone3_road_node.parquet
Type: DataFrame
Steps: ZonesLevel3RoadNodesStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`zone_id`	string or integer	✕	✕	✓	Identifier of the zone
`road_node`	string or integer	✕	✓	✕	Identifier of the road node representative of the zone.

ZoneODLevel4CongestedTravelTimesFile

Congested travel time by car between each pair of Level-4 zones, aggregatedover a given time window.

Path: demand/routing/zone4_od_congested_travel_times.parquet
Type: DataFrame
Steps: ZonesODCongestedTravelTimesStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`origin_zone_id`	string or integer	✕	✕	✕	Identifier of the origin zone.
`destination_zone_id`	string or integer	✕	✕	✕	Identifier of the destination zone.
`congested_travel_time`	duration	✕	✕	✕	Travel time by car between the two zones’ road nodes, under congested conditions, aggregated (median) over the configured time window.
`congested_travel_time_min`	duration	✕	✕	✕	Minimum travel time over the congested breakpoints falling within the time window.
`congested_travel_time_max`	duration	✕	✕	✕	Maximum travel time over the congested breakpoints falling within the time window.
`congested_travel_time_std`	duration	✕	✕	✕	Standard deviation of the travel time over the congested breakpoints falling within the time window. Zero when only one breakpoint falls in the window.

ZoneODLevel4FreeFlowTravelTimesFile

Travel time by car under free-flow conditions between each pair of Level-4 zones.

Path: demand/routing/zone4_od_free_flow_travel_times.parquet
Type: DataFrame
Steps: ZonesODFreeFlowTravelTimesStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`origin_zone_id`	string or integer	✕	✕	✕	Identifier of the origin zone.
`destination_zone_id`	string or integer	✕	✕	✕	Identifier of the destination zone.
`free_flow_travel_time`	duration	✕	✕	✕	Travel time by car between the two zones’ road nodes, under free-flow conditions.

ZonesLevel4RoadNodeFile

Road network node representative of Level-4 zones.

Path: demand/routing/zone4_road_node.parquet
Type: DataFrame
Steps: ZonesLevel4RoadNodesStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`zone_id`	string or integer	✕	✕	✓	Identifier of the zone
`road_node`	string or integer	✕	✓	✕	Identifier of the road node representative of the zone.

ZoneODLevel5CongestedTravelTimesFile

Congested travel time by car between each pair of Level-5 zones, aggregatedover a given time window.

Path: demand/routing/zone5_od_congested_travel_times.parquet
Type: DataFrame
Steps: ZonesODCongestedTravelTimesStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`origin_zone_id`	string or integer	✕	✕	✕	Identifier of the origin zone.
`destination_zone_id`	string or integer	✕	✕	✕	Identifier of the destination zone.
`congested_travel_time`	duration	✕	✕	✕	Travel time by car between the two zones’ road nodes, under congested conditions, aggregated (median) over the configured time window.
`congested_travel_time_min`	duration	✕	✕	✕	Minimum travel time over the congested breakpoints falling within the time window.
`congested_travel_time_max`	duration	✕	✕	✕	Maximum travel time over the congested breakpoints falling within the time window.
`congested_travel_time_std`	duration	✕	✕	✕	Standard deviation of the travel time over the congested breakpoints falling within the time window. Zero when only one breakpoint falls in the window.

ZoneODLevel5FreeFlowTravelTimesFile

Travel time by car under free-flow conditions between each pair of Level-5 zones.

Path: demand/routing/zone5_od_free_flow_travel_times.parquet
Type: DataFrame
Steps: ZonesODFreeFlowTravelTimesStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`origin_zone_id`	string or integer	✕	✕	✕	Identifier of the origin zone.
`destination_zone_id`	string or integer	✕	✕	✕	Identifier of the destination zone.
`free_flow_travel_time`	duration	✕	✕	✕	Travel time by car between the two zones’ road nodes, under free-flow conditions.

ZonesLevel5RoadNodeFile

Road network node representative of Level-5 zones.

Path: demand/routing/zone5_road_node.parquet
Type: DataFrame
Steps: ZonesLevel5RoadNodesStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`zone_id`	string or integer	✕	✕	✓	Identifier of the zone
`road_node`	string or integer	✕	✓	✕	Identifier of the road node representative of the zone.

CarsFile

Characteristics of the cars owned by households / persons.

Path: demand/{population}/cars.parquet
Type: DataFrame

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`car_id`	string or integer	✕	✕	✓	Identifier of the car.
`household_id`	string or integer	✓	✓	✕	Identifier of the household owning the car.
`person_id`	string or integer	✓	✓	✕	Identifier of the person owning the car.
`critair`	string	✓	✓	✕	Crit’Air vignette of the car.
`fuel_type`	string	✓	✓	✕	Fuel type that the car is using.
`age`	unsigned integer	✓	✓	✕	Age of the car.
`euro_standard`	unsigned integer	✓	✓	✕	Category of the car in the European emission standards.

HouseholdsHomesFile

Coordinates of the household homes.

Path: demand/{population}/households/homes.geo.parquet
Type: GeoDataFrame
Steps: EqasimImportStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`household_id`	string or integer	✕	✕	✓	Identifier of the household.

HouseholdsHomesUrbanTypeFile

Urban type attributes of households’ home.

Path: demand/{population}/households/homes_urban_type.parquet
Type: DataFrame
Steps: FrenchHouseholdsUrbanTypeStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`household_id`	string or integer	✕	✕	✓	Identifier of the household.
`home_density`	enum	✓	✓	✕	Urban density category of the household municipality.
`home_urban_type`	enum	✓	✓	✕	Urban type of the household municipality.
`home_functional_area_type`	enum	✓	✓	✕	Type of the municipality within its functional area.
`home_functional_area_category`	enum	✓	✓	✕	Category of the functional area of the home municipality.

HouseholdsFile

Identifiers and characteristics of the simulated households. The geometry is a Point representing the household’s home.

Path: demand/{population}/households/households.parquet
Type: DataFrame
Steps: EqasimImportStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`household_id`	string or integer	✕	✕	✓	Identifier of the household.
`household_type`	string	✓	✓	✕	Type of household family structure.
`income`	float	✓	✓	✕	Monthly income of the household.
`nb_cars`	unsigned integer	✓	✓	✕	Number of cars owned by the household.
`nb_motorcycles`	unsigned integer	✓	✓	✕	Number of motorcycles owned by the household.
`nb_bicycles`	unsigned integer	✓	✓	✕	Number of bicycles owned by the household.
`nb_persons`	unsigned integer	✓	✕	✕	Number of persons in the household.
`nb_persons_5plus`	unsigned integer	✓	✓	✕	Number of persons in the household whose age is 5 or plus.
`nb_majors`	unsigned integer	✓	✓	✕	Number of persons in the household whose age is 18 or more.
`nb_minors`	unsigned integer	✓	✓	✕	Number of persons in the household whose age is 17 or less.
`nb_driving_licenses`	unsigned integer	✓	✓	✕	Number of persons in the household with a driving license.

HouseholdsZonesFile

Zones of the households’ home.

Path: demand/{population}/households/zones.parquet
Type: DataFrame
Steps: HouseholdsHomesZonesStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`household_id`	string or integer	✕	✕	✓	Identifier of the household.
`home_zone1`	string or integer	✓	✓	✕	Identifier of the home location in the level 1 zone system.
`home_zone2`	string or integer	✓	✓	✕	Identifier of the home location in the level 2 zone system.
`home_zone3`	string or integer	✓	✓	✕	Identifier of the home location in the level 3 zone system.
`home_zone4`	string or integer	✓	✓	✕	Identifier of the home location in the level 4 zone system.
`home_zone5`	string or integer	✓	✓	✕	Identifier of the home location in the level 5 zone system.

MetroAgentsPopulationFile

Simulated agents in the population, ready for import to Metropolis-Core.

Path: demand/{population}/metro_input/agents.parquet
Type: DataFrame
Steps: PrepareMetroAgentsStep

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.

MetroAlternativesPopulationFile

Simulated alternatives in the population, ready for import to Metropolis-Core.

Path: demand/{population}/metro_input/alts.parquet
Type: DataFrame
Steps: PrepareMetroAlternativesStep

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.

MetroTripsPopulationFile

Simulated trips in the population, ready for import to Metropolis-Core.

Path: demand/{population}/metro_input/trips.parquet
Type: DataFrame
Steps: PrepareMetroTripsStep

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.

BicyclePreferencesFile

Preferences to travel by bicycle, for each person.

Path: demand/{population}/modes/bicycle/preferences.parquet
Type: DataFrame
Steps: BicyclePreferencesFromPopulationStep, BicyclePreferencesStep

Show columns

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

BicycleTravelTimesFile

Travel time of each trip, when traveling by bicycle.

Path: demand/{population}/modes/bicycle/travel_times.parquet
Type: DataFrame
Steps: BicycleTravelTimesFromDistanceStep

Show columns

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

CarDriverPreferencesFile

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

Path: demand/{population}/modes/car/car_driver_preferences.parquet
Type: DataFrame
Steps: CarDriverPreferencesFromPopulationStep, 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).

CarDriverWithPassengersPreferencesFile

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

Path: demand/{population}/modes/car/car_driver_with_passengers_preferences.parquet
Type: DataFrame
Steps: CarDriverWithPassengersPreferencesFromPopulationStep, 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).

CarPassengerPreferencesFile

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

Path: demand/{population}/modes/car/car_passenger_preferences.parquet
Type: DataFrame
Steps: CarPassengerPreferencesFromPopulationStep, 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}/modes/car/car_ridesharing_preferences.parquet
Type: DataFrame
Steps: CarRidesharingPreferencesFromPopulationStep, 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).

CarFuelFile

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

Path: demand/{population}/modes/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 €.

OutsideOptionPreferencesFile

Utility of the outside option alternative, for each tour.

Path: demand/{population}/modes/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}/modes/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.

PublicTransitPreferencesFile

Preferences to travel by public transit, for each person.

Path: demand/{population}/modes/public_transit/preferences.parquet
Type: DataFrame
Steps: PublicTransitPreferencesFromPopulationStep, 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).

WalkingPreferencesFile

Preferences to travel by walk, for each person.

Path: demand/{population}/modes/walking/preferences.parquet
Type: DataFrame
Steps: WalkingPreferencesFromPopulationStep, WalkingPreferencesStep

Show columns

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

WalkingTravelTimesFile

Travel time of each trip, when traveling by walking.

Path: demand/{population}/modes/walking/travel_times.parquet
Type: DataFrame
Steps: WalkingTravelTimesFromDistanceStep

Show columns

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

PersonsFile

Identifiers and characteristics of the simulated persons.

Path: demand/{population}/persons/persons.parquet
Type: DataFrame
Steps: EqasimImportStep, PopulationFromTripCoordinatesStep

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.
`person_index`	unsigned integer	✕	✕	✕	Index of the person within the household’s persons.
`reference_person_link`	string	✓	✕	✕	Link of the person relative to the reference person of the household.
`woman`	boolean	✓	✓	✕	Whether the person is a woman.
`age`	unsigned integer	✓	✓	✕	Age of the person.
`detailed_education_level`	string	✓	✓	✕	Highest education level reached by the person, in detailed categories.
`education_level`	string	✓	✓	✕	Highest education level reached by the person.
`professional_activity`	string	✓	✓	✕	Professional status of the person.
`socioprofessional_class`	unsigned integer	✓	✓	✕	Socioprofessional class of the person.
`has_driving_license`	boolean	✓	✓	✕	Whether the person has a driving license.
`has_public_transit_subscription`	boolean	✓	✓	✕	Whether the person has a public-transit subscription.
`nb_trips`	unsigned integer	✓	✕	✕	Number of trips.

ActivitiesLocationsFile

Coordinates of each activity.

Path: demand/{population}/schedule/activity_locations.geo.parquet
Type: GeoDataFrame
Steps: ActivitiesLocationsFromTripsLocationsStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`person_id`	string or integer	✕	✕	✕	Identifier of the person.
`purpose`	string	✕	✓	✕	Purpose of the activity.
`preceding_trip_id`	string or integer	✕	✓	✕	Identifier of the trip before the activity.
`following_trip_id`	string or integer	✕	✓	✕	Identifier of the trip after the activity.

LinearScheduleFile

Schedule preferences for each trip, for the linear model.

Path: demand/{population}/schedule/linear_schedule_parameters.parquet
Type: DataFrame
Steps: LinearScheduleFromPurposeStep, 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.

TstarsFile

Desired start time for the activity following each trip.

Path: demand/{population}/schedule/tstars.parquet
Type: DataFrame
Steps: HomogeneousTstarStep, TstarFromArrivalTimeStep

Show columns

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

JointToursFile

Tour-level flag for joint trips.

Path: demand/{population}/tours/joint_tours.parquet
Type: DataFrame
Steps: ClassifyJointToursStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`tour_id`	string or integer	✕	✕	✕	Identifier of the tour.
`joint_tour`	boolean	✕	✕	✕	Whether the tour is done jointly with another household member.

ToursModeFile

Ex-ante mode for each tour.

Path: demand/{population}/tours/modes.parquet
Type: DataFrame
Steps: ClassifyToursModeStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`tour_id`	string or integer	✕	✕	✕	Identifier of the tour.
`mode`	string	✕	✕	✕	Predicted mode ex-ante.

ToursFile

Variables at the tour-level.

Path: demand/{population}/tours/tours.parquet
Type: DataFrame
Steps: CreateToursStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`tour_id`	string or integer	✕	✕	✕	Identifier of the tour.
`nb_trips`	unsigned integer	✕	✕	✕	Number of trips in the tour.
`nb_activities`	unsigned integer	✕	✕	✕	Number of activities in the tour.
`first_purpose`	string	✓	✓	✕	Purpose of the first activity in the tour.
`last_purpose`	string	✓	✓	✕	Purpose of the last activity in the tour.
`purposes`	list of strings	✓	✓	✕	Purpose of each activity in the tour.
`durations`	list of times	✓	✓	✕	Duration of each activity in the tour.
`first_departure_time`	duration	✓	✓	✕	Departure time from the first origin of the tour.
`last_arrival_time`	duration	✓	✓	✕	Arrival time at the last destination of the tour.
`first_activity_start`	duration	✓	✓	✕	Start time of the first activity of the tour.
`last_activity_end`	duration	✓	✓	✕	End time of the last activity of the tour.
`travel_times`	list of times	✓	✓	✕	Duration of each trip of the tour.
`distances`	list of floats	✓	✓	✕	Euclidean distance of each trip of the tour, in meters.
`trip_weekday`	string	✓	✓	✕	Weekday during which the tour took place.
`outside_perimeter`	boolean	✓	✓	✕	Whether the tour has trips outside the simulation area.
`total_tour_duration`	duration	✓	✓	✕	Duration of the tour, from departure from first origin to arrival at last destination.
`total_activity_duration`	duration	✓	✓	✕	Total duration of all activities in the tour.
`total_travel_time`	duration	✓	✓	✕	Total travel time of all trips in the tour.
`total_distance`	float	✓	✓	✕	Total Euclidean distance of all trips in the tour, in meters.
`has_home_purpose`	boolean	✓	✓	✕	Whether the tour has at least one activity with ‘home’ purpose.
`has_work_purpose`	boolean	✓	✓	✕	Whether the tour has at least one activity with ‘work’ purpose.
`has_education_purpose`	boolean	✓	✓	✕	Whether the tour has at least one activity with ‘education’ purpose.
`has_shopping_purpose`	boolean	✓	✓	✕	Whether the tour has at least one activity with ‘shopping’ purpose.
`has_task_purpose`	boolean	✓	✓	✕	Whether the tour has at least one activity with ‘task’ purpose.
`has_leisure_purpose`	boolean	✓	✓	✕	Whether the tour has at least one activity with ‘leisure’ purpose.
`has_escort_purpose`	boolean	✓	✓	✕	Whether the tour has at least one activity with ‘escort’ purpose.
`has_other_purpose`	boolean	✓	✓	✕	Whether the tour has at least one activity with ‘other’ purpose.
`lowest_density`	enum	✓	✓	✕	Lowest urban density category over activity locations.
`highest_density`	enum	✓	✓	✕	Highest urban density category over activity locations.
`lowest_urban_type`	enum	✓	✓	✕	Lowest urban type over activity locations.
`highest_urban_type`	enum	✓	✓	✕	Highest urban type over activity locations.
`lowest_functional_area_type`	enum	✓	✓	✕	Lowest functional area type over activity locations.
`highest_functional_area_type`	enum	✓	✓	✕	Highest functional area type over activity locations.
`lowest_functional_area_category`	enum	✓	✓	✕	Lowest functional area category over activity locations.
`highest_functional_area_category`	enum	✓	✓	✕	Highest functional area category over activity locations.
`home_density`	enum	✓	✓	✕	Urban density category of the household municipality.
`home_urban_type`	enum	✓	✓	✕	Urban type of the household municipality.
`home_functional_area_type`	enum	✓	✓	✕	Type of the municipality within its functional area.
`home_functional_area_category`	enum	✓	✓	✕	Category of the functional area of the home municipality.
`nb_cars`	unsigned integer	✓	✓	✕	Number of cars owned by the household.
`nb_motorcycles`	unsigned integer	✓	✓	✕	Number of motorcycles owned by the household.
`nb_bicycles`	unsigned integer	✓	✓	✕	Number of bicycles owned by the household.
`nb_persons`	unsigned integer	✕	✓	✕	Number of persons living in the household.
`nb_majors`	unsigned integer	✓	✓	✕	Number of persons 18 or older living in the household.
`nb_minors`	unsigned integer	✓	✓	✕	Number of persons 17 or younger living in the household.
`nb_women`	unsigned integer	✓	✓	✕	Number of women living in the household.
`nb_major_women`	unsigned integer	✓	✓	✕	Number of women 18 or older living in the household.
`nb_men`	unsigned integer	✓	✓	✕	Number of men living in the household.
`nb_major_men`	unsigned integer	✓	✓	✕	Number of men 18 or older living in the household.
`nb_driving_licenses`	unsigned integer	✓	✓	✕	Number of driving-license holders living in the household.
`household_type`	string	✓	✓	✕	Type of household structure (single, couple, singleparent, etc.).
`minor_ratio`	float	✓	✓	✕	Share of household members 17 or younger.
`car_ratio`	float	✓	✓	✕	Number of cars per person in the household.
`driving_license_ratio`	float	✓	✓	✕	Number of cars per driving-license holder.
`woman`	boolean	✓	✓	✕	Whether the person is a woman.
`age`	unsigned integer	✓	✓	✕	Age of the person.
`oldest_age_diff`	unsigned integer	✓	✓	✕	Age difference to the oldest person in the household.
`education_level`	string	✓	✓	✕	Education level of the person.
`professional_activity`	string	✓	✓	✕	Professional status of the person (e.g., worker, student, retiree).
`socioprofessional_class`	unsigned integer	✓	✓	✕	Socioprofessional class (job type) of the person.
`has_driving_license`	boolean	✓	✓	✕	Whether the person has a driving license.
`has_public_transit_subscription`	boolean	✓	✓	✕	Whether the person has a public-transit subscription.
`nb_tours`	unsigned integer	✕	✓	✕	Number of tours that the person did during the surveyed day.

TripsBicycleCostsFile

Minimum cost on the bicycle network for each trip.

Path: demand/{population}/trips/bicycle/costs.parquet
Type: DataFrame
Steps: TripsBicycleCostStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`trip_id`	string or integer	✕	✕	✓	Identifier of the trip.
`bicycle_cost`	float	✕	✓	✕	Minimum cost of the trip on the bicycle network, in meters.
`bicycle_path`	list of strings or integers	✕	✓	✕	Minimum-cost path of the trip on the bicycle network, as a list of ids.

TripsBicycleNodesFile

Origin and destination nodes on the bicycle network for each trip.

Path: demand/{population}/trips/bicycle/origins_destinations.parquet
Type: DataFrame
Steps: BicycleODNodesFromCoordinatesStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`trip_id`	string or integer	✕	✕	✓	Identifier of the trip.
`origin_bicycle_node`	string or integer	✕	✓	✕	Identifier of the origin node on the bicycle network.
`origin_bicycle_node_dist`	float	✓	✓	✕	Distance between the trip’s origin and the corresponding bicycle node, in meters.
`origin_bicycle_node_dist_on_edge`	float	✓	✓	✕	Distance between the trip’s origin and the corresponding bicycle node, projected on the closest edge, in meters.
`origin_bicycle_edge`	string or integer	✓	✓	✕	Identifier of the bicycle edge closest to the trip’s origin.
`origin_bicycle_edge_dist`	float	✓	✓	✕	Distance between the trip’s origin and the closest bicycle edge, in meters.
`destination_bicycle_node`	string or integer	✕	✓	✕	Identifier of the destination node on the bicycle network.
`destination_bicycle_node_dist`	float	✓	✓	✕	Distance between the trip’s destination and the corresponding bicycle node, in meters.
`destination_bicycle_node_dist_on_edge`	float	✓	✓	✕	Distance between the trip’s destination and the corresponding bicycle node, projected on the closest edge, in meters.
`destination_bicycle_edge`	string or integer	✓	✓	✕	Identifier of the bicycle edge closest to the trip’s destination.
`destination_bicycle_edge_dist`	float	✓	✓	✕	Distance between the trip’s destination and the closest bicycle edge, in meters.

TripsDestinationsFile

Destination coordinates of each trip.

Path: demand/{population}/trips/destinations.geo.parquet
Type: GeoDataFrame
Steps: CustomODMatrixStep, EqasimImportStep, GravityODMatrixStep, ImportTripCoordinatesStep, ODMatrixEachStep

Show columns

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

TripsDistancesFile

Euclidean distance of each trip.

Path: demand/{population}/trips/distances.parquet
Type: DataFrame
Steps: TripDistancesStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`trip_id`	string or integer	✕	✕	✓	Identifier of the trip.
`od_distance`	float	✕	✕	✕	Distance between origin and destination, in meters.

TripsUrbanTypeFile

Urban type attributes of trips’ origin and destination.

Path: demand/{population}/trips/origin_destination_urban_type.parquet
Type: DataFrame
Steps: FrenchTripsUrbanTypeStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`trip_id`	string or integer	✕	✕	✓	Identifier of the trip.
`origin_density`	enum	✕	✓	✕	Urban density category of the origin municipality.
`origin_urban_type`	enum	✕	✓	✕	Urban type of the origin municipality.
`origin_functional_area_type`	enum	✕	✓	✕	Type of the origin municipality within its functional area.
`origin_functional_area_category`	enum	✕	✓	✕	Category of the functional area of the origin municipality.
`destination_density`	enum	✕	✓	✕	Urban density category of the destination municipality.
`destination_urban_type`	enum	✕	✓	✕	Urban type of the destination municipality.
`destination_functional_area_type`	enum	✕	✓	✕	Type of the destination municipality within its functional area.
`destination_functional_area_category`	enum	✕	✓	✕	Category of the functional area of the destination municipality.

TripsOriginsFile

Origin coordinates of each trip.

Path: demand/{population}/trips/origins.geo.parquet
Type: GeoDataFrame
Steps: CustomODMatrixStep, EqasimImportStep, GravityODMatrixStep, ImportTripCoordinatesStep, ODMatrixEachStep

Show columns

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

TripsPedestrianDistancesFile

Distance of the shortest path on the pedestrian network for each trip.

Path: demand/{population}/trips/pedestrian/distances.parquet
Type: DataFrame
Steps: TripsPedestrianDistancesStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`trip_id`	string or integer	✕	✕	✓	Identifier of the trip.
`pedestrian_distance`	float	✕	✓	✕	Distance of the trip on the pedestrian network, in meters.
`pedestrian_path`	list of strings or integers	✓	✓	✕	Shortest path of the trip on the pedestrian network, as a list of ids.

TripsPedestrianNodesFile

Origin and destination nodes on the pedestrian network for each trip.

Path: demand/{population}/trips/pedestrian/origins_destinations.parquet
Type: DataFrame
Steps: PedestrianODNodesFromCoordinatesStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`trip_id`	string or integer	✕	✕	✓	Identifier of the trip.
`origin_pedestrian_node`	string or integer	✕	✓	✕	Identifier of the origin node on the pedestrian network.
`origin_pedestrian_node_dist`	float	✓	✓	✕	Distance between the trip’s origin and the corresponding pedestrian node, in meters.
`origin_pedestrian_node_dist_on_edge`	float	✓	✓	✕	Distance between the trip’s origin and the corresponding pedestrian node, projected on the closest edge, in meters.
`origin_pedestrian_edge`	string or integer	✓	✓	✕	Identifier of the pedestrian edge closest to the trip’s origin.
`origin_pedestrian_edge_dist`	float	✓	✓	✕	Distance between the trip’s origin and the closest pedestrian edge, in meters.
`destination_pedestrian_node`	string or integer	✕	✓	✕	Identifier of the destination node on the pedestrian network.
`destination_pedestrian_node_dist`	float	✓	✓	✕	Distance between the trip’s destination and the corresponding pedestrian node, in meters.
`destination_pedestrian_node_dist_on_edge`	float	✓	✓	✕	Distance between the trip’s destination and the corresponding pedestrian node, projected on the closest edge, in meters.
`destination_pedestrian_edge`	string or integer	✓	✓	✕	Identifier of the pedestrian edge closest to the trip’s destination.
`destination_pedestrian_edge_dist`	float	✓	✓	✕	Distance between the trip’s destination and the closest pedestrian edge, in meters.

TripsPublicTransitItinerariesFile

Minimum-cost public-transit itinerary for each trip.

Path: demand/{population}/trips/public_transit/itineraries.parquet
Type: DataFrame
Steps: PublicTransitTravelTimesFromRoadDistancesStep, TripsOpenTripPlannerStep, TripsPublicTransitTravelTimeFromR5Step

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`trip_id`	string or integer	✕	✕	✓	Identifier of the trip.
`travel_time`	duration	✕	✓	✕	Travel time of the trip.
`generalized_time`	duration	✓	✓	✕	Generalized time of the trip (travel time with mode-specific weights).
`waiting_time`	duration	✓	✓	✕	Waiting time on the trip.
`legs`	unspecified datatype	✓	✓	✕	Sequence of legs that define the itinerary of the trip.

TripsCarFreeFlowTravelTimesFile

Travel time by car under free-flow conditions for each trip.

Path: demand/{population}/trips/road/free_flow_travel_times.parquet
Type: DataFrame
Steps: TripsCarFreeFlowTravelTimesStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`trip_id`	string or integer	✕	✕	✓	Identifier of the trip.
`free_flow_travel_time`	duration	✕	✓	✕	Travel time by car under free-flow conditions.
`free_flow_route`	list of strings or integers	✕	✓	✕	Fastest path on the road network under free-flow conditions, as a list of ids.
`free_flow_distance`	float	✕	✓	✕	Length of the fastest path on the road network under free-flow conditions, in meters.

NonPrimaryCarTrips

Data on car trips traveling exclusively on non-primary edges.

Path: demand/{population}/trips/road/non_primary_car_trips.parquet
Type: DataFrame
Steps: CarAccessEgressStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`trip_id`	string or integer	✕	✕	✓	Identifier of the trip.
`free_flow_travel_time`	duration	✕	✓	✕	Travel time by car under free-flow conditions.
`path`	list of strings or integers	✕	✓	✕	List of (non-primary) edge ids that consists the trip.
`path_length`	float	✕	✓	✕	Length of the trip, in meters.

RoadODMatrixFile

Origin / destination matrix at the road-network node level.

Path: demand/{population}/trips/road/origin_destination_matrix.parquet
Type: GeoDataFrame
Steps: RoadODMatrixStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`origin_node_id`	string or integer	✕	✕	✕	Identifier of the origin node.
`destination_node_id`	string or integer	✕	✕	✕	Identifier of the destination node.
`size`	unsigned integer	✕	✕	✕	Number of trips for this origin-destination pair.

TripsRoadNodesFile

Origin and destination nodes on the road network for each trip.

Path: demand/{population}/trips/road/origins_destinations.parquet
Type: DataFrame
Steps: RoadODNodesFromCoordinatesStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`trip_id`	string or integer	✕	✕	✓	Identifier of the trip.
`origin_road_node`	string or integer	✕	✓	✕	Identifier of the origin node on the road network.
`origin_road_node_dist`	float	✓	✓	✕	Distance between the trip’s origin and the corresponding road node, in meters.
`origin_road_node_dist_on_edge`	float	✓	✓	✕	Distance between the trip’s origin and the corresponding road node, projected on the closest edge, in meters.
`origin_road_edge`	string or integer	✓	✓	✕	Identifier of the road edge closest to the trip’s origin.
`origin_road_edge_dist`	float	✓	✓	✕	Distance between the trip’s origin and the closest road edge, in meters.
`destination_road_node`	string or integer	✕	✓	✕	Identifier of the destination node on the road network.
`destination_road_node_dist`	float	✓	✓	✕	Distance between the trip’s destination and the corresponding road node, in meters.
`destination_road_node_dist_on_edge`	float	✓	✓	✕	Distance between the trip’s destination and the corresponding road node, projected on the closest edge, in meters.
`destination_road_edge`	string or integer	✓	✓	✕	Identifier of the road edge closest to the trip’s destination.
`destination_road_edge_dist`	float	✓	✓	✕	Distance between the trip’s destination and the closest road edge, in meters.

PrimaryCarTripsAccessEgressFile

Data on the access / egress parts of the car trips.

Path: demand/{population}/trips/road/primary_car_trips_access_egress.parquet
Type: DataFrame
Steps: CarAccessEgressStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`trip_id`	string or integer	✕	✕	✓	Identifier of the trip.
`access_node`	string or integer	✕	✓	✕	Identifier of the road-network node where the primary part starts.
`access_path`	list of strings or integers	✕	✓	✕	List of edge ids that consists the access part of the trip.
`access_time`	duration	✕	✓	✕	Time spent on the access part of the trip when traveling by car under free-flow conditions.
`access_length`	float	✕	✓	✕	Length of the access part of the trip, in meters.
`egress_node`	string or integer	✕	✓	✕	Identifier of the road-network node where the primary part ends.
`egress_path`	list of strings or integers	✕	✓	✕	List of edge ids that consists the egress part of the trip.
`egress_time`	duration	✕	✓	✕	Time spent on the egress part of the trip when traveling by car under free-flow conditions.
`egress_length`	float	✕	✓	✕	Length of the egress part of the trip, in meters.

TripsFile

Identifiers and order of the trips for each person.

Path: demand/{population}/trips/trips.parquet
Type: DataFrame
Steps: EqasimImportStep, PopulationFromTripCoordinatesStep

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.
`origin_purpose_group`	string	✓	✓	✕	Purpose of the activity preceding the trip.
`destination_purpose_group`	string	✓	✓	✕	Purpose of the activity preceding the trip.
`origin_activity_duration`	duration	✓	✓	✕	Duration of the activity performed at the trip’s origin.
`destination_activity_duration`	duration	✓	✓	✕	Duration of the activity performed at the trip’s destination.
`departure_time`	duration	✓	✓	✕	Ex-ante departure time from origin. This can differ from the simulated departure time.
`arrival_time`	duration	✓	✓	✕	Ex-ante arrival time at destination. This can differ from the simulated arrival time.

TripsZonesFile

Zones of the trips’ origins and destinations.

Path: demand/{population}/trips/zones.parquet
Type: DataFrame
Steps: TripsZonesStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`trip_id`	string or integer	✕	✕	✓	Identifier of the trip.
`origin_zone1`	string or integer	✓	✓	✕	Identifier of the origin location in the level 1 zone system.
`origin_zone2`	string or integer	✓	✓	✕	Identifier of the origin location in the level 2 zone system.
`origin_zone3`	string or integer	✓	✓	✕	Identifier of the origin location in the level 3 zone system.
`origin_zone4`	string or integer	✓	✓	✕	Identifier of the origin location in the level 4 zone system.
`origin_zone5`	string or integer	✓	✓	✕	Identifier of the origin location in the level 5 zone system.
`destination_zone1`	string or integer	✓	✓	✕	Identifier of the destination location in the level 1 zone system.
`destination_zone2`	string or integer	✓	✓	✕	Identifier of the destination location in the level 2 zone system.
`destination_zone3`	string or integer	✓	✓	✕	Identifier of the destination location in the level 3 zone system.
`destination_zone4`	string or integer	✓	✓	✕	Identifier of the destination location in the level 4 zone system.
`destination_zone5`	string or integer	✓	✓	✕	Identifier of the destination location in the level 5 zone system.

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.

BicycleEdgesCleanFile

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

Path: network/bicycle_network/edges_clean.geo.parquet
Type: GeoDataFrame
Steps: PostprocessBicycleNetworkStep

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.
`edge_type`	string or integer	✓	✕	✕	Identifier of the edge’s type.
`length`	float	✕	✕	✕	Length of the edge, in meters.
`speed_limit`	float	✓	✓	✕	Speed limit on the edge, for cars, in km/h.
`lanes`	float	✓	✓	✕	Number of lanes on the edge, for cars.
`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.
`has_bump`	boolean	✓	✓	✕	Whether there is at least one bump on the edge.
`name`	string	✓	✓	✕	Name of the edge.
`type`	string	✓	✓	✕	Type of the edge for bicycles.
`quality`	unsigned integer	✓	✓	✕	Road quality of the edge.
`original_id`	string or integer	✓	✓	✕	Identifier of the edge in the original data.

BicycleEdgesCostsFile

Cost of each bicycle edge.

Path: network/bicycle_network/edges_costs.parquet
Type: DataFrame
Steps: ExogenousBicycleEdgeCostsStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`edge_id`	string or integer	✕	✕	✓	Identifier of the edge.
`cost`	float	✕	✓	✕	Cost of the edge.

BicycleEdgesRawFile

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

Path: network/bicycle_network/edges_raw.geo.parquet
Type: GeoDataFrame
Steps: OpenStreetMapBicycleImportStep

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.
`edge_type`	string or integer	✓	✕	✕	Identifier of the edge’s type.
`length`	float	✕	✕	✕	Length of the edge, in meters.
`speed_limit`	float	✓	✓	✕	Speed limit on the edge, for cars, in km/h.
`lanes`	float	✓	✓	✕	Number of lanes on the edge, for cars.
`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.
`has_bump`	boolean	✓	✓	✕	Whether there is at least one bump on the edge.
`name`	string	✓	✓	✕	Name of the edge.
`type`	string	✓	✓	✕	Type of the edge for bicycles.
`quality`	unsigned integer	✓	✓	✕	Road quality of the edge.
`original_id`	string or integer	✓	✓	✕	Identifier of the edge in the original data.

PedestrianEdgesCleanFile

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

Path: network/pedestrian_network/edges_clean.geo.parquet
Type: GeoDataFrame
Steps: PostprocessPedestrianNetworkStep

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.
`edge_type`	string or integer	✓	✕	✕	Identifier of the edge’s type.
`length`	float	✕	✕	✕	Length of the edge, in meters.
`name`	string	✓	✓	✕	Name of the edge.
`original_id`	string or integer	✓	✓	✕	Identifier of the edge in the original data.

PedestrianEdgesRawFile

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

Path: network/pedestrian_network/edges_raw.geo.parquet
Type: GeoDataFrame
Steps: OpenStreetMapPedestrianImportStep

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.
`edge_type`	string or integer	✓	✕	✕	Identifier of the edge’s type.
`length`	float	✕	✕	✕	Length of the edge, in meters.
`name`	string	✓	✓	✕	Name of the edge.
`original_id`	string or integer	✓	✓	✕	Identifier of the edge 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.

RoadEdgesCapacitiesFile

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.

RoadEdgesCleanFile

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.
`edge_type`	string or integer	✓	✕	✕	Identifier of the edge’s 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.
`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.

RoadEdgesPrimaryFlagFile

Primary / secondary indicator of each road-network edge.

Path: network/road_network/edges_primary.parquet
Type: DataFrame
Steps: RoadNetworkPrimaryEdgesStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`edge_id`	string or integer	✕	✕	✓	Identifier of the edge.
`primary`	boolean	✕	✕	✕	Whether the edge is part of the primary road network.

RoadEdgesRawFile

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

Path: network/road_network/edges_raw.geo.parquet
Type: GeoDataFrame
Steps: CircularNetworkStep, CustomRoadImportStep, GridNetworkStep, OpenStreetMapRoadImportStep

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.
`edge_type`	string or integer	✓	✕	✕	Identifier of the edge’s 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.
`name`	string	✓	✓	✕	Name of the edge.
`original_id`	string or integer	✓	✓	✕	Identifier of the edge in the original data.

RoadEdgesUrbanFlagFile

Urban / rural indicator of each road-network edge.

Path: network/road_network/edges_urban.parquet
Type: DataFrame
Steps: UrbanEdgesStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`edge_id`	string or integer	✕	✕	✓	Identifier of the edge.
`urban`	boolean	✕	✕	✕	Whether the edge is part of an urban area.

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

MeanSurplusConvergencePlotFile

Mean surplus over iterations.

Path: results/graphs/convergence/mean_surplus.png
Type: Plot
Steps: ConvergencePlotStep

RouteLengthDiffConvergencePlotFile

Mean length of the selected route not selected during the previous iteration, over iterations.

Path: results/graphs/convergence/route_length_diff.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/road_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/road_network/congestion_function_simulated.png
Type: Plot
Steps: RoadNetworkCongestionFunctionPlotsStep

TripDepartureTimeDistributionPlotFile

Histogram of departure time distribution, over trips.

Path: results/graphs/{population}/trips/departure_time_distribution.png
Type: Plot
Steps: TripDepartureTimeDistributionStep

TripModeSharesPlotFile

Mode shares at the trip-level (in number of trips).

Path: results/graphs/{population}/trips/mode_shares.png
Type: Plot
Steps: TripModeSharesStep

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`	duration	✕	✓	✕	Mean tour-level departure time.
`mean_tour_arrival_time`	duration	✕	✓	✕	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_trips`	unsigned integer	✕	✕	✕	Total number of trips.
`nb_outside_options`	unsigned integer	✕	✕	✕	Number of tours choosing the outside option.
`mean_trip_departure_time`	duration	✕	✓	✕	Mean departure time from origin of all trips.
`mean_trip_arrival_time`	duration	✕	✓	✕	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`	duration	✕	✓	✕	Mean departure time from origin of road trips.
`mean_road_trip_arrival_time`	duration	✕	✓	✕	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.

ActivityResultsFile

Clean results for each activity in the population.

Path: results/{population}/activity_results.parquet
Type: DataFrame
Steps: ActivityResultsStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`person_id`	string or integer	✕	✕	✕	Identifier of the person.
`preceding_trip_id`	string or integer	✕	✓	✕	Identifier of the trip before the activity.
`following_trip_id`	string or integer	✕	✓	✕	Identifier of the trip after the activity.
`purpose`	string	✕	✓	✕	Purpose of the activity.
`start_time`	duration	✕	✓	✕	Start time of the activity.
`end_time`	duration	✕	✓	✕	End time of the activity.
`activity_duration`	duration	✕	✓	✕	Duration of the activity.

AggregateOutputFile

JSON file with various aggregate results.

Path: results/{population}/aggregate_results.json
Type: Text
Steps: AggregateResultsStep

RouteResultsFile

Clean route results for each road trip in the population.

Path: results/{population}/route_results.parquet
Type: DataFrame
Steps: RouteResultsStep

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`trip_id`	string or integer	✕	✕	✕	Identifier of the trip.
`edge_id`	string or integer	✕	✕	✕	Identifier of the edge taken.
`entry_time`	duration	✕	✕	✕	Entry time on the edge.
`exit_time`	duration	✕	✕	✕	Exit time on the edge.
`travel_time`	duration	✕	✕	✕	Time spent on the edge.

TripResultsFile

Clean results for each trip in the population.

Path: results/{population}/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.
`vehicle_id`	string or integer	✕	✓	✕	Vehicle type used for the trip.
`is_road`	boolean	✕	✕	✕	Whether the trip is done on the road network.
`departure_time`	duration	✕	✕	✕	Departure time of the trip.
`arrival_time`	duration	✕	✕	✕	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.
`route_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.
`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.
`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.
`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.
`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.

MetroRouteResultsFile

Edge-level results for road trips from the Metropolis-Core Simulation.

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

Show columns

Column	Data type	Optional?	Nullable?	Unique?	Description
`agent_id`	string or integer	✕	✕	✕	Identifier of the agent.
`trip_id`	string or integer	✕	✕	✕	Identifier of the trip.
`trip_index`	integer	✕	✕	✕	Index of the trip in the selected alternative’ trip sequence (starting at 0).
`edge_id`	string or integer	✕	✕	✕	Identifier of the edge.
`entry_time`	float	✕	✕	✕	Time at which the agent entered the edge, for the specified trip, in number of seconds since midnight.
`exit_time`	float	✕	✕	✕	Time at which the agent left the edge, for the specified trip, in number of seconds since midnight.

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

Keyboard shortcuts

METROPOLIS2 The Book