job-shop-lib 0.5.1__py3-none-any.whl → 1.0.0a1__py3-none-any.whl

job_shop_lib/visualization/create_gif.py

@@ -1,209 +0,0 @@
-"""Module for creating a GIF of the schedule being built by a
-dispatching rule solver."""
-
-import os
-import pathlib
-import shutil
-from collections.abc import Callable
-
-import imageio
-import matplotlib.pyplot as plt
-from matplotlib.figure import Figure
-
-from job_shop_lib import JobShopInstance, Schedule, Operation
-from job_shop_lib.dispatching import (
-    DispatchingRuleSolver,
-    Dispatcher,
-    HistoryTracker,
-)
-from job_shop_lib.visualization.gantt_chart import plot_gantt_chart
-
-
-# Most of the arguments are optional with default values. There is no way to
-# reduce the number of arguments without losing functionality.
-# pylint: disable=too-many-arguments
-def create_gif(
-    gif_path: str,
-    instance: JobShopInstance,
-    solver: DispatchingRuleSolver,
-    plot_function: (
-        Callable[[Schedule, int, list[Operation] | None, int | None], Figure]
-        | None
-    ) = None,
-    fps: int = 1,
-    remove_frames: bool = True,
-    frames_dir: str | None = None,
-    plot_current_time: bool = True,
-) -> None:
-    """Creates a GIF of the schedule being built by the given solver.
-
-    Args:
-        gif_path:
-            The path to save the GIF file. It should end with ".gif".
-        instance:
-            The instance of the job shop problem to be scheduled.
-        solver:
-            The dispatching rule solver to use.
-        plot_function:
-            A function that plots a Gantt chart for a schedule. It
-            should take a `Schedule` object and the makespan of the schedule as
-            input and return a `Figure` object. If not provided, a default
-            function is used.
-        fps:
-            The number of frames per second in the GIF.
-        remove_frames:
-            Whether to remove the frames after creating the GIF.
-        frames_dir:
-            The directory to save the frames in. If not provided,
-            `gif_path.replace(".gif", "") + "_frames"` is used.
-        plot_current_time:
-            Whether to plot a vertical line at the current time.
-    """
-    if plot_function is None:
-        plot_function = plot_gantt_chart_wrapper()
-
-    if frames_dir is None:
-        # Use the name of the GIF file as the directory name
-        frames_dir = gif_path.replace(".gif", "") + "_frames"
-    path = pathlib.Path(frames_dir)
-    path.mkdir(exist_ok=True)
-    frames_dir = str(path)
-    create_gantt_chart_frames(
-        frames_dir, instance, solver, plot_function, plot_current_time
-    )
-    create_gif_from_frames(frames_dir, gif_path, fps)
-
-    if remove_frames:
-        shutil.rmtree(frames_dir)
-
-
-def plot_gantt_chart_wrapper(
-    title: str | None = None,
-    cmap: str = "viridis",
-    show_available_operations: bool = False,
-) -> Callable[[Schedule, int, list[Operation] | None, int | None], Figure]:
-    """Returns a function that plots a Gantt chart for an unfinished schedule.
-
-    Args:
-        title: The title of the Gantt chart.
-        cmap: The name of the colormap to use.
-        show_available_operations:
-            Whether to show the available operations in the Gantt chart.
-
-    Returns:
-        A function that plots a Gantt chart for a schedule. The function takes
-        the following arguments:
-        - schedule: The schedule to plot.
-        - makespan: The makespan of the schedule.
-        - available_operations: A list of available operations. If None,
-            the available operations are not shown.
-        - current_time: The current time in the schedule. If provided, a
-            red vertical line is plotted at this time.
-    """
-
-    def plot_function(
-        schedule: Schedule,
-        makespan: int,
-        available_operations: list | None = None,
-        current_time: int | None = None,
-    ) -> Figure:
-        fig, ax = plot_gantt_chart(
-            schedule, title=title, cmap_name=cmap, xlim=makespan
-        )
-
-        if show_available_operations and available_operations is not None:
-
-            operations_text = "\n".join(
-                str(operation) for operation in available_operations
-            )
-            text = f"Available operations:\n{operations_text}"
-            # Print the available operations at the bottom right corner
-            # of the Gantt chart
-            fig.text(
-                1.25,
-                0.05,
-                text,
-                ha="right",
-                va="bottom",
-                transform=ax.transAxes,
-                bbox={
-                    "facecolor": "white",
-                    "alpha": 0.5,
-                    "boxstyle": "round,pad=0.5",
-                },
-            )
-        if current_time is not None:
-            ax.axvline(current_time, color="red", linestyle="--")
-        return fig
-
-    return plot_function
-
-
-def create_gantt_chart_frames(
-    frames_dir: str,
-    instance: JobShopInstance,
-    solver: DispatchingRuleSolver,
-    plot_function: Callable[
-        [Schedule, int, list[Operation] | None, int | None], Figure
-    ],
-    plot_current_time: bool = True,
-) -> None:
-    """Creates frames of the Gantt chart for the schedule being built.
-
-    Args:
-        frames_dir:
-            The directory to save the frames in.
-        instance:
-            The instance of the job shop problem to be scheduled.
-        solver:
-            The dispatching rule solver to use.
-        plot_function:
-            A function that plots a Gantt chart for a schedule. It
-            should take a `Schedule` object and the makespan of the schedule as
-            input and return a `Figure` object.
-        plot_current_time:
-            Whether to plot a vertical line at the current time.
-    """
-    dispatcher = Dispatcher(instance, pruning_function=solver.pruning_function)
-    history_tracker = HistoryTracker(dispatcher)
-    makespan = solver.solve(instance, dispatcher).makespan()
-    dispatcher.unsubscribe(history_tracker)
-    dispatcher.reset()
-    for i, scheduled_operation in enumerate(history_tracker.history, start=1):
-        dispatcher.dispatch(
-            scheduled_operation.operation, scheduled_operation.machine_id
-        )
-        current_time = (
-            None if not plot_current_time else dispatcher.current_time()
-        )
-        fig = plot_function(
-            dispatcher.schedule,
-            makespan,
-            dispatcher.available_operations(),
-            current_time,
-        )
-        _save_frame(fig, frames_dir, i)
-
-
-def _save_frame(figure: Figure, frames_dir: str, number: int) -> None:
-    figure.savefig(f"{frames_dir}/frame_{number:02d}.png", bbox_inches="tight")
-    plt.close(figure)
-
-
-def create_gif_from_frames(frames_dir: str, gif_path: str, fps: int) -> None:
-    """Creates a GIF from the frames in the given directory.
-
-    Args:
-        frames_dir:
-            The directory containing the frames to be used in the GIF.
-        gif_path:
-            The path to save the GIF file. It should end with ".gif".
-        fps:
-            The number of frames per second in the GIF.
-    """
-    frames = [
-        os.path.join(frames_dir, frame)
-        for frame in sorted(os.listdir(frames_dir))
-    ]
-    images = [imageio.imread(frame) for frame in frames]
-    imageio.mimsave(gif_path, images, fps=fps, loop=0)

