Skip to content

Outputs

HtmlOutputConfig

Bases: PrettyModel

Configuration for HTML outputs.

Source code in passengersim/config/outputs.py 
 8
 9
10
11
12
13
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
class HtmlOutputConfig(PrettyModel, extra="forbid", validate_assignment=True):
    """Configuration for HTML outputs."""

    filename: pathlib.Path | None = None
    """Write HTML outputs to this file after a run.

    If this is None, no HTML outputs will be written."""

    title: str | None = None
    """Title of the HTML report.

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

    carrier_revenues: bool = True
    """Include carrier revenues in the HTML report."""

    carrier_total_bookings: bool = True
    """Include carrier total bookings in the HTML report."""

    carrier_revenue_distribution: bool = False
    """Include carrier revenue distribution in the HTML report."""

    carrier_load_factors: bool = True
    """Include carrier load factors in the HTML report."""

    carrier_yields: bool = True
    """Include carrier yields in the HTML report."""

    carrier_rasm: bool = True
    """Include carrier RASM in the HTML report."""

    carrier_local_share: bool = True
    """Include carrier local share in the HTML report."""

    fare_class_mix: bool = True
    """Include fare class mix in the HTML report.

    This figure is always by carrier."""

    bookings_by_timeframe: bool | list[str] = True
    """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 = True
    """Include leg load factor distribution in the HTML report."""

    bid_price_history: bool = True
    """Include bid price history in the HTML report."""

    displacement_history: bool = True
    """Include displacement history in the HTML report."""

    carrier_table: bool = True
    """Include carrier table in the HTML report."""

    segmentation_by_timeframe_table: bool = True
    """Include segmentation by timeframe table in the HTML report."""

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

    configs: list[str] = [
        "carriers",
        "rm_systems",
        "simulation_controls",
        "db",
        "outputs",
    ]
    """Include these configuration items in the HTML report."""

    metadata: bool = True
    """Include simulation run metadata in the HTML report."""

    def __bool__(self) -> bool:
        return self.filename is not None

bid_price_history class-attribute instance-attribute 

bid_price_history: bool = True

Include bid price history in the HTML report.

bookings_by_timeframe class-attribute instance-attribute 

bookings_by_timeframe: bool | list[str] = True

Include bookings by timeframe in the HTML report.

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

carrier_load_factors class-attribute instance-attribute 

carrier_load_factors: bool = True

Include carrier load factors in the HTML report.

carrier_local_share class-attribute instance-attribute 

carrier_local_share: bool = True

Include carrier local share in the HTML report.

carrier_rasm class-attribute instance-attribute 

carrier_rasm: bool = True

Include carrier RASM in the HTML report.

carrier_revenue_distribution class-attribute instance-attribute 

carrier_revenue_distribution: bool = False

Include carrier revenue distribution in the HTML report.

carrier_revenues class-attribute instance-attribute 

carrier_revenues: bool = True

Include carrier revenues in the HTML report.

carrier_table class-attribute instance-attribute 

carrier_table: bool = True

Include carrier table in the HTML report.

carrier_total_bookings class-attribute instance-attribute 

carrier_total_bookings: bool = True

Include carrier total bookings in the HTML report.

carrier_yields class-attribute instance-attribute 

carrier_yields: bool = True

Include carrier yields in the HTML report.

configs class-attribute instance-attribute 

configs: list[str] = [
    "carriers",
    "rm_systems",
    "simulation_controls",
    "db",
    "outputs",
]

Include these configuration items in the HTML report.

displacement_history class-attribute instance-attribute 

displacement_history: bool = True

Include displacement history in the HTML report.

fare_class_mix class-attribute instance-attribute 

fare_class_mix: bool = True

Include fare class mix in the HTML report.

This figure is always by carrier.

filename class-attribute instance-attribute 

filename: Path | None = None

Write HTML outputs to this file after a run.

If this is None, no HTML outputs will be written.

leg_load_factor_distribution class-attribute instance-attribute 

leg_load_factor_distribution: bool = True

Include leg load factor distribution in the HTML report.

metadata class-attribute instance-attribute 

metadata: bool = True

