Skip to content

Outputs

OutputConfig

Bases: PrettyModel

Source code in passengersim/config/outputs.py
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, ...]] = {
        "fare_class_mix",
        "load_factors",
        "bookings_by_timeframe",
        "total_demand",
    }
    """Reports to include."""

excel class-attribute instance-attribute

excel: pathlib.Path | None = None

Write excel outputs to this file after a run.

log_reports class-attribute instance-attribute

log_reports: bool = False

Write basic reports directly to the run log.

reports class-attribute instance-attribute

reports: set[str | tuple[str, ...]] = {
    "fare_class_mix",
    "load_factors",
    "bookings_by_timeframe",
    "total_demand",
}

Reports to include.