Public Version of the Freight and Fuel Transportation Optimization Tool
Note: FTOT’s Quick Start and Reference Scenario datasets include several ready-to-use example scenarios and input files. See Documentation and Scenario Datasets for the latest scenario and documentation files.
The FTOT User Guide documentation contains details on how to set up an FTOT scenario. The reference scenarios include examples of how to configure different FTOT features and can serve as templates for creating user-specified scenario configuration and input files. Sections of this documentation have been excerpted below for user convenience; see full documentation for further details.
Each FTOT scenario requires a batch (.bat) file, a scenario XML file, and an input_data
directory with the relevant facility-commodity input CSV files. To ensure you have all necessary files to run a new FTOT scenario, the user can
For example, use files from Quick Start 2 for a scenario where freight flows from a raw material producer (rmp) to a processor (proc) to a destination (dest); use Reference Scenario 2 as a template for a candidate processor generation scenario. To then adapt the starter scenario, the user will need to update the scenario XML and supply chain data (e.g., facility-commodity CSV files) at a minimum. See the Checklist of Critical Items to Update section below for the minimum set of items to edit. Some custom scenarios will also require creating new facility-level GIS data. Finally, customization of the scenario’s batch file will also be necessary. See the FTOT User Guide for more details. An introductory video for how to create a custom FTOT scenario is also available on the FTOT landing page.
Batch file
set XMLSCENARIO={}
- Replace brackets with full file path to scenario XML file.Scenario XML file
Scenario_Name
Scenario_Description
RMP_Commodity_Data
- Confirm file path.Destinations_Commodity_Data
- Confirm file path.Other optional items to update:
Disruption_Data
- Change file path.Base_RMP_Layer
- Change geodatabase (GDB) layer if using your own GDB.Base_Destination_Layer
- Change GDB layer if using your own GDB.Base_Processors_Layer
- Change GDB layer if using your own GDB.Processors_Commodity_Data
- Change file path.Processors_Candidate_Commodity_Data
- Change file path.Schedule_Data
- Change file path.Commodity_Mode_Data
- Change file path.Commodity_Density_Data
- Change file path.The FTOT team often introduces optional XML elements as new features are added to FTOT, so older versions of Quick Start and Reference Scenario XML files may not have all available scenario elements. The quickest way to update an existing, older scenario is to manually add any additional elements needed. For reference, the master XML template saved at C:/FTOT/program/lib/v7_temp_Scenario.xml
contains all required and optional XML elements.
When updating the XML, the user does NOT need to include any comments from the original XML or in the template XML, but the elements do need to be in the same order as seen in the template.
Several tools can help the user efficiently and thoroughly update their new scenario XML (and to a lesser extent, the batch files). Text file comparisons can help the user recognize items that still need updating. Consider comparing new scenario files to the following:
C:/FTOT/program/lib
sub-directory. This file (named v7_temp_Scenario.xml
) can help the user identify missing scenario elements or differences from the Quick Start or Reference Scenario defaults. The file is also used as the template for an FTOT Tool that creates new scenario files from scratch.Listed below are just a few tools to update scenario files:
devenv.exe /diff list1.txt list2.txt
replacing list1.txt and list2.txt with the XML or other files the user wishes to compare. The user can drag and drop files to paste in the full file path. A comparison window will open in Visual Studio. See a related Stack Exchange post here.FTOT requires GIS-based input datasets containing the facility names and locations of raw material producers (rmp), processors (proc), and destinations (dest). There are many sources of GIS data an FTOT user can leverage to represent the locations of a scenario’s facilities. FTOT comes with one preexisting facility location geodatabase included in FTOT’s common data subdirectory–point-based representations of every county in the United States located at the centroid of the most populated place within each county. If FTOT was installed in the default location, the county-based facility location geodatabase is stored in the following location: C:\FTOT\scenarios\common_data\facilities\counties.gdb. Users basing facility locations on the default data that come packaged with FTOT do not need to move or copy over those data into a new scenario directory; they can continue to be read from their default location (in the C:/FTOT/scenarios/common_data/facilities
sub-directory).
If the user wants to create their own customized facility location GIS data, refer to the FTOT User Guide.