Skip to content

Properties

Alex Bettinardi edited this page Sep 19, 2023 · 8 revisions

RunModel.bat file

RunModel.bat contains the MAX_ITER setting, which sets the maximum number of iterations to run. If the model assignment results do not converge before the maximum number of iterations, the feedback loop will stop.

:: setup iteration sample rate
SET MAX_ITER=3

The first setting in RunModel.bat is the maximum number of iterations to allow. If the model assignment results do not converge in a few iterations, the maximum number of iterations will stop the feedback loop.

:: setup dependencies, which are one folder up so they can be shared across scenarios
SET JAVA_PATH=%~dp0..\dependencies\jdk1.8.0_111\bin\java.exe
ECHO JAVA_PATH: %JAVA_PATH%

The batch file also specifies the location of required packages in the JAVA_PATH, PYTHON, and R_SCRIPT variables. The path is defined relative to the batch file location to avoid the need to edit paths in each unique environment. The default shown above works where the dependencies folder is alongside a template folder containing the batch file. If dependencies is one more level up, the following would be used:

SET JAVA_PATH=%~dp0..\..\dependencies\jdk1.8.0_111\bin\java.exe

JEMnR settings file

JEMnR settings are stored in a CSV file in inputs/settings.csv.

Attribute Description
NO Number
setting Setting Name
value Setting Value
Units String, Integer, Boolean, or Numeric (float) type
Others include "mph" and "minutes"
RCodeUse Files using the setting. Multiple files are separated with a comma and enclosed in quotes.
group Group or process the setting is part of
Notes Notes and additional description

Each setting is available in R in a variable named after the Setting Name, defined as the Setting Value. For a CSV setting named runUniversityModel with a value of TRUE, the variable would be defined in the R envrionment as:

runUniversityModel <- TRUE

The same is true for strings, integers, and real numbers.

These two components (setting name and value) are thus especially important while the other fields are for reference. The RCodeUse field must be enclosed with quotes if it contains commas.

Several important settings and those settings added as part of the migration to Visum are described below.

File Paths

visumInputFile is the relative path (string) to the input Visum Version (.ver) file from the /template or /scenario-name folder, such as "visum/CALM.ver".

The 7-Zip program is an additional dependency for converting OMX files to ZMX files that can be read by the University model. path7zipexe points to the 7-Zip executable as a full file path (string), such as "C:/Program Files/7-Zip/7z.exe".

Enable/Disable Model Components

externalModelFromSWIM should be set to TRUE to get external link flows from SWIM. If disabled the model will fall back on a legacy external model, which has not been tested by RSG.

runCommercialVehicleModel should be set to TRUE to run the Commercial Vehicle Model.

runPeakOffPeakTransitAssignment may be set to TRUE for separate peak and off-peak (daily) transit demand outputs.

runUniversityModel should be set to TRUE to run the University model component.

Skimming and Assignment

setConnectorTimes enables or disables automated calculation of centroid connector travel times in Visum based on the user-defined speed attribute on connectors.

autoTimeoffPeak_matNum and subsequent *_matNum entries contain the Emme matrix number associated with each model skim. Although Emme is no longer used, the matrix numbers are required to prepare ZMX matrix files for the University model, which still uses these file names.

autoTimeoffPeak_omxName and subsequent *_omxName entries contain the name of the associated skim in Visum. These names are used in the OMX files produced by Visum and are needed here to read skim matrices into JEMnR.

Model Reporting

referenceRun defines the baseline result in the model reporting component. If this path is not set to the directory of a completed model run, the reporting component will fail at the end of the model run.

Convergence Check

absTTChange and maxRMSE are used to check model convergence.

University Model settings file

The University model uses a properties file (unimodel/ctlfiles/tpau_tbm.properties) to store file paths, UEC definitions, and constants.

The %project.folder% token used in this file is passed to the University model as a command line argument and is set to /unimodel.

Any changes to file paths (input file name, for example) should be updated in the properties file.

University Model UEC Example

For an example of calibrating a Utility Expression Calculator (UEC) file, see the University Model page.

Procedure Files

All procedure Files are stored under the folder "Visum\Procedure"

  • connector_times.xml - optional set of steps to update connector times (optional setting to run in the Settings.csv file)
  • set_daily_capprt.xml and set_peak_capprt.xml - procedures run before assignment to establish the correct CapPrT value from CAPPERLANE and NUMLANES link attributes, and the multiplier for the given assignment period (1 pm peak, 16 for daily)
  • prt_assignment.xml - runs auto assignment
  • put_assignment.xml - runs transit assignment

Skimming procedures:

  • prt_daily_skim.xml
  • prt_peak_skim.xml
  • put_skim.xml
  • walk_skim.xml
  • bike_skim.xml

Visum Assignment Settings

Auto Assignment

See Volume Delay Functions

The assignment procedure, prt_assignment.xml, and the skimming procedures, prt_daily_skim.xml and prt_peak_skim.xml are used to produce link volumes and travel time and distances corresponding to the assigned paths for peak hour and daily trips. The trip distance corresponds to the travel path of the assigned volume. Be aware that these are likely different from each other and the shortest distance path.

Transit Assignment

See Transit Assignment settings and Transit Run and Dwell Time calculations