Skip to content

Utilities

The TDM23 Utility Platform is a free-to-deploy service infrastructure that supports a suite of utilities designed to enhance modeling workflows for average model users. These utilities help by simplifying scenario setup, automating repetitive tasks, assisting with data preparation, and improving troubleshooting. Most of these utilities operate independently from TDM23 and TransCAD, making them essential for efficiently managing TDM23 outputs and analyses.

Utility Platform Installation

Note: Anaconda is required to install the Utility Platform.

  1. Download the Package: Retrieve thetdm23_utility_platform.zip file from the link provided in your email.

  2. Extract the Files: Unzip the contents to your preferred folder.

  3. Run the Installer:

    • Locate and execute tdm23-setup-[version].exe.

    • Follow the on-screen instructions.

    • Refer to the illustration below and use the arrows to navigate through the steps.

Start Installer

Run the executable to launch the installation window.

UPI 1 Img

Configure Anaconda

Specify the path to `conda.bat` to ensure proper environment setup.

UPI 2 Img

Detect Environment

The installer automatically detects the existence and version of `tdm23_env_1`, setting the process to "Fresh Installation" or "Upgrade Existing Installation" accordingly.

UPI 3 Img

Select Installation Location

Choose the directory where the utility platform will be installed.

UPI 4 Img

Specify Installation Type

Select "Fresh Installation" for a new setup or Upgrade "Existing Installation" to update an existing environment.

UPI 5 Img

Fresh Installation

If "Fresh Installation" is selected, a terminal window will open to execute the setup. Keep it open until the process completes. Once finished, press any key to continue, and the window will close automatically.

UPI 6 Img

Upgrade Existing Installation

If "Upgrade Existing Installation" is selected, no terminal window will open. The progress will be displayed at the bottom of the installation window.

UPI 8 Img

Installation Complete

The installation is complete. You can create a desktop shortcut if desired. Click "Finish" to exit.

UPI 9 Img

Access the Platform

  • The platform can be accessed via the desktop shortcut created during installation. If unavailable, navigate to the installation directory (default: C:\Program Files\TDM23 Utility Platform\) and run the executable manually.

  • A terminal window will open during bootup. Keep this window open while using the platform.

  • The platform will automatically launch in your default web browser. You may see errors in the terminal window, but as long as the platform opens in your web browser, they can be ignored.

Upon launching, the TDM23 Utility Platform opens to a dashboard displaying available utilities in a structured table. Users can sort utilities by clicking on column headers, with an arrow indicating the sorting order. The table includes the following columns:

  • Icon: Visual representation of the tool.

  • Name: Utility tool name.

  • Category: Tags describing the tool’s application (e.g., Transit Demand Analytics, Data Processing).

  • Description: Brief overview of functionality.

  • Launch: Button to start the tool (Launch, Open in Colab, Jupyter Notebook, etc.).

  • Info: More details about the tool (click the blue info icon).

The top-right corner provides key options for navigation and customization:

  • Filter (Search): Search and filter utilities by keyword, category, or required dependency.

  • System Settings: Configure essential parameters such as the TDM23 model location and result folder paths.

  • Theme Mode: Switch between light mode and dark mode.

In System Settings, you can define paths for:

  • Result Folders – Set up to two default result directories. Users can also specify a directory within individual utilities as needed.

  • TDM23 Model – Define the path to the TDM23 model for utilities that interact with it.

  • Conda Environment – Set the path to conda.bat for utilities requiring the python environment.

  • Working Folder – Choose a directory where utility results will be saved.

After making changes, click "Submit" to save your settings. The configuration will be shown in the "Output" section on the right. If a warning message appears, it's okay to proceed. However, an error message means the changes failed. To apply the setting changes, close the page and terminal window, then relaunch the Utility Platform.

Design Model

Dependency Requirements

Some utilities require external dependencies such as TDM23 or TransCAD.

  • If a tool cannot run due to missing dependencies, it will be greyed out, and a notification will appear in the Launch column.

  • To get the latest version of TDM23, email us at model.support@ctps.org.

  • You can use the Filter to find dependency-free utilities.

Run a Utility

To run a utility, follow the steps below.

  1. Locate the desired utility in the dashboard.

  2. Click Info for additional details about the tool’s functionality and requirements.

  3. Click Launch to open the tool in its designated environment:

    • Launch: Runs utility in a new tab of the web browser.

    • Colab: Runs Python scripts in Google Colab.

    • Jupyter Notebook: Opens in a local or cloud-based Jupyter environment.

  4. Follow on-screen instructions to input data, configure settings, and run.

  5. Results may be provided in various formats such as Interactive maps, HTML reports, or files of other formats (CSV, Excel, etc.).