job-shop-lib 0.5.0__tar.gz → 1.0.0__tar.gz

{job_shop_lib-0.5.0 → job_shop_lib-1.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: job-shop-lib
-Version: 0.5.0
+Version: 1.0.0
 Summary: An easy-to-use and modular Python library for the Job Shop Scheduling Problem (JSSP)
 License: MIT
 Author: Pabloo22
@@ -12,47 +12,86 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Provides-Extra: pygraphviz
-Requires-Dist: imageio (>=2,<3)
+Requires-Dist: gymnasium (>=0.29.1,<0.30.0)
+Requires-Dist: imageio[ffmpeg] (>=2.34.1,<3.0.0)
 Requires-Dist: matplotlib (>=3,<4)
 Requires-Dist: networkx (>=3,<4)
 Requires-Dist: numpy (>=1.26.4,<2.0.0)
-Requires-Dist: ortools (>=9.9,<9.10)
+Requires-Dist: ortools (>=9.9,<10.0)
 Requires-Dist: pyarrow (>=15.0.0,<16.0.0)
 Requires-Dist: pygraphviz (>=1.12,<2.0) ; extra == "pygraphviz"
 Description-Content-Type: text/markdown
 
 <div align="center">
 
-<img src="images/logo_with_transparent_background.png" height="150px">
+<img src="docs/source/images/jslib_minimalist_logo_no_background_fixed.png" height="150px">
 
-<h1>Job Shop Library</h1>
+<h1>JobShopLib</h1>
 
 [![Tests](https://github.com/Pabloo22/job_shop_lib/actions/workflows/tests.yaml/badge.svg)](https://github.com/Pabloo22/job_shop_lib/actions/workflows/tests.yaml)
+[![Documentation Status](https://readthedocs.org/projects/job-shop-lib/badge/?version=latest)](https://job-shop-lib.readthedocs.io/en/latest/?badge=latest)
 ![Python versions](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-blue)
 [![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 </div>
 
-An easy-to-use and modular Python library for the Job Shop Scheduling Problem (JSSP) with a special focus on graph representations.
+JobShopLib is a Python package for creating, solving, and visualizing job shop scheduling problems (JSSP).
 
-It provides intuitive data structures to represent instances and solutions, as well as solvers and visualization tools.
+It follows a modular design, allowing users to easily extend the library with new solvers, dispatching rules, visualization functions, etc.
 
-See the [this](https://colab.research.google.com/drive/1XV_Rvq1F2ns6DFG8uNj66q_rcowwTZ4H?usp=sharing) Google Colab notebook for a quick start guide! 
+See the [documentation](https://job-shop-lib.readthedocs.io/en/latest/) for more details about the latest version.
 
-## Installation
+## Installation :package:
 
-You can install the library from PyPI:
+<!-- start installation -->
+
+JobShopLib is distributed on [PyPI](https://pypi.org/project/job-shop-lib/) and it supports Python 3.10+.
+
+You can install the latest stable version (version 0.5.1) using `pip`:
 
 ```bash
 pip install job-shop-lib
 ```
 
-## Quick Start :rocket:
+See [this](https://colab.research.google.com/drive/1XV_Rvq1F2ns6DFG8uNj66q_rcowwTZ4H?usp=sharing) Google Colab notebook for a quick start guide! 
+
+
+There is a [documentation page](https://job-shop-lib.readthedocs.io/en/latest/) for versions 1.0.0a3 and onward. See see the [latest pull requests](https://github.com/Pabloo22/job_shop_lib/pulls?q=is%3Apr+is%3Aclosed) for the latest changes.
+
+<!-- end installation -->
+
+<!-- key features -->
+
+## Key Features :star:
+
+- **Data Structures**: Easily create, manage, and manipulate job shop instances and solutions with user-friendly data structures. See [Getting Started](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/tutorial/00-Getting-Started.ipynb) and [How Solutions are Represented](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/tutorial/01-How-Solutions-are-Represented.ipynb).
+
+- **Benchmark Instances**: Load well-known benchmark instances directly from the library without manual downloading. See [Load Benchmark Instances](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/examples/05-Load-Benchmark-Instances.ipynb).
+
+- **Random Instance Generation**: Create random instances with customizable sizes and properties or augment existing ones. See [`generation`](job_shop_lib/generation) package.
+
+- **Multiple Solvers**:
+  - **Constraint Programming Solver**: OR-Tools' CP-SAT solver. See [Solving the Problem](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/tutorial/02-Solving-the-Problem.ipynb).
+
+  - **Dispatching Rule Solvers**: Use any of the available dispatching rules or create custom ones. See [Dispatching Rules](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/examples/03-Dispatching-Rules.ipynb).
+
+- **Gantt Charts**: Visualize final schedules and how are they created iteratively by dispatching rule solvers or sequences of scheduling decisions with GIFs or videos. See [Save Gif](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/examples/06-Save-Gif.ipynb).
+
+- **Graph Representations**:
+  - **Disjunctive Graphs**: Represent and visualize instances as disjunctive graphs. See [Disjunctive Graph](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/examples/04-Disjunctive-Graph.ipynb).
+  - **Agent-Task Graphs**: Encode instances as agent-task graphs (introduced in [ScheduleNet paper](https://arxiv.org/abs/2106.03051)). See [Agent-Task Graph](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/examples/07-Agent-Task-Graph.ipynb).
+  - Build your own custom graphs with the `JobShopGraph` class.
+
+- **Gymnasium Environments**: Two environments for solving the problem with graph neural networks (GNNs) or any other method, and reinforcement learning (RL). See [SingleJobShopGraphEnv](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/examples/09-SingleJobShopGraphEnv.ipynb) and [MultiJobShopGraphEnv](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/examples/10-MultiJobShopGraphEnv.ipynb).
+
+<!-- end key features -->
+
+## Some Examples :rocket:
 
 ### Create a Job Shop Instance
 
-You can create a Job Shop Instance by defining the jobs and operations. An operation is defined by the machine(s) it is processed on and the duration (processing time).
+You can create a `JobShopInstance` by defining the jobs and operations. An operation is defined by the machine(s) it is processed on and the duration (processing time).
 
 ```python
 from job_shop_lib import JobShopInstance, Operation
@@ -83,7 +122,7 @@ from job_shop_lib.benchmarking import load_benchmark_instance
 ft06 = load_benchmark_instance("ft06")
 ```
 
-The module `benchmarks` contains functions to load the instances from the file and return them as `JobShopInstance` objects without having to download them
+The module `benchmarking` contains functions to load the instances from the file and return them as `JobShopInstance` objects without having to download them
 manually.
 
 The contributions to this benchmark dataset are as follows:
@@ -115,12 +154,12 @@ https://github.com/thomasWeise/jsspInstancesAndResults
 
 ### Generate a Random Instance
 
-You can also generate a random instance with the `BasicGenerator` class.
+You can also generate a random instance with the `GeneralInstanceGenerator` class.
 
 ```python
-from job_shop_lib.generators import BasicGenerator
+from job_shop_lib.generation import GeneralInstanceGenerator
 
-generator = BasicGenerator(
+generator = GeneralInstanceGenerator(
     duration_range=(5, 10), seed=42, num_jobs=5, num_machines=5
 )
 random_instance = generator.generate()
@@ -129,7 +168,7 @@ random_instance = generator.generate()
 This class can also work as an iterator to generate multiple instances:
 
 ```python
-generator = BasicGenerator(iteration_limit=100, seed=42)
+generator = GeneralInstanceGenerator(iteration_limit=100, seed=42)
 instances = []
 for instance in generator:
     instances.append(instance)
@@ -145,7 +184,7 @@ Every solver is a `Callable` that receives a `JobShopInstance` and returns a `Sc
 ```python
 import matplotlib.pyplot as plt
 
-from job_shop_lib.cp_sat import ORToolsSolver
+from job_shop_lib.constraint_programming import ORToolsSolver
 from job_shop_lib.visualization import plot_gantt_chart
 
 solver = ORToolsSolver(max_time_in_seconds=10)
@@ -154,7 +193,7 @@ ft06_schedule = solver(ft06)
 fig, ax = plot_gantt_chart(ft06_schedule)
 plt.show()
 ```
-![Example Gannt Chart](images/ft06_solution.png)
+![Example Gannt Chart](docs/source/images/ft06_solution.png)
 
 ### Solve an Instance with a Dispatching Rule Solver
 
@@ -190,7 +229,7 @@ create_gif(
 )
 ```
 
-![Example Gif](examples/ft06_optimized.gif)
+![Example Gif](docs/source/examples/output/ft06_optimized.gif)
 
 The dashed red line represents the current time step, which is computed as the earliest time when the next operation can start.
 
@@ -200,7 +239,7 @@ The dashed red line represents the current time step, which is computed as the e
 
 ### Representing Instances as Graphs
 
-One of the main purposes of this library is to provide an easy way to encode instances as graphs. This can be very useful, not only for visualization purposes but also for developing Graph Neural Network-based algorithms.
+One of the main purposes of this library is to provide an easy way to encode instances as graphs. This can be very useful, not only for visualization purposes but also for developing graph neural network-based algorithms.
 
 A graph is represented by the `JobShopGraph` class, which internally stores a `networkx.DiGraph` object.
 
@@ -208,7 +247,7 @@ A graph is represented by the `JobShopGraph` class, which internally stores a `n
 
 The disjunctive graph is created by first adding nodes representing each operation in the jobs, along with two special nodes: a source $S$ and a sink $T$. Each operation node is linked to the next operation in its job sequence by **conjunctive edges**, forming a path from the source to the sink. These edges represent the order in which operations of a single job must be performed.
 
-Additionally, the graph includes **disjunctive edges** between operations that use the same machine but belong to different jobs. These edges are bidirectional, indicating that either of the connected operations can be performed first. The disjunctive edges thus represent the scheduling choices available: the order in which operations sharing a machine can be processed. Solving the Job Shop Scheduling problem involves choosing a direction for each disjunctive edge such that the overall processing time is minimized.
+Additionally, the graph includes **disjunctive edges** between operations that use the same machine but belong to different jobs. These edges are bidirectional, indicating that either of the connected operations can be performed first. The disjunctive edges thus represent the scheduling choices available: the order in which operations sharing a machine can be processed. Solving the job shop scheduling problem involves choosing a direction for each disjunctive edge such that the overall processing time is minimized.
 
 ```python
 from job_shop_lib.visualization import plot_disjunctive_graph
@@ -217,11 +256,11 @@ fig = plot_disjunctive_graph(instance)
 plt.show()
 ```
 
-![Example Disjunctive Graph](images/example_disjunctive_graph.png)
+![Example Disjunctive Graph](docs/source/images/example_disjunctive_graph.png)
 
 
-> [!WARNING]
-> This plot function requires having the optional dependency [PyGraphViz](https://pygraphviz.github.io/) installed.
+> [!TIP]
+> Installing the optional dependency [PyGraphViz](https://pygraphviz.github.io/) is recommended.
 
 The `JobShopGraph` class provides easy access to the nodes, for example, to get all the nodes of a specific type:
 
@@ -250,9 +289,9 @@ Other attributes include:
 - `nodes_by_machine`: A nested list mapping each machine to its associated operation nodes, aiding in machine-specific analysis.
 - `nodes_by_job`: Similar to `nodes_by_machine`, but maps jobs to their operation nodes, useful for job-specific traversal.
 
-#### Agent-Task Graph
+#### Resource-Task Graph
 
-Introduced in the paper "ScheduleNet: Learn to solve multi-agent scheduling problems with reinforcement learning" by [Park et al. (2021)](https://arxiv.org/abs/2106.03051), the Agent-Task Graph is a graph that represents the scheduling problem as a multi-agent reinforcement learning problem.
+Introduced in the paper "ScheduleNet: Learn to solve multi-agent scheduling problems with reinforcement learning" by [Park et al. (2021)](https://arxiv.org/abs/2106.03051), the resource-task graph (orginally named "agent-task graph") is a graph that represents the scheduling problem as a multi-agent reinforcement learning problem.
 
 In contrast to the disjunctive graph, instead of connecting operations
 that share the same resources directly by disjunctive edges, operation
@@ -263,66 +302,59 @@ from the same job are connected by non-directed edges too.
 
 ```python
 from job_shop_lib.graphs import (
-    build_complete_agent_task_graph,
-    build_agent_task_graph_with_jobs,
-    build_agent_task_graph,
+    build_complete_resource_task_graph,
+    build_resource_task_graph_with_jobs,
+    build_resource_task_graph,
 )
-from job_shop_lib.visualization import plot_agent_task_graph
+from job_shop_lib.visualization import plot_resource_task_graph
 
-complete_agent_task_graph = build_complete_agent_task_graph(instance)
+complete_resource_task_graph = build_complete_resource_task_graph(instance)
 
-fig = plot_agent_task_graph(complete_agent_task_graph)
+fig = plot_resource_task_graph(complete_agent_task_graph)
 plt.show()
 ```
 
 <div align="center">
-<img src="examples/agent_task_graph.png" width="300">
+<img src="docs/source/examples/output/agent_task_graph.png" width="300">
 </div>
 <br>
 
 ----
 
+The library generalizes this graph by allowing the addition of job nodes and a global one (see `build_resource_task_graph_with_jobs` and `build_resource_task_graph`).
+
 For more details, check the [examples](examples) folder.
 
 ## Installation for development
 
-### With Poetry
+<!-- start installation development -->
 
 1. Clone the repository.
 
-2. Install [poetry](https://python-poetry.org/docs/) if you don't have it already:
-```bash
-pip install poetry==1.7
-```
-3. Create the virtual environment:
 ```bash
-poetry shell
+git clone https://github.com/Pabloo22/job_shop_lib.git
+cd job_shop_lib
 ```
-4. Install dependencies:
+
+2. Install [poetry](https://python-poetry.org/docs/) if you don't have it already:
+
 ```bash
-poetry install --with notebooks --with test --with lint --all-extras
+pip install poetry
 ```
-or equivalently:
+
+3. Install dependencies:
 ```bash
 make poetry_install_all 
 ```
 
-### With PyPI
-
-If you don't want to use Poetry, you can install the library directly from the source code:
-
-```bash
-git clone https://github.com/Pabloo22/job_shop_lib.git
-cd job_shop_lib
-pip install -e .
-```
+<!-- end installation development -->
 
-## License
+## License :scroll:
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
 
-## References
+## References :books:
 
  - J. Adams, E. Balas, and D. Zawack, "The shifting bottleneck procedure
      for job shop scheduling," Management Science, vol. 34, no. 3,

{job_shop_lib-0.5.0 → job_shop_lib-1.0.0}/README.md

@@ -1,35 +1,73 @@
 <div align="center">
 
-<img src="images/logo_with_transparent_background.png" height="150px">
+<img src="docs/source/images/jslib_minimalist_logo_no_background_fixed.png" height="150px">
 
-<h1>Job Shop Library</h1>
+<h1>JobShopLib</h1>
 
 [![Tests](https://github.com/Pabloo22/job_shop_lib/actions/workflows/tests.yaml/badge.svg)](https://github.com/Pabloo22/job_shop_lib/actions/workflows/tests.yaml)
+[![Documentation Status](https://readthedocs.org/projects/job-shop-lib/badge/?version=latest)](https://job-shop-lib.readthedocs.io/en/latest/?badge=latest)
 ![Python versions](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-blue)
 [![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 </div>
 
-An easy-to-use and modular Python library for the Job Shop Scheduling Problem (JSSP) with a special focus on graph representations.
+JobShopLib is a Python package for creating, solving, and visualizing job shop scheduling problems (JSSP).
 
-It provides intuitive data structures to represent instances and solutions, as well as solvers and visualization tools.
+It follows a modular design, allowing users to easily extend the library with new solvers, dispatching rules, visualization functions, etc.
 
-See the [this](https://colab.research.google.com/drive/1XV_Rvq1F2ns6DFG8uNj66q_rcowwTZ4H?usp=sharing) Google Colab notebook for a quick start guide! 
+See the [documentation](https://job-shop-lib.readthedocs.io/en/latest/) for more details about the latest version.
 
-## Installation
+## Installation :package:
 
-You can install the library from PyPI:
+<!-- start installation -->
+
+JobShopLib is distributed on [PyPI](https://pypi.org/project/job-shop-lib/) and it supports Python 3.10+.
+
+You can install the latest stable version (version 0.5.1) using `pip`:
 
 ```bash
 pip install job-shop-lib
 ```
 
-## Quick Start :rocket:
+See [this](https://colab.research.google.com/drive/1XV_Rvq1F2ns6DFG8uNj66q_rcowwTZ4H?usp=sharing) Google Colab notebook for a quick start guide! 
+
+
+There is a [documentation page](https://job-shop-lib.readthedocs.io/en/latest/) for versions 1.0.0a3 and onward. See see the [latest pull requests](https://github.com/Pabloo22/job_shop_lib/pulls?q=is%3Apr+is%3Aclosed) for the latest changes.
+
+<!-- end installation -->
+
+<!-- key features -->
+
+## Key Features :star:
+
+- **Data Structures**: Easily create, manage, and manipulate job shop instances and solutions with user-friendly data structures. See [Getting Started](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/tutorial/00-Getting-Started.ipynb) and [How Solutions are Represented](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/tutorial/01-How-Solutions-are-Represented.ipynb).
+
+- **Benchmark Instances**: Load well-known benchmark instances directly from the library without manual downloading. See [Load Benchmark Instances](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/examples/05-Load-Benchmark-Instances.ipynb).
+
+- **Random Instance Generation**: Create random instances with customizable sizes and properties or augment existing ones. See [`generation`](job_shop_lib/generation) package.
+
+- **Multiple Solvers**:
+  - **Constraint Programming Solver**: OR-Tools' CP-SAT solver. See [Solving the Problem](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/tutorial/02-Solving-the-Problem.ipynb).
+
+  - **Dispatching Rule Solvers**: Use any of the available dispatching rules or create custom ones. See [Dispatching Rules](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/examples/03-Dispatching-Rules.ipynb).
+
+- **Gantt Charts**: Visualize final schedules and how are they created iteratively by dispatching rule solvers or sequences of scheduling decisions with GIFs or videos. See [Save Gif](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/examples/06-Save-Gif.ipynb).
+
+- **Graph Representations**:
+  - **Disjunctive Graphs**: Represent and visualize instances as disjunctive graphs. See [Disjunctive Graph](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/examples/04-Disjunctive-Graph.ipynb).
+  - **Agent-Task Graphs**: Encode instances as agent-task graphs (introduced in [ScheduleNet paper](https://arxiv.org/abs/2106.03051)). See [Agent-Task Graph](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/examples/07-Agent-Task-Graph.ipynb).
+  - Build your own custom graphs with the `JobShopGraph` class.
+
+- **Gymnasium Environments**: Two environments for solving the problem with graph neural networks (GNNs) or any other method, and reinforcement learning (RL). See [SingleJobShopGraphEnv](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/examples/09-SingleJobShopGraphEnv.ipynb) and [MultiJobShopGraphEnv](https://github.com/Pabloo22/job_shop_lib/blob/main/docs/source/examples/10-MultiJobShopGraphEnv.ipynb).
+
+<!-- end key features -->
+
+## Some Examples :rocket:
 
 ### Create a Job Shop Instance
 
-You can create a Job Shop Instance by defining the jobs and operations. An operation is defined by the machine(s) it is processed on and the duration (processing time).
+You can create a `JobShopInstance` by defining the jobs and operations. An operation is defined by the machine(s) it is processed on and the duration (processing time).
 
 ```python
 from job_shop_lib import JobShopInstance, Operation
@@ -60,7 +98,7 @@ from job_shop_lib.benchmarking import load_benchmark_instance
 ft06 = load_benchmark_instance("ft06")
 ```
 
-The module `benchmarks` contains functions to load the instances from the file and return them as `JobShopInstance` objects without having to download them
+The module `benchmarking` contains functions to load the instances from the file and return them as `JobShopInstance` objects without having to download them
 manually.
 
 The contributions to this benchmark dataset are as follows:
@@ -92,12 +130,12 @@ https://github.com/thomasWeise/jsspInstancesAndResults
 
 ### Generate a Random Instance
 
-You can also generate a random instance with the `BasicGenerator` class.
+You can also generate a random instance with the `GeneralInstanceGenerator` class.
 
 ```python
-from job_shop_lib.generators import BasicGenerator
+from job_shop_lib.generation import GeneralInstanceGenerator
 
-generator = BasicGenerator(
+generator = GeneralInstanceGenerator(
     duration_range=(5, 10), seed=42, num_jobs=5, num_machines=5
 )
 random_instance = generator.generate()
@@ -106,7 +144,7 @@ random_instance = generator.generate()
 This class can also work as an iterator to generate multiple instances:
 
 ```python
-generator = BasicGenerator(iteration_limit=100, seed=42)
+generator = GeneralInstanceGenerator(iteration_limit=100, seed=42)
 instances = []
 for instance in generator:
     instances.append(instance)
@@ -122,7 +160,7 @@ Every solver is a `Callable` that receives a `JobShopInstance` and returns a `Sc
 ```python
 import matplotlib.pyplot as plt
 
-from job_shop_lib.cp_sat import ORToolsSolver
+from job_shop_lib.constraint_programming import ORToolsSolver
 from job_shop_lib.visualization import plot_gantt_chart
 
 solver = ORToolsSolver(max_time_in_seconds=10)
@@ -131,7 +169,7 @@ ft06_schedule = solver(ft06)
 fig, ax = plot_gantt_chart(ft06_schedule)
 plt.show()
 ```
-![Example Gannt Chart](images/ft06_solution.png)
+![Example Gannt Chart](docs/source/images/ft06_solution.png)
 
 ### Solve an Instance with a Dispatching Rule Solver
 
@@ -167,7 +205,7 @@ create_gif(
 )
 ```
 
-![Example Gif](examples/ft06_optimized.gif)
+![Example Gif](docs/source/examples/output/ft06_optimized.gif)
 
 The dashed red line represents the current time step, which is computed as the earliest time when the next operation can start.
 
@@ -177,7 +215,7 @@ The dashed red line represents the current time step, which is computed as the e
 
 ### Representing Instances as Graphs
 
-One of the main purposes of this library is to provide an easy way to encode instances as graphs. This can be very useful, not only for visualization purposes but also for developing Graph Neural Network-based algorithms.
+One of the main purposes of this library is to provide an easy way to encode instances as graphs. This can be very useful, not only for visualization purposes but also for developing graph neural network-based algorithms.
 
 A graph is represented by the `JobShopGraph` class, which internally stores a `networkx.DiGraph` object.
 
@@ -185,7 +223,7 @@ A graph is represented by the `JobShopGraph` class, which internally stores a `n
 
 The disjunctive graph is created by first adding nodes representing each operation in the jobs, along with two special nodes: a source $S$ and a sink $T$. Each operation node is linked to the next operation in its job sequence by **conjunctive edges**, forming a path from the source to the sink. These edges represent the order in which operations of a single job must be performed.
 
-Additionally, the graph includes **disjunctive edges** between operations that use the same machine but belong to different jobs. These edges are bidirectional, indicating that either of the connected operations can be performed first. The disjunctive edges thus represent the scheduling choices available: the order in which operations sharing a machine can be processed. Solving the Job Shop Scheduling problem involves choosing a direction for each disjunctive edge such that the overall processing time is minimized.
+Additionally, the graph includes **disjunctive edges** between operations that use the same machine but belong to different jobs. These edges are bidirectional, indicating that either of the connected operations can be performed first. The disjunctive edges thus represent the scheduling choices available: the order in which operations sharing a machine can be processed. Solving the job shop scheduling problem involves choosing a direction for each disjunctive edge such that the overall processing time is minimized.
 
 ```python
 from job_shop_lib.visualization import plot_disjunctive_graph
@@ -194,11 +232,11 @@ fig = plot_disjunctive_graph(instance)
 plt.show()
 ```
 
-![Example Disjunctive Graph](images/example_disjunctive_graph.png)
+![Example Disjunctive Graph](docs/source/images/example_disjunctive_graph.png)
 
 
-> [!WARNING]
-> This plot function requires having the optional dependency [PyGraphViz](https://pygraphviz.github.io/) installed.
+> [!TIP]
+> Installing the optional dependency [PyGraphViz](https://pygraphviz.github.io/) is recommended.
 
 The `JobShopGraph` class provides easy access to the nodes, for example, to get all the nodes of a specific type:
 
@@ -227,9 +265,9 @@ Other attributes include:
 - `nodes_by_machine`: A nested list mapping each machine to its associated operation nodes, aiding in machine-specific analysis.
 - `nodes_by_job`: Similar to `nodes_by_machine`, but maps jobs to their operation nodes, useful for job-specific traversal.
 
-#### Agent-Task Graph
+#### Resource-Task Graph
 
-Introduced in the paper "ScheduleNet: Learn to solve multi-agent scheduling problems with reinforcement learning" by [Park et al. (2021)](https://arxiv.org/abs/2106.03051), the Agent-Task Graph is a graph that represents the scheduling problem as a multi-agent reinforcement learning problem.
+Introduced in the paper "ScheduleNet: Learn to solve multi-agent scheduling problems with reinforcement learning" by [Park et al. (2021)](https://arxiv.org/abs/2106.03051), the resource-task graph (orginally named "agent-task graph") is a graph that represents the scheduling problem as a multi-agent reinforcement learning problem.
 
 In contrast to the disjunctive graph, instead of connecting operations
 that share the same resources directly by disjunctive edges, operation
@@ -240,66 +278,59 @@ from the same job are connected by non-directed edges too.
 
 ```python
 from job_shop_lib.graphs import (
-    build_complete_agent_task_graph,
-    build_agent_task_graph_with_jobs,
-    build_agent_task_graph,
+    build_complete_resource_task_graph,
+    build_resource_task_graph_with_jobs,
+    build_resource_task_graph,
 )
-from job_shop_lib.visualization import plot_agent_task_graph
+from job_shop_lib.visualization import plot_resource_task_graph
 
-complete_agent_task_graph = build_complete_agent_task_graph(instance)
+complete_resource_task_graph = build_complete_resource_task_graph(instance)
 
-fig = plot_agent_task_graph(complete_agent_task_graph)
+fig = plot_resource_task_graph(complete_agent_task_graph)
 plt.show()
 ```
 
 <div align="center">
-<img src="examples/agent_task_graph.png" width="300">
+<img src="docs/source/examples/output/agent_task_graph.png" width="300">
 </div>
 <br>
 
 ----
 
+The library generalizes this graph by allowing the addition of job nodes and a global one (see `build_resource_task_graph_with_jobs` and `build_resource_task_graph`).
+
 For more details, check the [examples](examples) folder.
 
 ## Installation for development
 
-### With Poetry
+<!-- start installation development -->
 
 1. Clone the repository.
 
-2. Install [poetry](https://python-poetry.org/docs/) if you don't have it already:
-```bash
-pip install poetry==1.7
-```
-3. Create the virtual environment:
 ```bash
-poetry shell
+git clone https://github.com/Pabloo22/job_shop_lib.git
+cd job_shop_lib
 ```
-4. Install dependencies:
+
+2. Install [poetry](https://python-poetry.org/docs/) if you don't have it already:
+
 ```bash
-poetry install --with notebooks --with test --with lint --all-extras
+pip install poetry
 ```
-or equivalently:
+
+3. Install dependencies:
 ```bash
 make poetry_install_all 
 ```
 
-### With PyPI
-
-If you don't want to use Poetry, you can install the library directly from the source code:
-
-```bash
-git clone https://github.com/Pabloo22/job_shop_lib.git
-cd job_shop_lib
-pip install -e .
-```
+<!-- end installation development -->
 
-## License
+## License :scroll:
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
 
-## References
+## References :books:
 
  - J. Adams, E. Balas, and D. Zawack, "The shifting bottleneck procedure
      for job shop scheduling," Management Science, vol. 34, no. 3,

job_shop_lib-1.0.0/job_shop_lib/__init__.py

@@ -0,0 +1,32 @@
+"""Contains the main data structures and base classes.
+
+.. autosummary::
+    :nosignatures:
+
+    Operation
+    JobShopInstance
+    ScheduledOperation
+    Schedule
+    Solver
+    BaseSolver
+
+"""
+
+from job_shop_lib._operation import Operation
+from job_shop_lib._job_shop_instance import JobShopInstance
+from job_shop_lib._scheduled_operation import ScheduledOperation
+from job_shop_lib._schedule import Schedule
+from job_shop_lib._base_solver import BaseSolver, Solver
+
+
+__version__ = "1.0.0"
+
+__all__ = [
+    "Operation",
+    "JobShopInstance",
+    "ScheduledOperation",
+    "Schedule",
+    "Solver",
+    "BaseSolver",
+    "__version__",
+]

job_shop_lib-0.5.0/job_shop_lib/base_solver.py → job_shop_lib-1.0.0/job_shop_lib/_base_solver.py

@@ -33,5 +33,5 @@ class BaseSolver(abc.ABC):
         schedule = self.solve(instance)
         elapsed_time = time_start - time.perf_counter()
         schedule.metadata["elapsed_time"] = elapsed_time
-        schedule.metadata["solved_by"] = f"{self.__class__.__name__}"
+        schedule.metadata["solved_by"] = self.__class__.__name__
         return schedule