Properties

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 enclosed in quotes and separated with a comma.
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.

Important Settings

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.

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.

Convergence Check

absTTChange and maxRMSE are used to check model convergence.

Added Settings

The input VISUM Version file is specified in the Settings.csv file as a relative path (string) to the .ver file from the /template or /scenario-name folder.

98,visumInputFile,"visum/CALM.ver",string,VISUM_Runner.py,Visum,relative path to input version file

The 7-Zip program is an additional dependency for converting OMX files to ZMX files that can be read by the University model. The path to the 7-Zip executable is specified in the Settings.csv file as a full path (string).

99,path7zipexe,"C:/Program Files/7-Zip/7z.exe",string,ZMX.r,university.r,path to 7-zip executable

Also, calculation of centroid connector times in VISUM can be enabled or disabled in Settings.csv. This setting is read in Python, but follows R conventions for consistency. A value of "TRUE" will evaluate to Python True and other values including "FALSE" will evaluate to Python False.

100,setConnectorTimes,TRUE,Boolean,VISUM_Runner.py,Visum,Enable/disable connector times procedure

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.

VISUM Assignment Settings

Auto Assignment

See Volume Delay Functions

Transit Assignment

See Transit Assignment settings and Transit Run and Dwell Time calculations