job_shop_lib-0.5.1.dist-info/RECORD

@@ -1,52 +0,0 @@
-job_shop_lib/__init__.py,sha256=S1847nzbTzRPlh1bkZrsNi7ljGiDkVTGMqodFtPSgBo,582
-job_shop_lib/base_solver.py,sha256=WCNWVcGGVIV7V2WlTZKcNFsq_BpY4UdhEbYVZ8X3LrE,1368
-job_shop_lib/benchmarking/__init__.py,sha256=u1P5sP7GCXzPHMYwtqaOfyh9Pvpp9tLaPxyrLYtDk0s,3354
-job_shop_lib/benchmarking/benchmark_instances.json,sha256=F9EvyzFwVxiKAN6rQTsrMhsKstmyUmroyWduM7a00KQ,464841
-job_shop_lib/benchmarking/load_benchmark.py,sha256=CjiSALutgWcfD-SDU6w9WO3udvPVpl_-moab3vagbaw,5625
-job_shop_lib/cp_sat/__init__.py,sha256=DqrF9IewFMkVB5BhFOHhlJvG6w6BW4ecxBXySunGLoU,97
-job_shop_lib/cp_sat/ortools_solver.py,sha256=zsISUQy0dQvn7bmUsAQBCe-V92CFskJHkSfngSP4KSg,8130
-job_shop_lib/dispatching/__init__.py,sha256=xk6NjndZ4-EH5G_fGSEX4LQEXL53TRYn5dKEb5uFggI,1568
-job_shop_lib/dispatching/dispatcher.py,sha256=3WdShJtVMP4ZBeoOIegelTXziJLpEjtonAku21yqr20,19299
-job_shop_lib/dispatching/dispatching_rule_solver.py,sha256=fbNfSclH6Jw1F-QGY1oxAj9wm2hHhJHGnsF2HateXX8,4669
-job_shop_lib/dispatching/dispatching_rules.py,sha256=SIDkPx_1uTkM0loEqGMqotLBBSaGi1gH0WS85GXrT_I,5557
-job_shop_lib/dispatching/factories.py,sha256=ldyIbz3QuLuDkrqbgJXV6YoM6AV6CKyHu8z4hXLG2Vo,7267
-job_shop_lib/dispatching/feature_observers/__init__.py,sha256=j7GXFCKK0mLjGc3M6bw2vePZaLyou_9BUjlHtAMriHc,1023
-job_shop_lib/dispatching/feature_observers/composite_feature_observer.py,sha256=wLd5yirDekg_pFrBPWIyxKou8htimvKhtDbz0cJ8SKE,3302
-job_shop_lib/dispatching/feature_observers/duration_observer.py,sha256=EMSfRsWkx94VeOF6v1f2s73hrEQ696vkFoWVVw5tWZ8,3804
-job_shop_lib/dispatching/feature_observers/earliest_start_time_observer.py,sha256=pKrxaLOPHMnf-eniDhkPWVzzRpKLnpbXAeORqEmsrp0,6296
-job_shop_lib/dispatching/feature_observers/factory.py,sha256=XF5spNp8T-dnPPnpWQ5dxuG7vrHLf-Wb8MP1tn4_BXA,1941
-job_shop_lib/dispatching/feature_observers/feature_observer.py,sha256=q2i50LOhgjaQtu_0-3VlSH64uHcf73JddjcGijeKCVk,3646
-job_shop_lib/dispatching/feature_observers/is_completed_observer.py,sha256=6UCxp-QLXxbw_1nppQJuG_qZZvjtGugYTxQdPTcIcgo,4086
-job_shop_lib/dispatching/feature_observers/is_ready_observer.py,sha256=km75Pa8vd55grjvr7X-8e0K9vfxVWfms1ea6kAesKLo,1405
-job_shop_lib/dispatching/feature_observers/is_scheduled_observer.py,sha256=PeLxPVLJX_TP4TG8ViEQFR8WS43wIp6CqyuapM8lIt8,1477
-job_shop_lib/dispatching/feature_observers/position_in_job_observer.py,sha256=PEC-WwcyeHL8WOACElImDtAAoaf7MroaD9x5QlQddVE,1344
-job_shop_lib/dispatching/feature_observers/remaining_operations_observer.py,sha256=yVde9gC0cheFNCoPa1lFgGSmzyew-zOGA98nZpBBw1I,1891
-job_shop_lib/dispatching/history_tracker.py,sha256=3jSh7pKEGiOcEK6bXK8AQJK4NtASxTknRjmHRKenxt8,649
-job_shop_lib/dispatching/pruning_functions.py,sha256=d94_uBHuESp4NSf_jBk1q8eBCfTPuU9meiL3StiqJiA,4378
-job_shop_lib/exceptions.py,sha256=0Wla1lK6E2u1o3t2hJj9hUwyoJ-1ebkXd42GdXFAhV0,899
-job_shop_lib/generation/__init__.py,sha256=ezuxKMYoldiDsD4YzUOXfL1SSv2gSkZig0dOlytIvlM,292
-job_shop_lib/generation/general_instance_generator.py,sha256=Xy2OKZBfCCgiu1Ewi6WbD047zc1Kt_JQqULTdRXwTJI,6698
-job_shop_lib/generation/instance_generator.py,sha256=nudWpr0k88WIW-JcWjqUioy-1RJXj4auxPaGWWgrHOc,4183
-job_shop_lib/generation/transformations.py,sha256=FI2qHrETATJUrQP3-RYhZAQ5boyEZ0CF2StDbacBej8,5290
-job_shop_lib/generators/__init__.py,sha256=L1e1OhPKwYi5TKhbnJ9ZeqVuhVzw0ZMfKsHHXUgEMpE,199
-job_shop_lib/generators/basic_generator.py,sha256=rPDhwkj2KAK9iUgexgDxC4aUqzi2NS4CKEQduvvlXyg,7683
-job_shop_lib/generators/transformations.py,sha256=FI2qHrETATJUrQP3-RYhZAQ5boyEZ0CF2StDbacBej8,5290
-job_shop_lib/graphs/__init__.py,sha256=mWyF0MypyYfvFhy2F93BJkFIVsxS_0ZqvPuc29B7TJg,1454
-job_shop_lib/graphs/build_agent_task_graph.py,sha256=ktj-oNLUPmWHfL81EVyaoF4hXClWYfnN7oG2Nn4pOsg,7128
-job_shop_lib/graphs/build_disjunctive_graph.py,sha256=z1jiuTTaWPJZj-vSZdo064quGx4LEDKjtZIb1FieZW4,3705
-job_shop_lib/graphs/constants.py,sha256=dqPF--okue5sF70Iv-YR14QKFx4pxPwT2dL1Rh5jylM,374
-job_shop_lib/graphs/job_shop_graph.py,sha256=B0buqcg7US6UvIRWsoY8_FwqzPa_nVjnBu7hPIrygUo,7404
-job_shop_lib/graphs/node.py,sha256=FrSndtvqgRbN69jIcU6q1TkBh-LOGg8sxxYjDZqCcf4,5613
-job_shop_lib/job_shop_instance.py,sha256=awEZ-xKM4yPlD4gE8SdfQdt68CWX_R3IebeVY8ST4bs,16376
-job_shop_lib/operation.py,sha256=S61x0xgu09JLwrRp7syd1P2psbl0ByGuK_hHoHp4ng8,3916
-job_shop_lib/schedule.py,sha256=aODGwMv9slFIqOTCz2hF_EIpXhddz8-iAH5gSzGO5G8,10393
-job_shop_lib/scheduled_operation.py,sha256=qzXzat1dQBbQ-sLyoG1iXbF9eWbdFeZDFjhAFVavHPk,3526
-job_shop_lib/visualization/__init__.py,sha256=Kxjk3ERYXPAHR72nkD92gFdJltSLA2kxLZrlZzZJS8o,693
-job_shop_lib/visualization/agent_task_graph.py,sha256=G-c9eiawz6m9sdnDM1r-ZHz6K-gYDIAreHpb6pkYE7w,8284
-job_shop_lib/visualization/create_gif.py,sha256=aUB_2ChyFNo4KuKiQl2ANYmVB5NFcGb7pxKeqr0CVJQ,7186
-job_shop_lib/visualization/disjunctive_graph.py,sha256=pg4KG9BfQbnBPnXYgbyPGe0AuHSmhYqPeqWYAf_spWQ,5905
-job_shop_lib/visualization/gantt_chart.py,sha256=B9sn4XrEUqgQhRKju-1VUG5R67AZXRu7jbrtA8VcndU,4412
-job_shop_lib-0.5.1.dist-info/LICENSE,sha256=9mggivMGd5taAu3xbmBway-VQZMBzurBGHofFopvUsQ,1069
-job_shop_lib-0.5.1.dist-info/METADATA,sha256=tkuyY-WKxm_FEy55v45Y7PMzssZxyxXFHvPujssZj6Q,12582
-job_shop_lib-0.5.1.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-job_shop_lib-0.5.1.dist-info/RECORD,,