Skip to content

Commit 6be34cd

Browse files
committed
Update README
1 parent f44691b commit 6be34cd

File tree

1 file changed

+20
-21
lines changed

1 file changed

+20
-21
lines changed

README.md

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,43 @@
11
# Experiments
22

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.
44

55
## Installation
66

77
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)
1010

1111
Install PyJobShop and all required packages by running:
1212

1313
```sh
1414
uv sync
1515
```
1616

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.
1918

2019
## Repository structure
2120

2221
The repository is organized as follows.
2322

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.
3029

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.
3534

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.
3938

40-
Results
41-
- **`results/`**: Contains all raw benchmark results (including full solutions).
39+
Results:
40+
- `results/`: Contains all raw benchmark results (including full solutions).
4241
*Note: This folder is not included in the repository but can be downloaded separately from Zenodo.*
4342

4443
## Reproducing results
@@ -80,4 +79,4 @@ After running the experiments, execute the following scripts to generate parsed
8079

8180
## Other
8281

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

Comments
 (0)