Skip to content

Enumerations

Data Model Enumerated Variables

Instructions: modify these enumerated variables as needed for your ActivitySim implementation.

AreaType

Bases: IntEnum

Provide an integer mapping for area type, which serves as a proxy for urban form.

Source code in enums.py 
72
73
74
75
76
77
78
79
80
class AreaType(IntEnum):
    """
    Provide an integer mapping for area type, which serves as a proxy for urban form.
    """

    CBD = 1
    URBAN = 2
    SUBURBAN = 3
    RURAL = 4

DailyActivityPattern

Bases: IntEnum

Provides an integer mapping to the daily activity pattern variable.

Source code in enums.py 
48
49
50
51
52
53
54
55
class DailyActivityPattern(IntEnum):
    """
    Provides an integer mapping to the daily activity pattern variable.
    """

    MANDATORY = 1
    NON_MANDATORY = 2
    HOME = 3

Gender

Bases: IntEnum

Provides an integer mapping for gender.

Source code in enums.py 
25
26
27
28
29
30
31
32
class Gender(IntEnum):
    """
    Provides an integer mapping for gender.
    """

    MALE = 1
    FEMALE = 2
    OTHER = 3

Mode

Bases: IntEnum

Provides an integer mapping for travel mode.

Source code in enums.py 
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
class Mode(IntEnum):
    """
    Provides an integer mapping for travel mode.
    """

    DRIVE_ALONE_FREE = 1
    DRIVE_ALONE_PAY = 2
    SHARED_RIDE_2_FREE = 3
    SHARED_RIDE_2_PAY = 4
    SHARED_RIDE_3_FREE = 5
    SHARED_RIDE_3_PAY = 6
    WALK = 7
    BICYCLE = 8
    WALK_TO_TRANSIT_ALL = 9
    WALK_TO_TRANSIT_PREMIUM_ONLY = 10
    PARK_AND_RIDE_TRANSIT_ALL = 11
    PARK_AND_RIDE_TRANSIT_PREMIUM_ONLY = 12
    KISS_AND_RIDE_TRANSIT_ALL = 13
    KISS_AND_RIDE_TRANSIT_PREMIUM_ONLY = 14
    SCHOOL_BUS = 15

ModelTime

Bases: IntEnum

Provides an integer mapping from military time to model time interval index. The name represents the starting point of the interval. So the interval from 3:00 am to 3:30 am is represented by index 1, which is named ZERO_THREE.

Source code in enums.py 
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
class ModelTime(IntEnum):
    """
    Provides an integer mapping from military time to model time interval index.
    The name represents the starting point of the interval. So the interval from
    3:00 am to 3:30 am is represented by index 1, which is named `ZERO_THREE`.
    """

    ZERO_THREE = 1
    ZERO_THREE_THIRTY = 2
    ZERO_FOUR = 3
    ZERO_FOUR_THIRTY = 4
    ZERO_FIVE = 5
    ZERO_FIVE_THIRTY = 6
    ZERO_SIX = 7
    ZERO_SIX_THIRTY = 8
    ZERO_SEVEN = 9
    ZERO_SEVEN_THIRTY = 10
    ZERO_EIGHT = 11
    ZERO_EIGHT_THIRTY = 12
    ZERO_NINE = 13
    ZERO_NINE_THIRTY = 14
    TEN = 15
    TEN_THIRTY = 16
    ELEVEN = 17
    ELEVEN_THIRTY = 18
    TWELVE = 19
    TWELVE_THIRTY = 20
    THIRTEEN = 21
    THIRTEEN_THIRTY = 22
    FOURTEEN = 23
    FOURTEEN_THIRTY = 24
    FIFTEEN = 25
    FIFTEEN_THIRTY = 26
    SIXTEEN = 27
    SIXTEEN_THIRTY = 28
    SEVENTEEN = 29
    SEVENTEEN_THIRTY = 30
    EIGHTEEN = 31
    EIGHTEEN_THIRTY = 32
    NINETEEN = 33
    NINETEEN_THIRTY = 34
    TWENTY = 35
    TWENTY_THIRTY = 36
    TWENTY_ONE = 37
    TWENTY_ONE_THIRTY = 38
    TWENTY_TWO = 39
    TWENTY_TWO_THIRTY = 40
    TWENTY_THREE = 41
    TWENTY_THREE_THIRTY = 42

Occupation

Bases: IntEnum

Provides an integer mapping for a persons occupation.

Source code in enums.py 
35
36
37
38
39
40
41
42
43
44
45
class Occupation(IntEnum):
    """
    Provides an integer mapping for a persons occupation.
    """

    WHITE_COLLAR = 1
    SERVICES = 2
    HEALTH = 3
    RETAIL = 4
    BLUE_COLLAR = 5
    NOT_EMPLOYED = 6

PersonType

Bases: IntEnum

Provides integer mapping to the person type variable. A person type is used as a co-variate in numerous ActivitySim modules to explain behavior.

Source code in enums.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
class PersonType(IntEnum):
    """
    Provides integer mapping to the person type variable. A person type is
    used as a co-variate in numerous ActivitySim modules to explain behavior.
    """

    FULL_TIME_WORKER = 1
    PART_TIME_WORKER = 2
    ADULT_STUDENT = 3
    NON_WORKING_ADULT = 4
    RETIRED = 5
    SECONDARY_SCHOOL_STUDENT = 6
    PRIMARY_SCHOOL_STUDENT = 7
    PRE_SCHOOL_CHILD = 8

Purpose

Bases: IntEnum

Provides an integer mapping for trip and tour purpose.

Source code in enums.py 
58
59
60
61
62
63
64
65
66
67
68
69
class Purpose(IntEnum):
    """
    Provides an integer mapping for trip and tour purpose.
    """

    WORK = 1
    ADULT_SCHOOL = 2
    CHILD_SCHOOL = 3
    SHOPPING = 4
    ESCORT = 5
    MAINTENANCE = 6
    DISCRETIONARY = 7