Simulation Controls
SimulationSettings
Bases: PrettyModel
Source code in passengersim/config/simulation_controls.py
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 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 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 |
|
base_date
class-attribute
instance-attribute
The default date used to compute relative times for travel.
Future enhancements may include multi-day modeling.
burn_samples
class-attribute
instance-attribute
The number of samples to burn when starting each trial.
Burned samples are used to populate a stable history of data to support forecasting and optimization algorithms, but are not used to evaluate performance results.
See Counting Simulations for more details.
controller_time_zone
class-attribute
instance-attribute
The reference time zone for the controller (seconds relative to UTC).
Data collection points will be trigger at approximately midnight in this time zone.
This value can be input in hours instead of seconds, any absolute value less than or equal to 12 will be assumed to be hours and scaled to seconds.
The default value is -6 hours, or US Central Standard Time.
dcp_hour
class-attribute
instance-attribute
The hour of the day that the RM recalculation events are triggered.
If set to zero, the events happen at midnight. Other values can delay the recalculation into later in the night (or the next day).
demand_multiplier
class-attribute
instance-attribute
Scale all demand by this value.
Setting to a value other than 1.0 will increase or decrease all demand inputs uniformly by the same multiplicative amount. This is helpful when exploring how simulation results vary when you have "low demand" scenarios (e.g, demand_multiplier = 0.8), or "high demand" scenarios (e.g., demand multiplier = 1.1).
disable_ap
class-attribute
instance-attribute
Remove all advance purchase settings used in the simulation.
This applies to all airlines and all fare products.
double_capacity_until
class-attribute
instance-attribute
Double the capacity on all legs until this sample.
The extra capacity may reduce the statistical noise of untruncation
within the burn period and allow the simulation to achieve a stable
steady state faster. If used, this should be set to a value at least
26 below the burn_samples
value to avoid polluting the results.
dwm_lite
class-attribute
instance-attribute
Use the "lite" decision window model.
The structure of this model is the same as that use by Boeing.
manual_paths
class-attribute
instance-attribute
The user has provided explicit paths and connections.
If set to False, the automatic path generation algorithm is applied.
max_connect_time
class-attribute
instance-attribute
Maximum connection time for automatically generated paths.
Any generated path that has a connection time greater than this value (expressed in minutes) is invalidated.
mkt_k_factor
class-attribute
instance-attribute
Market-level randomness factor.
This factor controls the level of correlation in demand levels across origin- destination markets.
See k-factors for more details.
num_samples
class-attribute
instance-attribute
The number of samples to run within each trial.
Each sample represents one "typical" day of travel. See Counting Simulations for more details.
num_trials
class-attribute
instance-attribute
The overall number of trials to run.
Each trial is a complete simulation, including burn-in training time as well as study time. It will have a number of sequentially developed samples, each of which represents one "typical" day of travel.
See Counting Simulations for more details.
pax_type_k_factor
class-attribute
instance-attribute
Passenger-type randomness factor.
This factor controls the level of correlation in demand levels across passenger types.
See k-factors for more details.
random_seed
class-attribute
instance-attribute
Integer used to control the reproducibility of simulation results.
A seed is base value used by a pseudo-random generator to generate random numbers. A fixed random seed is used to ensure the same randomness pattern is reproducible and does not change between simulation runs, i.e. allows subsequent runs to be conducted with the same randomness pattern as a previous one. Any value set here will allow results to be repeated.
The random number generator is re-seeded at the beginning of every sample in every trial with a fixed tuple of three values: this "global" random seed, plus the sample number and trial number. This ensures that partial results are also reproducible: the simulation of sample 234 in trial 2 will be the same regardless of how many samples are in trial 1.
show_progress_bar
class-attribute
instance-attribute
Show a progress bar while running.
The progress display requires rich
is installed.
simple_k_factor
class-attribute
instance-attribute
Passenger-type randomness factor.
This factor add uncorrelated variance to every demand.
See k-factors for more details.
sys_k_factor
class-attribute
instance-attribute
System-level randomness factor.
This factor controls the level of correlation in demand levels across the entire system.
See k-factors for more details.
tf_k_factor
class-attribute
instance-attribute
Time frame randomness factor.
This factor controls the dispersion of bookings over time, given a previously identified level of total demand. See k-factors for more details.
tf_z_factor
class-attribute
instance-attribute
Timeframe demand variance control.
This factor scales the variance in the allocation of total demand to the various arrival timeframes.
See k-factors for more details.
timeframe_demand_allocation
class-attribute
instance-attribute
Which algorithm to use for time frame demand allocation.
tot_z_factor
class-attribute
instance-attribute
Base level demand variance control.
This factor scales the variance in the amount of total demand for any given market segment.
See k-factors for more details.