local_and_flow_yields¶

passengersim.database.common_queries.local_and_flow_yields(cnx: Database, *, scenario: str = None, burn_samples: int = 100) → DataFrame[source]¶

Compute yields for local (nonstop) and flow (connecting) passengers.

This query requires that the simulation was run while recording path class details (i.e. with the pathclass or pathclass_final flags set on Config.db.write_items).

Parameters:

cnx : Database¶

scenario : str, optional¶

burn_samples : int, default 100¶

The yields will be computed ignoring this many samples from the beginning of each trial.

Returns:

pandas.DataFrame