Notebooks

Three notebooks have been retained for the processing of base networks:

  • 01_build_base_network.ipynb – designed to build the base network (nodes, links, zones, centroids, connectors) in a PTM ready format.
  • 02_disaggregate_to_platform_level_network.ipynb – designed to build a platform level network within the existing built base network - used for Timetable assignment only.
  • 03_source_emme_attributes_from_stm.ipynb - designed to ingest attributes from a strategic model

Files Created

These notebooks create the following inputs in ..\schemas\{SCHEMA_NAME}\_emme_inputs\_generated_inputs:

  • networks.gpkg - for spatial data
  • schema_database.sqlite - for non-spatial data

Details

01_build_base_network.ipynb

This notebook is designed to build a base network for the PTM (Public Transport Model) using data from SEQSTM (South East Queensland Strategic Transport Model). This notebook will assume you have an extracted spatial network from SEQSTM or BSTM, including:

  • Links_Export.TAB
  • Nodes_Export.TAB
  • Centroids_Export_FINAL.TAB
  • Connectors_Export_FINAL.TAB
  • FINAL_ZONES.TAB
  • PnR_Scen.TAB

Steps involved include:

  1. User Defined Variables: Set up schema name, network source, and version, and decide whether to keep external zones.
  2. Schema Setup and Validation: Define the schema and validate the configuration to ensure the necessary files and paths are correctly set up.
  3. Import SEQSTM Networks: Import various network elements such as links, nodes, centroids, and connectors from SEQSTM files.
  4. Filter Links and Nodes: Retain only the links and nodes that are used by the model modes, which is particularly useful for timetable models.
  5. Format Tables for Database: Format the network tables (nodes, links, centroids, connectors) for database export.
  6. Perform Link and Node Modifications: Apply any necessary modifications to links and nodes based on predefined modification files.
  7. Import Zones: Import internal and external zones, and format them appropriately.
  8. Perform Zone and Centroid Modifications: Apply modifications to zones and centroids, including deletions and additions.
  9. Import Park and Ride Zones: Import and modify park and ride zones if applicable.
  10. Perform Connector Modifications: Modify connectors based on predefined modification files.
  11. Obtain Final Centroids and Zones: Combine internal, park and ride, and external zones and centroids to form the final network.
  12. Validate Networks: Validate the network to identify and correct any errors.
  13. Create Fare Zone Concordance: Import fare zones and create a concordance between centroids and fare zones.
  14. Create Network Attributes: Generate additional network attributes, including corridor attributes.
  15. Save Networks Locally: Export the validated network elements (nodes, links, zones, centroids, connectors) and attributes to local files and the database.

This notebook ensures that the network is correctly built, validated, and formatted for use in transport modelling, with all necessary modifications and attributes applied.

02_disaggregate_to_platform_level_network.ipynb

This notebook is designed to modify the base network and create a platform-based network for heavy rail stations.

Steps involved include:

  1. Setup User Defined Variables: Note that the WALKING_SPEED is set to 5 km/h.
  2. Update Walking Speed: Walking speed is obtained from a CSV file if available and will update the default WALKING_SPEED variable. This allows for custom walking speeds to be included to match the overarching PTM schema.
  3. Import Existing Networks: The existing rail and non-rail networks are imported from the PTM schema. These are the networks built from the ‘01_build_base_network.ipynb’ notebook.
  4. Check for Existing Platforms: The notebook checks if platforms have already been built to avoid duplication.
  5. Build Platform Nodes: Platform nodes to be built are identified and created for these platforms.
  6. Amend Rail Links: Rail links are amended to incorporate the new platform nodes. This is done by creating new links and modifying the vertices of the input links.
  7. Amend Station Nodes: Station nodes are updated to reflect the new platform nodes.
  8. Keep Existing Rail Connectors and Create New Ones for Platform-Platform Movements: Existing rail connectors are retained, and new connectors are created to link platforms.
  9. Save Networks Locally: The final networks, including nodes, links, centroids, and connectors, are validated and saved locally.

This notebook ensures that the platform-level network is accurately built and integrated with the existing base network, including necessary validations and exports.

03_source_emme_attributes_from_stm.ipynb

This notebook is designed to source extra attributes from a Strategic Transport Model (STM) run and import them for use in a Public Transport Model (PTM). This notebook is commonly used to import auto times from a STM to model bus priority changes in PTM.

Steps involved include:

  1. Setup User Defined Variables: SCHEMA_NAME: Specifies the schema name for the PTM. STM_EXTRACTION_PATH: Path to the STM extraction files. STM_TO_SCHEMA_TIME_PERIOD_MAPPING: Dictionary mapping STM time periods to PTM time periods. STM_LINK_ATTRIBUTES_MAPPING: Dictionary mapping STM link attributes to PTM link attributes. STM_NODE_ATTRIBUTES_MAPPING: Dictionary mapping STM node attributes to PTM node attributes.
  2. Define Schema and Validate Config: The schema is set up and validated using the set_up_schema_for_nb function.
  3. Import Link and Node Attributes: The notebook reads link and node data from the specified STM extraction path for each time period. It processes and maps the attributes from STM to PTM according to the defined mappings. An example of the mapping is included below;
# attributes to be imported into ptm from stm extraction
STM_LINK_ATTRIBUTES_MAPPING = {
    'TIMAU': '@auto_time', 
    'DATA1': '@ul1', 
    'DATA2': '@ul2', 
    'DATA3': '@ul3'
}

The processed link and node attributes are stored in lists.

  1. Export Attributes: The processed link and node attributes are concatenated and exported to CSV files if data is available. The CSV files are saved in the specified model paths for further use in PTM.

This process ensures that the necessary attributes from STM are correctly imported and formatted for use in PTM, facilitating seamless integration and analysis.