cs fm tool package

Module contents

class cs_fm_tool.CS_FM_Tool(config, scenario_file, perf_meas_file, scen_prefix='UltScen')

Bases: object

Tool definition class that manages the model runs from a definition.

A Mode Choice object is created that contains the modified

inputs and outputs from the model process

Parameters:

• config – the model paths defined in the config.py
• scenario_file – the defined scenario values
• perf_meas_file – the performance measures to generate
• scen_prefix – the string prefix to affix to the output folder

Example:

import cs_fm_tool import param.config as config fm = cs_fm_tool.CS_FM_Tool(config, r’paramprice_adj.yaml’,

r’paramperf_meas_nosm.yaml’)

fm.load_inputs() fm.setup() fm.run() fm.post_process() fm.archive()

archive(out_folder=None)

copy model output files to the archive

archive path is defined in the model config file

load_inputs()

reads inputs into mode choice object

reads zonal data, skim data, and trip tables

paths to data is set in config.py

data must be loaded before setting up scenario

mc = None

post_process()

run performance measurement summary routines

The routines to run are defined in the performance measure yaml file

run()

run mode choice model

All scenario settings need to be conducted before running the mode choice model

setup()

run experiment variable setup routines

setup routines to be called are defined in the model scenario yaml file