CTRAMP Models

Output file format models for the CT-RAMP (Coordinated Travel-Regional Activity Modeling Platform) travel demand model.

data_canon.models.ctramp

Data models for CT-RAMP file formats.

Based on https://github.com/BayAreaMetro/modeling-website/wiki/DataDictionary

See Pipeline Steps > Format Output > CT-RAMP Format

HouseholdCTRAMPModel `pydantic-model`

Household results from Travel Model (CT-RAMP format).

Fields:

hh_id (int)
taz (int)
income (int | None)
autos (int)
jtf_choice (int)
size (int)
workers (int)
humanVehicles (int | None)
autonomousVehicles (int | None)
walk_subzone (WalkToTransitSubZone | None)
auto_suff (int | None)
wfh_choice (WFHChoice | None)
ao_rn (int | None)
fp_rn (int | None)
cdap_rn (int | None)
imtf_rn (int | None)
imtod_rn (int | None)
immc_rn (int | None)
jtf_rn (int | None)
jtl_rn (int | None)
jtod_rn (int | None)
jmc_rn (int | None)
inmtf_rn (int | None)
inmtl_rn (int | None)
inmtod_rn (int | None)
inmmc_rn (int | None)
awf_rn (int | None)
awl_rn (int | None)
awtod_rn (int | None)
awmc_rn (int | None)
stf_rn (int | None)
stl_rn (int | None)
sampleRate (float | None)
hh_weight (float | None)

humanVehicles `pydantic-field`

humanVehicles: int | None = None

Household automobiles, human-driven (New in TM1.5)

autonomousVehicles `pydantic-field`

autonomousVehicles: int | None = None

Household automobiles, autonomous (New in TM1.5)

sampleRate `pydantic-field`

sampleRate: float | None = None

This household represents 1/sampleRate households, calculate from weights as 1/weight

PersonCTRAMPModel `pydantic-model`

Person results from Travel Model (CT-RAMP format).

Fields:

hh_id (int)
person_id (int)
person_num (int)
age (int)
gender (str)
type (CTRAMPPersonType)
value_of_time (float | None)
fp_choice (FreeParkingChoice)
activity_pattern (CTRAMPActivityPattern)
imf_choice (IMFChoice)
inmf_choice (int)
wfh_choice (WFHChoice)
sampleRate (float | None)
person_weight (float | None)

Validators:

validate_person_type_from_label → type

sampleRate `pydantic-field`

sampleRate: float | None = None

This person represents 1/sampleRate persons, calculate from weights as 1/weight

MandatoryLocationCTRAMPModel `pydantic-model`

Mandatory tour locations from Travel Model (CT-RAMP format).

Fields:

HHID (int)
HomeTAZ (int)
Income (int | None)
PersonID (int)
PersonNum (int)
PersonType (CTRAMPPersonType)
PersonAge (int)
EmploymentCategory (CTRAMPEmploymentCategory)
StudentCategory (CTRAMPStudentCategory)
WorkLocation (int)
SchoolLocation (int)
HomeSubZone (WalkToTransitSubZone | None)
SchoolSubZone (WalkToTransitSubZone | None)
WorkSubZone (WalkToTransitSubZone | None)
work_distance_survey (float | None)
school_distance_survey (float | None)

HHID `pydantic-field`

HHID: int

Unique household ID number

HomeTAZ `pydantic-field`

HomeTAZ: int

Home transportation analysis zone

Income `pydantic-field`

Income: int | None = None

Annual household income ($2000)

PersonID `pydantic-field`

PersonID: int

Unique person ID number

PersonNum `pydantic-field`

PersonNum: int

Person number unique to the household

PersonType `pydantic-field`

PersonType: CTRAMPPersonType

Person lifestage/employment type (1=Full-time worker; 2=Part-time worker; 3=University student; 4=Nonworker; 5=Retired; 6=Student of non-driving age; 7=Student of driving age; 8=Child too young for school)

PersonAge `pydantic-field`

PersonAge: int

Person age

EmploymentCategory `pydantic-field`

EmploymentCategory: CTRAMPEmploymentCategory

Employment category ("Full-time worker", "Part-time worker", "Not employed")

StudentCategory `pydantic-field`

StudentCategory: CTRAMPStudentCategory

Student category ("College or higher", "Grade or high school", "Not student")

WorkLocation `pydantic-field`

WorkLocation: int

Work location transportation analysis zone (1-1454, or 0 if no workplace is selected)

SchoolLocation `pydantic-field`

SchoolLocation: int

School location transportation analysis zone (1-1454, or 0 if no school is selected)

HomeSubZone `pydantic-field`

HomeSubZone: WalkToTransitSubZone | None = None

Walk to transit home sub-zone (0=cannot walk to transit; 1=short-walk; 2=long-walk)

SchoolSubZone `pydantic-field`

SchoolSubZone: WalkToTransitSubZone | None = None

Walk to transit school sub-zone (0=cannot walk to transit; 1=short-walk; 2=long-walk)

WorkSubZone `pydantic-field`

WorkSubZone: WalkToTransitSubZone | None = None

Walk to transit work sub-zone (0=cannot walk to transit; 1=short-walk; 2=long-walk)

IndividualTourCTRAMPModel `pydantic-model`

Individual tours from Travel Model (CT-RAMP format).

Fields:

hh_id (int)
person_id (int)
person_num (int)
person_type (CTRAMPPersonType)
tour_id (int)
tour_category (CTRAMPTourCategory)
tour_purpose (CTRAMPPurpose)
orig_taz (int)
dest_taz (int)
start_hour (int)
end_hour (int)
tour_mode (CTRAMPModeType)
atWork_freq (int)
num_ob_stops (int)
num_ib_stops (int)
sampleRate (float | None)
avAvailable (int | None)
dest_walk_segment (WalkToTransitSubZone | None)
orig_walk_segment (WalkToTransitSubZone | None)
dcLogsum (float | None)
origTaxiWait (float | None)
destTaxiWait (float | None)
origSingleTNCWait (float | None)
destSingleTNCWait (float | None)
origSharedTNCWait (float | None)
destSharedTNCWait (float | None)
tour_weight (float | None)

atWork_freq `pydantic-field`

atWork_freq: int

Number of at work sub-tours (non-zero only for work tours)

sampleRate `pydantic-field`

sampleRate: float | None = None

This tour represents 1/sampleRate tours, calculate from weights as 1/weight

avAvailable `pydantic-field`

avAvailable: int | None = None

Autonomous vehicle available, added in Travel Model 1.5