|
1 | 1 | # Experiments |
2 | 2 |
|
3 | | -This repository contains experimental code and data for the paper submission related to **PyJobShop**. |
| 3 | +This repository contains experimental code and data for the paper submission related to PyJobShop. |
4 | 4 |
|
5 | 5 | ## Installation |
6 | 6 |
|
7 | 7 | Before using this repository, ensure you have the following installed: |
8 | | -- [uv](https://docs.astral.sh/uv/) (version **0.5.4** or higher) |
9 | | -- CP Optimizer (version **22.1.1.0** or higher) |
| 8 | +- [uv](https://docs.astral.sh/uv/) (version 0.5.4 or higher) |
| 9 | +- CP Optimizer (version 22.1.1.0 or higher) |
10 | 10 |
|
11 | 11 | Install PyJobShop and all required packages by running: |
12 | 12 |
|
13 | 13 | ```sh |
14 | 14 | uv sync |
15 | 15 | ``` |
16 | 16 |
|
17 | | -This command installs PyJobShop at commit [3ad1a02](https://github.com/PyJobShop/PyJobShop/commit/3ad1a02920a285c431e80786388facfa87affc52), which has been modified to support permutation constraints. |
18 | | -See [this](https://github.com/PyJobShop/Experiments/tree/permutation) branch for more details. |
| 17 | +This command installs PyJobShop at commit [3ad1a02](https://github.com/PyJobShop/PyJobShop/commit/3ad1a02920a285c431e80786388facfa87affc52), which has been modified to support permutation constraints. See [this](https://github.com/PyJobShop/Experiments/tree/permutation) branch for more details. |
19 | 18 |
|
20 | 19 | ## Repository structure |
21 | 20 |
|
22 | 21 | The repository is organized as follows. |
23 | 22 |
|
24 | | -The `data`/ directory |
25 | | -- **`bks/`**: Contains all best-known solutions. |
26 | | -- **`instances/`**: Contains all problem instances. |
27 | | -- **`bks.csv`**: Parsed best-known solutions for result analysis. |
28 | | -- **`stats.csv`**: Parsed instance data for result analysis. |
29 | | -- **`results.csv`**: Comprehensive CSV overview of all results. |
| 23 | +The `data`/ directory: |
| 24 | +- `bks/`: Contains all best-known solutions. |
| 25 | +- `instances/`: Contains all problem instances. |
| 26 | +- `bks.csv`: Parsed best-known solutions for result analysis. |
| 27 | +- `stats.csv`: Parsed instance data for result analysis. |
| 28 | +- `results.csv`: Comprehensive CSV overview of all results. |
30 | 29 |
|
31 | | -The `notebooks/` directory |
32 | | -- **`parse_bks.ipynb`**: Notebook for parsing best-known solutions. |
33 | | -- **`parse_results.ipynb`**: Notebook for parsing benchmark results. |
34 | | -- **`analysis.ipynb`**: Notebook for performing results analysis. |
| 30 | +The `notebooks/` directory: |
| 31 | +- `parse_bks.ipynb`: Notebook for parsing best-known solutions. |
| 32 | +- `parse_results.ipynb`: Notebook for parsing benchmark results. |
| 33 | +- `analysis.ipynb`: Notebook for performing results analysis. |
35 | 34 |
|
36 | | -Additional utilities |
37 | | -- **`read/read.py`**: Helper functions to read various instance formats. |
38 | | -- **`benchmark.py`**: Script for running benchmarks. |
| 35 | +Additional utilities: |
| 36 | +- `read/read.py`: Helper functions to read various instance formats. |
| 37 | +- `benchmark.py`: Script for running benchmarks. |
39 | 38 |
|
40 | | -Results |
41 | | -- **`results/`**: Contains all raw benchmark results (including full solutions). |
| 39 | +Results: |
| 40 | +- `results/`: Contains all raw benchmark results (including full solutions). |
42 | 41 | *Note: This folder is not included in the repository but can be downloaded separately from Zenodo.* |
43 | 42 |
|
44 | 43 | ## Reproducing results |
@@ -80,4 +79,4 @@ After running the experiments, execute the following scripts to generate parsed |
80 | 79 |
|
81 | 80 | ## Other |
82 | 81 |
|
83 | | -- **`fjsp_naderi.py`**: Replicates the FJSP model from Naderi et al. (2023). |
| 82 | +- `fjsp_naderi.py`: Replicates the FJSP model from Naderi et al. (2023). |
0 commit comments