TheoreticalSimulation
A class for performing theoretical simulations of reforms.
This class inherits from TheoreticalSimulator and provides methods for simulating variables of interest, simulating a reform, and simulating multiple reforms.
Attributes:
Name | Type | Description |
---|---|---|
logger |
Logger
|
A logger for logging messages. |
Source code in bozio_wasmer_simulations/simulation/theoretical/base.py
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 |
|
base_case_simulation
base_case_simulation(tax_benefit_system: TaxBenefitSystem, year: int, list_var_simul: List[str]) -> DataFrame
Performs a simulation on the base case.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
tax_benefit_system |
TaxBenefitSystem
|
The tax-benefit system to use for the simulation. |
required |
year |
int
|
The year for which the simulation is performed. |
required |
list_var_simul |
List[str]
|
A list of variables to simulate. |
required |
Returns:
Type | Description |
---|---|
DataFrame
|
A dataframe containing the results of the simulation. |
Source code in bozio_wasmer_simulations/simulation/theoretical/base.py
core_simulation
Simulates the variables of interest.
Initializes the simulation case, initializes the tax-benefit system, simulates the variables, postprocesses the simulated variables, and preprocesses the allegement base.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
year |
int
|
The year for which the simulation is being performed. |
required |
simulation_step_smic |
float
|
The step size for the simulation, as a multiple of the SMIC value. |
required |
simulation_max_smic |
float
|
The maximum value for the simulation, as a multiple of the SMIC value. |
required |
Returns:
Type | Description |
---|---|
DataFrame
|
The simulated data. |
Source code in bozio_wasmer_simulations/simulation/theoretical/base.py
init_base_case
Initializes a base case for simulation.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
year |
int
|
The year for which the simulation is performed. |
required |
simulation_step_smic |
float
|
The step size for the simulation, as a multiple of the SMIC value. |
required |
simulation_max_smic |
float
|
The maximum value for the simulation, as a multiple of the SMIC value. |
required |
Source code in bozio_wasmer_simulations/simulation/theoretical/base.py
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 |
|
iterate_reform_simulations
iterate_reform_simulations(scenarios: dict, year: int, simulation_step_smic: float, simulation_max_smic: float) -> DataFrame
Simulates multiple reforms.
Iterates over the scenarios and simulates each reform. Concatenates the simulated data for all reforms.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
scenarios |
dict
|
The scenarios to simulate. |
required |
year |
int
|
The year for which the simulation is being performed. |
required |
simulation_step_smic |
float
|
The step size for the simulation, as a multiple of the SMIC value. |
required |
simulation_max_smic |
float
|
The maximum value for the simulation, as a multiple of the SMIC value. |
required |
Returns:
Type | Description |
---|---|
DataFrame
|
The simulated data for all reforms. |
Source code in bozio_wasmer_simulations/simulation/theoretical/base.py
plot
plot(data: DataFrame, x: str, hue: Union[str, List[str]], x_label: Optional[Union[str, None]] = None, y_label: Optional[Union[str, None]] = None, hue_label: Optional[Union[str, None]] = None, labels: Optional[Dict[str, str]] = {}, export_key: Optional[Union[PathLike, None]] = None, show: Optional[bool] = True) -> None
Plots the results of the simulation.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
data |
DataFrame
|
The data to plot. |
required |
x |
str
|
The variable to use for the x-axis. |
required |
hue |
Union[str, List[str]]
|
The variable(s) to use for the hue. |
required |
x_label |
Optional[Union[str, None]]
|
The label for the x-axis. Defaults to None. |
None
|
y_label |
Optional[Union[str, None]]
|
The label for the y-axis. Defaults to None. |
None
|
hue_label |
Optional[Union[str, None]]
|
The label for the hue. Defaults to None. |
None
|
labels |
Optional[Dict[str, str]]
|
A dictionary of labels to apply to the data. Defaults to {}. |
{}
|
export_key |
Optional[Union[PathLike, None]]
|
The path to save the plot to. Defaults to None. |
None
|
show |
Optional[bool]
|
Whether to display the plot. Defaults to True. |
True
|
Returns:
Type | Description |
---|---|
None
|
None |
Source code in bozio_wasmer_simulations/simulation/theoretical/base.py
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 |
|
simulate_reform
simulate_reform(name: str, reform_params: dict, year: int, simulation_step_smic: float, simulation_max_smic: float) -> DataFrame
Simulates a reform.
Initializes the simulation case, initializes the tax-benefit system, applies the reform, simulates the variables, and preprocesses the allegement base.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
The name of the reform. |
required |
reform_params |
dict
|
The parameters of the reform. |
required |
year |
int
|
The year for which the simulation is being performed. |
required |
simulation_step_smic |
float
|
The step size for the simulation, as a multiple of the SMIC value. |
required |
simulation_max_smic |
float
|
The maximum value for the simulation, as a multiple of the SMIC value. |
required |
Returns:
Type | Description |
---|---|
DataFrame
|
The simulated data. |
Source code in bozio_wasmer_simulations/simulation/theoretical/base.py
value_smic
Calculates the value of the SMIC for the given year.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
year |
int
|
The year for which the SMIC value is calculated. |
required |
Returns:
Type | Description |
---|---|
float
|
The value of the SMIC for the given year. |