HtmlOutputConfig¶

class passengersim.config.outputs.HtmlOutputConfig[source]¶

Bases: PrettyModel

Configuration for HTML outputs.

Attributes:

filename	Write HTML outputs to this file after a run.
title	Title of the HTML report.
carrier_revenues	Include carrier revenues in the HTML report.
carrier_total_bookings	Include carrier total bookings in the HTML report.
carrier_revenue_distribution	Include carrier revenue distribution in the HTML report.
carrier_load_factors	Include carrier load factors in the HTML report.
carrier_yields	Include carrier yields in the HTML report.
carrier_rasm	Include carrier RASM in the HTML report.
carrier_local_share	Include carrier local share in the HTML report.
fare_class_mix	Include fare class mix in the HTML report.
bookings_by_timeframe	Include bookings by timeframe in the HTML report.
leg_load_factor_distribution	Include leg load factor distribution in the HTML report.
bid_price_history	Include bid price history in the HTML report.
displacement_history	Include displacement history in the HTML report.
carrier_table	Include carrier table in the HTML report.
segmentation_by_timeframe_table	Include segmentation by timeframe table in the HTML report.
other
configs	Include these configuration items in the HTML report.
metadata	Include simulation run metadata in the HTML report.

filename : Path | bool | None¶

Write HTML outputs to this file after a run.

If this is None or False, no HTML outputs will be written. If True, HTML outputs will be written to a standard named file after a run, or give the exact filename of the file to be written.

title : str | None¶

Title of the HTML report.

If this is None, the title will be the scenario name.

carrier_revenues : bool¶

Include carrier revenues in the HTML report.

carrier_total_bookings : bool¶

Include carrier total bookings in the HTML report.

carrier_revenue_distribution : bool¶

Include carrier revenue distribution in the HTML report.

carrier_load_factors : bool¶

Include carrier load factors in the HTML report.

carrier_yields : bool¶

Include carrier yields in the HTML report.

carrier_rasm : bool¶

Include carrier RASM in the HTML report.

carrier_local_share : bool¶

Include carrier local share in the HTML report.

fare_class_mix : bool¶

Include fare class mix in the HTML report.

This figure is always by carrier.

bookings_by_timeframe : bool | list[str]¶

Include bookings by timeframe in the HTML report.

If this is a list of strings, include only the specified carriers.

leg_load_factor_distribution : bool¶

Include leg load factor distribution in the HTML report.

bid_price_history : bool¶

Include bid price history in the HTML report.

displacement_history : bool¶

Include displacement history in the HTML report.

carrier_table : bool¶

Include carrier table in the HTML report.

segmentation_by_timeframe_table : bool¶

Include segmentation by timeframe table in the HTML report.

other : list[str | tuple[str, dict]]¶

configs : list[str]¶

Include these configuration items in the HTML report.

metadata : bool¶

Include simulation run metadata in the HTML report.