Include simulation run metadata in the HTML report.

other class-attribute instance-attribute 

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

segmentation_by_timeframe_table class-attribute instance-attribute 

segmentation_by_timeframe_table: bool = True

Include segmentation by timeframe table in the HTML report.

title class-attribute instance-attribute 

title: str | None = None

Title of the HTML report.

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

__bool__ 

__bool__() -> bool
Source code in passengersim/config/outputs.py 
81
82
def __bool__(self) -> bool:
    return self.filename is not None

OutputConfig

Bases: PrettyModel

Source code in passengersim/config/outputs.py 
 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
class OutputConfig(PrettyModel, extra="forbid", validate_assignment=True):
    log_reports: bool = False
    """Write basic reports directly to the run log."""

    excel: pathlib.Path | None = None
    """Write excel outputs to this file after a run."""

    reports: set[str | tuple[str, ...]] = set()
    """Reports to include.

    Database queries reports can be included here.  This is important for
    multiprocessing runs with in-memory databases, as database results will not
    be available after the database connection is closed in each subprocess.

    If this is a set containing only "*", all reports will be included; this
    may be computationally expensive.
    """

    html: HtmlOutputConfig = HtmlOutputConfig()
    """Configuration for HTML outputs."""

    pickle: pathlib.Path | None = None
    """Write a pickle of the SimulationTables output to this file after a run."""

    disk: bool | pathlib.Path | None = True
    """Write the SimulationTables output to this file after a run.

    This will use pxsim format, an efficient binary file that allows "lazy" file
    loading.  If set to `True`, the file will be named with the same name as
    the HTML output file, except with the extension `.pxsim`, unless there is no
    HTML output file, in which case no file will written.
    """

    def _get_disk_filename(self) -> pathlib.Path | None:
        """Get the filename for the disk output.

        If the disk output is set to `True`, this will return the filename of
        the HTML output file with the extension `.pxsim`.  If there is no HTML
        output file, this will return None.
        """
        if self.disk is True and self.html.filename is not None:
            return self.html.filename.with_suffix(".pxsim")
        elif isinstance(self.disk, pathlib.Path):
            return self.disk
        else:
            return None

    # TODO what reports require what database items?
    # e.g. demand_to_come requires we store all `demand` not just demand_final

    @field_serializer("reports", when_used="always")
    def serialize_reports(self, reports: set[str | tuple[str, ...]]) -> list[str | tuple[str, ...]]:
        # return a sorted list, first simple strings then tuples
        return sorted(reports, key=lambda x: (isinstance(x, tuple), x))

disk class-attribute instance-attribute 

disk: bool | Path | None = True

Write the SimulationTables output to this file after a run.

This will use pxsim format, an efficient binary file that allows "lazy" file loading. If set to True, the file will be named with the same name as the HTML output file, except with the extension .pxsim, unless there is no HTML output file, in which case no file will written.

excel class-attribute instance-attribute 

excel: Path | None = None

Write excel outputs to this file after a run.

html class-attribute instance-attribute 

html: HtmlOutputConfig = HtmlOutputConfig()

Configuration for HTML outputs.

log_reports class-attribute instance-attribute 

log_reports: bool = False

Write basic reports directly to the run log.

pickle class-attribute instance-attribute 

pickle: Path | None = None

Write a pickle of the SimulationTables output to this file after a run.

reports class-attribute instance-attribute 

reports: set[str | tuple[str, ...]] = set()

Reports to include.

Database queries reports can be included here. This is important for multiprocessing runs with in-memory databases, as database results will not be available after the database connection is closed in each subprocess.

If this is a set containing only "*", all reports will be included; this may be computationally expensive.

serialize_reports 

serialize_reports(
    reports: set[str | tuple[str, ...]],
) -> list[str | tuple[str, ...]]
Source code in passengersim/config/outputs.py 
135
136
137
138
@field_serializer("reports", when_used="always")
def serialize_reports(self, reports: set[str | tuple[str, ...]]) -> list[str | tuple[str, ...]]:
    # return a sorted list, first simple strings then tuples
    return sorted(reports, key=lambda x: (isinstance(x, tuple), x))