From e9a1e68d4a4d82482355a568233cce8fe841cdac Mon Sep 17 00:00:00 2001 From: Alexander Nasuta <alexander.nasuta@rwth-aachen.de> Date: Fri, 21 Mar 2025 09:58:55 +0100 Subject: [PATCH] v1.0.4 --- README.md | 19 ++++++++++--------- docs/source/conf.py | 2 +- docs/source/usage.md | 4 ++-- pyproject.toml | 2 +- 4 files changed, 14 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 7c6773f..dc6c366 100644 --- a/README.md +++ b/README.md @@ -14,12 +14,13 @@ </div> +- [jsp-instance-utils on **Gitlab**](https://git-ce.rwth-aachen.de/alexander.nasuta/jsp-instance-utils) -- **Github**: https://github.com/Alexander-Nasuta/jsp-instance-utils/ +- [jsp-instance-utils on **Github**](https://github.com/Alexander-Nasuta/jsp-instance-utils/) -- **PyPi**: https://pypi.org/project/jsp-instance-utils/ +- [jsp-instance-utils on **PyPi**](https://pypi.org/project/jsp-instance-utils/) -- **Documentation**: https://jsp-instance-utils.readthedocs.io/en/latest/ +- [jsp-instance-utils **Documentation**](https://jsp-instance-utils.readthedocs.io/en/latest/) # About The Project @@ -462,11 +463,11 @@ clone the repository in your favorite code editor (for example PyCharm, VSCode, using https: ```shell -git clone https://github.com/Alexander-Nasuta/graph-jsp-env +git clone https://github.com/Alexander-Nasuta/jsp-instance-utils ``` or by using the GitHub CLI: ```shell -gh repo clone Alexander-Nasuta/graph-jsp-env +gh repo clone Alexander-Nasuta/jsp-instance-utils ``` if you are using PyCharm, I recommend doing the following additional steps: @@ -484,20 +485,20 @@ todo Most Developers use a virtual environment to manage the dependencies of their projects. I personally use `conda` for this purpose. -When using `conda`, you can create a new environment with the name 'my-graph-jsp-env' following command: +When using `conda`, you can create a new environment with the name 'my-jsp-instance-utils' following command: ```shell -conda create -n my-graph-jsp-env python=3.11 +conda create -n my-jsp-instance-utils python=3.11 ``` Feel free to use any other name for the environment or an more recent version of python. Activate the environment with the following command: ```shell -conda activate jsp-instance-utils +conda activate my-jsp-instance-utils ``` -Replace `jsp-instance-utils` with the name of your environment, if you used a different name. +Replace `my-jsp-instance-utils` with the name of your environment, if you used a different name. You can also use `venv` or `virtualenv` to create a virtual environment. In that case please refer to the respective documentation. diff --git a/docs/source/conf.py b/docs/source/conf.py index 2091bc2..8b1205c 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -9,7 +9,7 @@ project = 'jsp-instance-utils' copyright = '2025, Alexander Nasuta' author = 'Alexander Nasuta' -release = '1.0.3' +release = '1.0.4' # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration diff --git a/docs/source/usage.md b/docs/source/usage.md index f9131ab..5543c09 100644 --- a/docs/source/usage.md +++ b/docs/source/usage.md @@ -98,7 +98,7 @@ The lowest known makespan is a {'optimal' if ft06_makespan_is_optimal else 'not This code snippet returns the following output: - + Analogously, you can load the `ta01` instance from the package and extract the machine matrix and the processing time matrix: @@ -122,7 +122,7 @@ The lowest known makespan is a {'optimal' if ta01_makespan_is_optimal else 'not This code snippet yields the following output: - + ## Reinforcement Learning Environments diff --git a/pyproject.toml b/pyproject.toml index 37521f3..d60c598 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "jsp-instance-utils" -version = "1.0.3" +version = "1.0.4" description = "A package containing benchmark instances for the Job Shop Scheduling Problem (JSP) scraped from various sources." readme = "README.md" authors = [{ name = "Alexander Nasuta", email = "alexander.nasuta@wzl-iqs.rwth-aachen.de" }] -- GitLab