Skip to content

compare_systems

compare_systems

compare_systems(frames: dict[str, DataFrame]) -> DataFrame

Stack system_profile across many systems into a comparison table.

Parameters:

Name Type Description Default
frames dict of str -> pandas.DataFrame

{system_id: availability_frame} (e.g. built from fetch_multiple).

required

Returns:

Type Description
DataFrame

One row per system (index system_id), one column per profile metric.

See Also

system_profile : The per-system profile this stacks. concentration_metrics : Add an inequality lens per system.

Examples:

>>> import pandas as pd
>>> a = pd.DataFrame({"num_bikes_available": [5], "num_docks_available": [5]})
>>> b = pd.DataFrame({"num_bikes_available": [2], "num_docks_available": [8]})
>>> compare_systems({"sys_a": a, "sys_b": b}).index.tolist()
['sys_a', 'sys_b']
Source code in src/gbfs_toolkit/analytics/distribution.py
def compare_systems(frames: dict[str, pd.DataFrame]) -> pd.DataFrame:
    """Stack [`system_profile`][gbfs_toolkit.system_profile] across many systems into a comparison table.

    Parameters
    ----------
    frames : dict of str -> pandas.DataFrame
        ``{system_id: availability_frame}`` (e.g. built from
        [`fetch_multiple`][gbfs_toolkit.fetch_multiple]).

    Returns
    -------
    pandas.DataFrame
        One row per system (index ``system_id``), one column per profile metric.

    See Also
    --------
    [`system_profile`][gbfs_toolkit.system_profile] : The per-system profile this stacks.
    [`concentration_metrics`][gbfs_toolkit.concentration_metrics] : Add an inequality lens per system.

    Examples
    --------
    >>> import pandas as pd
    >>> a = pd.DataFrame({"num_bikes_available": [5], "num_docks_available": [5]})
    >>> b = pd.DataFrame({"num_bikes_available": [2], "num_docks_available": [8]})
    >>> compare_systems({"sys_a": a, "sys_b": b}).index.tolist()
    ['sys_a', 'sys_b']
    """
    rows = {sid: system_profile(av) for sid, av in frames.items()}
    out = pd.DataFrame(rows).T
    out.index.name = "system_id"
    return out