Skip to content

Properties

Michael McCarthy edited this page Oct 25, 2021 · 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 enclosed in quotes and separated with a comma.
group Group or process the setting is part of
Notes Notes and additional description

The current CALM settings file is as follows:

NO setting value Units RCodeUse group Notes
1 initials " ""mam""" string "balanceDist.R, calcTripsByMode.R, hbschMcByType.R, tripDistribution.R" scen NA
2 year 2010 integer "inputs.R, externalModel_SWIM" scen NA
3 project CALM 2010 string "jemnrFunctions.R, calcTripsByMode.R, hbschMcByType.R, balanceDist.R, tripDistribution.R" scen NA
4 peak_scen_num 3010 integer "runModel.R, University.R" scen NA
5 dailyoffpeak_scen_num 2010 integer runModel.R scen NA
6 addPopSyn FALSE Boolean input.R Boolean NA
7 externalModelFromSWIM TRUE Boolean "inputs.R, ModelModules.R" Boolean NA
8 runCommercialVehicleModel TRUE Boolean "inputs.R, ModelModules.R, writeToBank.R" Boolean NA
9 runSledge FALSE Boolean runModel.R Boolean NA
10 runPeakOffPeakTransitAssignment FALSE Boolean "runModel.R, writeToBank.R" Boolean NA
11 runUniversityModel TRUE Boolean university.R Boolean NA
12 inputLoc inputs/externalModel/ string externalModel_SWIM.R path NA
13 SWIM_SL_Filename_Pattern _outputs string externalModel_SWIM.R path NA
14 storeLoc inputs/externalModel/ string "externalModel_SWIM.R, addExternals.R" path NA
15 pumaFileName puma string inputsSave.R path NA
16 bankFolder emme/database string runModel.R path NA
17 macrosFolder emme/macros string runModel.R path NA
18 referenceRun "C:/path/to/reference/run" string "runModel.R, modelReport.R" path NA
23 maxIter_Commercial 20 integer cvm.R numeric NA
24 externalDisaggregateMethodNumber 4 integer externalModel_SWIM.R numeric NA
25 bikeSpeed 10 mph inputsSave.R numeric NA
26 drivePass_pass_extra_auto_walk_time 1 minutes inputsSave.R numeric NA
27 externalStationAutoWalkTime 1 minutes inputsSave.R numeric NA
28 maxBikeDistance 10 miles inputsSave.R numeric NA
29 maxWalkDistance 5 miles inputsSave.R numeric NA
30 opWaitTimeACap 30 minutes inputsSave.R numeric NA
31 opWaitTimeBCap 30 minutes inputsSave.R numeric NA
32 opWalkTimeCap 30 minutes inputsSave.R numeric NA
33 percentDriveForParkAndRideCost 0.25 numeric inputsSave.R numeric NA
34 pkWaitTimeACap 30 minutes inputsSave.R numeric NA
35 pkWaitTimeBCap 30 minutes inputsSave.R numeric NA
36 pkWalkTimeCap 30 minutes inputsSave.R numeric NA
37 walkSpeed 3 mph inputsSave.R numeric NA
38 walkTimepeakparkAndRideBusCap 30 minutes inputsSave.R numeric NA
39 absTTChange 0.01 numeric runModel.R numeric NA
40 maxIter 10 integer runModel.R numeric NA
41 maxRMSE 1 integer runModel.R numeric NA
42 pkTimeOldPercent 0.9 numeric runModel.R numeric NA
43 universityIterations 1 integer university.R numeric NA
44 universitySampleRate 1 integer university.R numeric NA
45 UnivJEMNREmpFact 0.5 integer university.R numeric Used to factor employment above or below the ratio of houses in the NonUniversity population to all houses
46 vacancyRate 0.46 numeric visitors.R numeric Rate applied to lodging csv in the visitors model
47 IZFactA 0.8 numeric inputsSave.R numeric Percentage of mean distance to use as Intrazonal Time
48 IZFactB 0.6 numeric createTripDist.R numeric Percentage of mean distance to use as Intrazonal Time
49 IZFactW 0.5 numeric createTripDist.R numeric Percentage of mean distance to use as Intrazonal Time
50 hbcollPeakFactor 0.407 numeric hbcollAccessUtils.csv Factor Input peakFactor used to weight peak versus offpeak variables in utilities and to split trips by period in mode choice model - see Metro Documentation
51 hboPeakFactor 0.3766 numeric hboAccessUtils.csv Factor Input peakFactor used to weight peak versus offpeak variables in utilities and to split trips by period in mode choice model - see Metro Documentation
52 hbrPeakFactor 0.3085 numeric hbrAccessUtils.csv Factor Input peakFactor used to weight peak versus offpeak variables in utilities and to split trips by period in mode choice model - see Metro Documentation
53 hbsPeakFactor 0.2997 numeric hbsAccessUtils.csv Factor Input peakFactor used to weight peak versus offpeak variables in utilities and to split trips by period in mode choice model - see Metro Documentation
54 hbwPeakFactor 0.6058 numeric hbwAccessUtils.csv Factor Input peakFactor used to weight peak versus offpeak variables in utilities and to split trips by period in mode choice model - see Metro Documentation
55 nhbnwPeakFactor 0.3314 numeric nhbnwAccessUtils.csv Factor Input peakFactor used to weight peak versus offpeak variables in utilities and to split trips by period in mode choice model - see Metro Documentation
56 nhbwPeakFactor 0.3819 numeric nhbwAccessUtils.csv Factor Input peakFactor used to weight peak versus offpeak variables in utilities and to split trips by period in mode choice model - see Metro Documentation
57 hbcollTripCalibrationFactor 1 numeric hbcollGen.R Factor Factors used to boost trips or employment in generation
58 hbsroTripProdCalibrationFactor 1.3144 numeric "hbrGen.R, hbsGen.r, hboGen.R" Factor Factors used to boost trips or employment in generation
59 hbwTotalEmploymentCalibrationFactor 1.1349 numeric hbwGen.R Factor Factors used to boost trips or employment in generation
60 nhbnwTripProdCalibrationFactor 1.3236 numeric nhbGen.R Factor Factors used to boost trips or employment in generation
61 nhbwTotalEmploymentCalibrationFactor 0.3399 numeric nhbGen.R Factor Factors used to boost trips or employment in generation
62 hbsroVisitorCalibrationFactor 1 numeric hbsroGen.R Factor Factors used to boost trips or employment in generation
63 nhbnwVisitorCalibrationFactor 1 numeric nhbGen.R Factor Factors used to boost trips or employment in generation
64 scalingFactors_hbo 1.0348 numeric inputs.R (added to distUtils.csv) Factor Scales the impedence terms of the trip distibution utilities - Default is 1
65 scalingFactors_hbr 1.2561 numeric inputs.R (added to distUtils.csv) Factor Scales the impedence terms of the trip distibution utilities - Default is 1
66 scalingFactors_hbs 1.2173 string inputs.R (added to distUtils.csv) Factor Scales the impedence terms of the trip distibution utilities - Default is 1
67 scalingFactors_hbwhighInc 0.7792 numeric inputs.R (added to distUtils.csv) Factor Scales the impedence terms of the trip distibution utilities - Default is 1
68 scalingFactors_hbwlowInc 0.4812 numeric inputs.R (added to distUtils.csv) Factor Scales the impedence terms of the trip distibution utilities - Default is 1
69 scalingFactors_hbwmidInc 0.6904 numeric inputs.R (added to distUtils.csv) Factor Scales the impedence terms of the trip distibution utilities - Default is 1
70 scalingFactors_nhbnw 3.3247 numeric inputs.R (added to distUtils.csv) Factor Scales the impedence terms of the trip distibution utilities - Default is 1
71 scalingFactors_nhbw 3.3247 numeric inputs.R (added to distUtils.csv) Factor Scales the impedence terms of the trip distibution utilities - Default is 1
72 autoOperCost 0.091 In 1995 Dollars per Mile inputsSave.R Factor Auto Operating Cost per mile
73 deflat 1 numeric jemnrFunctions.R Factor Defaltes income from 2010 to 1995
74 shopEmpFactor 3 Estimated employees per 1000 sqft tripDist.R Factor Boosts Retail employment in trip distribution for non work related purposes
75 CVMFactor 1.0654 A factor for total CVM trips CVM.r Factor NA

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 to store file paths and defaults.

VDFs

See Volume Delay Functions

VISUM assignment/skimming settings

Highway

Transit

Non-motorized