Function plot_instance

pyvrp/plotting/plot_instance.py:9–33

Plots client coordinate, time window and demand data of the given instance. Parameters ---------- data Data instance. fig Optional Figure to draw on. One will be created if not provided.

(data: ProblemData, fig: plt.Figure | None = None)

def plot_instance(data: ProblemData, fig: plt.Figure | None = None):
    """
    Plots client coordinate, time window and demand data of the given instance.

    Parameters
    ----------
    data
        Data instance.
    fig
        Optional Figure to draw on. One will be created if not provided.
    """
    if not fig:
        fig = plt.figure(figsize=(20, 12))

    # Uses a GridSpec instance to lay-out all subplots nicely. There are
    # two columns: left and right. Left has two rows: the first plots time
    # windows and the second plots demands. The right column plots the
    # client and depot locations on a grid.
    gs = fig.add_gridspec(2, 2, width_ratios=(2 / 5, 3 / 5))

    plot_time_windows(data, ax=fig.add_subplot(gs[0, 0]))
    plot_demands(data, ax=fig.add_subplot(gs[1, 0]))
    plot_coordinates(data, ax=fig.add_subplot(gs[:, 1]))

    plt.tight_layout()