| Setting | Value | Description |
|---|---|---|
| Domain Model Setup File | domain_model_setup_v1.xlsx | Name of your Domain Model Setup File (Excel Template). Presumed to be in the "inputs" sub-folder within your work folder. |
| Domain Model DLL File | JCassDefaultRoadModelV1.dll | Name of the DLL file containing your Custom DLL file (compiled C# code library). Presumed to be in the 'domain_model' sub-folder. |
| Domain Model Class Name | RoadNetworkModel | Name of the C# .NET Class that contains your domain model inside the specified DLL. This class should implement the 'IDomainModel' interface. |
| Input File | model_input_data.csv | Name of your Input File (CSV file). Presumed to be in the "inputs" sub-folder within your work folder. |
| Committted Treatments File | committeds_v2.csv | Name of your Committed Treatments File (CSV file). Presumed to be in the "inputs" sub-folder within your work folder. Enter "none" if not applicable. |
| Multi-Column Lookups File | none | Name of your Multi-Column Lookups File (Excel Template). Presumed to be in the "inputs" sub-folder within your work folder. Enter "none" if not applicable. |
| NA | NA | NA |
| NA | NA | NA |
| NOTE: Configurations will be automatically read from sheets prefixed with "config_" | NA | NA |
Work Bench
Overview
The Work Bench file needs to be located in the root ‘cassandra’ folder within your Project folder. The work bench is an Excel file that needs to have the following two mandatory sheets:
- ‘work_bench’
- ‘base_config’
In addition to these mandatory sheets (structure explained below), you need to define specific configurations you want to run on sheets prefixed with ‘config_’. Details are provided below.
In addition to reading the information below, we recommend that you download and study the Example Benchmark File Template. You can also use this template as a basis for your own projects. Click on the button below to download the Work Bench template:
‘work_bench’ Sheet
This sheet holds a simple table that maps the file names that Cassandra needs to know about to run a model. Values you need to specify in this table are listed below with explanations:
Important
The table shown above must have left-upper corner in cell A1 of the ‘work_bench’ sheet. You can use the cells below or to the right of the table but it is recommended that you rather make use of a seperate sheet to keep any notes etc.
‘base_config’ Sheet
This sheet holds the properties of the Base Configuration. A configuration is a setup that defines aspects such as the number of periods over which to run the model, the calendar year that represents period zero, and the budget scenario to use. See this page for details on Model Configurations.
‘config_’ Prefixed Sheets
You can create custom configurations that override properties in the base configuration. Each of these configurations needs to be placed on a separate worksheet and be prefixed with ‘config_’.
For example, to create a configuration that uses the budget ‘current’ you need to override the ‘Budget Sheet to Use’ property in the base configuration. In that case, you will typically add a sheet called ‘config_current’ and copy from the base configuration the properties/settings you want to override, then modify the values as needed. See this page for details on custom model configurations.