Skip to content

Summary Results

This subpackage is for defining the SimulationTables class and its items.

The SimulationTables class is a container for summary tables and figures that are extracted from a Simulation object after it has been run.

Each item in the SimulationTables class is defined by a SimulationTableItem instance, which specifies how to extract and aggregate the summary data. Each of these is defined in a separate module in this subpackage. Within each module, the SimulationTableItem instance is created using the .generic.SimulationTable_add_item() function.

SimulationTables

Bases: *(subclasses())

Container for summary tables and figures extracted from a Simulation.

This class is a subclass of GenericSimulationTables, which is defined in the generic module. It lists the items that are available in the SimulationTables class, and provides type hints and (optionally, but ideally) documentation for the data that is stored in each item.

Source code in passengersim/summaries/__init__.py 
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
class SimulationTables(*GenericSimulationTables.subclasses()):
    """Container for summary tables and figures extracted from a Simulation.

    This class is a subclass of GenericSimulationTables, which is defined in
    the generic module.  It lists the items that are available in the
    SimulationTables class, and provides type hints and (optionally, but
    ideally) documentation for the data that is stored in each item.
    """

    __final__ = True

    def __repr__(self) -> str:
        """Includes information about what data is stored in this summary."""
        table_keys = []
        for k, v in self._data.items():
            table_keys.append(f"* {k} ({_describe_type(v)})")
        for k, v in self._callback_data.items():
            table_keys.append(f"* callback_data.{k} ({_describe_type(v)})")
        if self._file_store is not None:
            for k in self._file_store:
                if not k.startswith("_") and k not in self._data:
                    table_keys.append(f"* {k} (available in file storage)")
                if k == "_callback_data_" and not self._callback_data:
                    table_keys.append("* callback_data (available in file storage)")
        if table_keys:
            table_info = " " + "\n ".join(table_keys)
        else:
            table_info = " (no tables)"
        try:
            timestamp = self.metadata("time.created")
        except KeyError:
            time_created = ""
        else:
            date_string = datetime.fromisoformat(timestamp).strftime("%Y-%m-%d")
            time_created = f" created on {date_string}"
        return f"<passengersim.summaries.SimulationTables{time_created}>\n" f"{table_info}\n<*>"

    def dashboard(self):
        """Return a dashboard object for this SimulationTables instance."""
        from .dashboard import default_dashboard

        return default_dashboard(self)

__final__ class-attribute instance-attribute 

__final__ = True

__repr__ 

__repr__() -> str

Includes information about what data is stored in this summary.

Source code in passengersim/summaries/__init__.py 
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
def __repr__(self) -> str:
    """Includes information about what data is stored in this summary."""
    table_keys = []
    for k, v in self._data.items():
        table_keys.append(f"* {k} ({_describe_type(v)})")
    for k, v in self._callback_data.items():
        table_keys.append(f"* callback_data.{k} ({_describe_type(v)})")
    if self._file_store is not None:
        for k in self._file_store:
            if not k.startswith("_") and k not in self._data:
                table_keys.append(f"* {k} (available in file storage)")
            if k == "_callback_data_" and not self._callback_data:
                table_keys.append("* callback_data (available in file storage)")
    if table_keys:
        table_info = " " + "\n ".join(table_keys)
    else:
        table_info = " (no tables)"
    try:
        timestamp = self.metadata("time.created")
    except KeyError:
        time_created = ""
    else:
        date_string = datetime.fromisoformat(timestamp).strftime("%Y-%m-%d")
        time_created = f" created on {date_string}"
    return f"<passengersim.summaries.SimulationTables{time_created}>\n" f"{table_info}\n<*>"

dashboard 

dashboard()

Return a dashboard object for this SimulationTables instance.

Source code in passengersim/summaries/__init__.py 
94
95
96
97
98
def dashboard(self):
    """Return a dashboard object for this SimulationTables instance."""
    from .dashboard import default_dashboard

    return default_dashboard(self)