job-shop-lib 0.1.2__tar.gz → 0.1.3__tar.gz

{job_shop_lib-0.1.2 → job_shop_lib-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: job-shop-lib
-Version: 0.1.2
+Version: 0.1.3
 Summary: An easy-to-use and modular Python library for the Job Shop Scheduling Problem (JSSP)
 License: MIT
 Author: Pabloo22
@@ -16,7 +16,7 @@ Requires-Dist: imageio (>=2,<3)
 Requires-Dist: matplotlib (>=3,<4)
 Requires-Dist: networkx (>=3,<4)
 Requires-Dist: ortools (>=9,<10)
-Requires-Dist: pyarrow (>=14.0.0,<15.0.0)
+Requires-Dist: pyarrow (>=15.0.0,<16.0.0)
 Requires-Dist: pygraphviz (>=1.12,<2.0) ; extra == "pygraphviz"
 Description-Content-Type: text/markdown
 
@@ -37,9 +37,19 @@ Description-Content-Type: text/markdown
 
 An easy-to-use and modular Python library for the Job Shop Scheduling Problem (JSSP) with a special focus on graph representations.
 
-It provides intuitive data structures to represent instances and solutions, as well as solvers and visualization tools:
+It provides intuitive data structures to represent instances and solutions, as well as solvers and visualization tools.
 
-## Quick Start
+See the [this](https://colab.research.google.com/drive/1XV_Rvq1F2ns6DFG8uNj66q_rcowwTZ4H?usp=sharing) Google Colab notebook for a quick start guide! 
+
+## Installation
+
+You can install the library from PyPI:
+
+```bash
+pip install job-shop-lib
+```
+
+## Quick Start :rocket:
 
 ### Create a Job Shop Instance
 
@@ -79,40 +89,22 @@ manually. The instances are stored in [benchmark_instances.json](job_shop_lib/be
 
 The contributions to this benchmark dataset are as follows:
 
-- `abz5-9`: This subset, comprising five instances, was introduced by Adams et
-    al. (1988).
+- `abz5-9`: by Adams et al. (1988).
 
-- `ft06`, `ft10`, `ft20`: These three instances are attributed to the work of
-    Fisher and Thompson, as detailed in their 1963 work.
+- `ft06`, `ft10`, `ft20`: by Fisher and Thompson (1963).
 
-- `la01-40`: A collection of forty instances, this group was contributed by
-    Lawrence, as referenced in his 1984 report.
+- `la01-40`: by Lawrence (1984)
 
-- `orb01-10`: Ten instances in this category were provided by Applegate and
-    Cook, as seen in their 1991 study.
+- `orb01-10`: by Applegate and Cook (1991).
 
-- `swb01-20`: This segment, encompassing twenty instances, was contributed by
-    Storer et al., as per their 1992 article.
+- `swb01-20`: by Storer et al. (1992).
 
-- `yn1-4`: Yamada and Nakano are credited with the addition of four instances
-    in this group, as found in their 1992 paper.
+- `yn1-4`: by Yamada and Nakano (1992).
 
-- `ta01-80`: The largest contribution, consisting of eighty instances, was
-    made by Taillard, as documented in his 1993 paper.
+- `ta01-80`: by Taillard (1993).
 
 The metadata from these instances has been updated using data from:
-
-Thomas Weise. jsspInstancesAndResults. Accessed in January 2024.
-Available at: https://github.com/thomasWeise/jsspInstancesAndResults
-
-It includes the following information:
-  - "optimum" (`int` | `None`): The optimal makespan for the instance.
-  - "lower_bound" (`int`): The best lower bound known for the makespan. If
-      optimality is known, it is equal to the optimum.
-  - "upper_bound" (`int`): The best upper bound known for the makespan. If
-      optimality is known, it is equal to the optimum.
-  - "reference" (`str`): The paper or source where the instance was first
-      introduced.
+https://github.com/thomasWeise/jsspInstancesAndResults
 
 ```python
 >>> ft06.metadata
@@ -124,7 +116,7 @@ It includes the following information:
 
 ### Generate a Random Instance
 
-You can also generate a random instance with the `InstanceGenerator` class.
+You can also generate a random instance with the `BasicGenerator` class.
 
 ```python
 from job_shop_lib.generators import BasicGenerator
@@ -138,7 +130,7 @@ random_instance = generator.generate()
 This class can also work as an iterator to generate multiple instances:
 
 ```python
-generator = InstanceGenerator(iteration_limit=100, seed=42)
+generator = BasicGenerator(iteration_limit=100, seed=42)
 instances = []
 for instance in generator:
     instances.append(instance)
@@ -227,6 +219,9 @@ plt.show()
 ![Example Disjunctive Graph](images/example_disjunctive_graph.png)
 
 
+> [!WARNING]
+> This plot function requires having the optional dependency [PyGraphViz](https://pygraphviz.github.io/) installed.
+
 The `JobShopGraph` class provides easy access to the nodes, for example, to get all the nodes of a specific type:
 
 ```python
@@ -288,13 +283,9 @@ plt.show()
 
 For more details, check the [examples](examples) folder.
 
-## Installation
-
-In the future, the library will be available on PyPI. For now, you can install it from the source code.
-
-### For development
+## Installation for development
 
-#### With Poetry
+### With Poetry
 
 1. Clone the repository.
 
@@ -315,7 +306,7 @@ or equivalently:
 make poetry_install_all 
 ```
 
-#### With PyPI
+### With PyPI
 
 If you don't want to use Poetry, you can install the library directly from the source code:
 

{job_shop_lib-0.1.2 → job_shop_lib-0.1.3}/README.md

@@ -15,9 +15,19 @@
 
 An easy-to-use and modular Python library for the Job Shop Scheduling Problem (JSSP) with a special focus on graph representations.
 
-It provides intuitive data structures to represent instances and solutions, as well as solvers and visualization tools:
+It provides intuitive data structures to represent instances and solutions, as well as solvers and visualization tools.
 
-## Quick Start
+See the [this](https://colab.research.google.com/drive/1XV_Rvq1F2ns6DFG8uNj66q_rcowwTZ4H?usp=sharing) Google Colab notebook for a quick start guide! 
+
+## Installation
+
+You can install the library from PyPI:
+
+```bash
+pip install job-shop-lib
+```
+
+## Quick Start :rocket:
 
 ### Create a Job Shop Instance
 
@@ -57,40 +67,22 @@ manually. The instances are stored in [benchmark_instances.json](job_shop_lib/be
 
 The contributions to this benchmark dataset are as follows:
 
-- `abz5-9`: This subset, comprising five instances, was introduced by Adams et
-    al. (1988).
+- `abz5-9`: by Adams et al. (1988).
 
-- `ft06`, `ft10`, `ft20`: These three instances are attributed to the work of
-    Fisher and Thompson, as detailed in their 1963 work.
+- `ft06`, `ft10`, `ft20`: by Fisher and Thompson (1963).
 
-- `la01-40`: A collection of forty instances, this group was contributed by
-    Lawrence, as referenced in his 1984 report.
+- `la01-40`: by Lawrence (1984)
 
-- `orb01-10`: Ten instances in this category were provided by Applegate and
-    Cook, as seen in their 1991 study.
+- `orb01-10`: by Applegate and Cook (1991).
 
-- `swb01-20`: This segment, encompassing twenty instances, was contributed by
-    Storer et al., as per their 1992 article.
+- `swb01-20`: by Storer et al. (1992).
 
-- `yn1-4`: Yamada and Nakano are credited with the addition of four instances
-    in this group, as found in their 1992 paper.
+- `yn1-4`: by Yamada and Nakano (1992).
 
-- `ta01-80`: The largest contribution, consisting of eighty instances, was
-    made by Taillard, as documented in his 1993 paper.
+- `ta01-80`: by Taillard (1993).
 
 The metadata from these instances has been updated using data from:
-
-Thomas Weise. jsspInstancesAndResults. Accessed in January 2024.
-Available at: https://github.com/thomasWeise/jsspInstancesAndResults
-
-It includes the following information:
-  - "optimum" (`int` | `None`): The optimal makespan for the instance.
-  - "lower_bound" (`int`): The best lower bound known for the makespan. If
-      optimality is known, it is equal to the optimum.
-  - "upper_bound" (`int`): The best upper bound known for the makespan. If
-      optimality is known, it is equal to the optimum.
-  - "reference" (`str`): The paper or source where the instance was first
-      introduced.
+https://github.com/thomasWeise/jsspInstancesAndResults
 
 ```python
 >>> ft06.metadata
@@ -102,7 +94,7 @@ It includes the following information:
 
 ### Generate a Random Instance
 
-You can also generate a random instance with the `InstanceGenerator` class.
+You can also generate a random instance with the `BasicGenerator` class.
 
 ```python
 from job_shop_lib.generators import BasicGenerator
@@ -116,7 +108,7 @@ random_instance = generator.generate()
 This class can also work as an iterator to generate multiple instances:
 
 ```python
-generator = InstanceGenerator(iteration_limit=100, seed=42)
+generator = BasicGenerator(iteration_limit=100, seed=42)
 instances = []
 for instance in generator:
     instances.append(instance)
@@ -205,6 +197,9 @@ plt.show()
 ![Example Disjunctive Graph](images/example_disjunctive_graph.png)
 
 
+> [!WARNING]
+> This plot function requires having the optional dependency [PyGraphViz](https://pygraphviz.github.io/) installed.
+
 The `JobShopGraph` class provides easy access to the nodes, for example, to get all the nodes of a specific type:
 
 ```python
@@ -266,13 +261,9 @@ plt.show()
 
 For more details, check the [examples](examples) folder.
 
-## Installation
-
-In the future, the library will be available on PyPI. For now, you can install it from the source code.
-
-### For development
+## Installation for development
 
-#### With Poetry
+### With Poetry
 
 1. Clone the repository.
 
@@ -293,7 +284,7 @@ or equivalently:
 make poetry_install_all 
 ```
 
-#### With PyPI
+### With PyPI
 
 If you don't want to use Poetry, you can install the library directly from the source code:
 

{job_shop_lib-0.1.2 → job_shop_lib-0.1.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "job-shop-lib"
-version = "0.1.2"
+version = "0.1.3"
 description = "An easy-to-use and modular Python library for the Job Shop Scheduling Problem (JSSP)"
 authors = ["Pabloo22 <pablete.arino@gmail.com>"]
 license = "MIT"
@@ -12,7 +12,7 @@ include = ["benchmarks/benchmark_instances.json"]
 python = "^3.10"
 ortools = "^9"
 matplotlib = "^3"
-pyarrow = "^14.0.0"  # An optional pandas' dependency that will be required in the future
+pyarrow = "^15.0.0"  # An optional pandas' dependency that will be required in the future
 networkx = "^3"
 imageio = "^2"
 pygraphviz = {version = "^1.12", optional = true}