graph-matrix-jsp-env


Namegraph-matrix-jsp-env JSON
Version 0.1.1 PyPI version JSON
download
home_pageNone
SummaryAn enviorment for job shop scheduling using the disjunctive graph apporach and the graph matrix datastructure.
upload_time2025-01-21 08:35:43
maintainerNone
docs_urlNone
authorAlexander Nasuta
requires_python>=3.9
licenseMIT License Copyright (c) 2025 Alexander Nasuta Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Graph Matrix Job Shop Env

![](https://github.com/Alexander-Nasuta/GraphMatrixJobShopEnv/raw/master/resources/asni-render.gif)

A Gymnasium Environment for Job Shop Scheduling using the Graph Matrix Representation by [Błażewicz et al.](https://www.sciencedirect.com/science/article/abs/pii/S0377221799004865).

- Github: [GraphMatrixJobShopEnv](https://github.com/Alexander-Nasuta/GraphMatrixJobShopEnv)
- Pypi: [GraphMatrixJobShopEnv](https://pypi.org/project/graph-matrix-jsp-env/)
- Documentation: [GraphMatrixJobShopEnv Docs](https://graphmatrixjobshopenv.readthedocs.io/en/latest/)

## Description

A Gymnasium Environment for Job Shop Scheduling using the Graph Matrix Representation by [Błażewicz et al.](https://www.sciencedirect.com/science/article/abs/pii/S0377221799004865).
It can be used to solve the Job Shop Scheduling Problem (JSP) using Reinforcement Learning with libraries like [Stable Baselines3](https://stable-baselines3.readthedocs.io/en/master/) or [RLlib](https://docs.ray.io/en/latest/rllib/index.html).
A minimal working example is provided in the [Quickstart](#quickstart) section.

## Quickstart

```shell
pip install graph-matrix-jsp-env
```

### Random Agent Example

```python
from graph_matrix_jsp_env.disjunctive_jsp_env import DisjunctiveGraphJspEnv
import numpy as np

if __name__ == '__main__':
    custom_jsp_instance = np.array([
        [
            [0, 1, 2, 3],  # job 0
            [0, 2, 1, 3]  # job 1
        ],
        [
            [11, 3, 3, 12],  # task durations of job 0
            [5, 16, 7, 4]  # task durations of job 1
        ]

    ], dtype=np.int32)
    env = DisjunctiveGraphJspEnv(
        jsp_instance=custom_jsp_instance,
    )
    obs, info = env.reset()

    terminated = False

    while not terminated:
        action = env.action_space.sample(mask=env.valid_action_mask())
        obs, reward, terminated, truncated, info = env.step(action)
        env.render(mode='debug')
```

### Stable Baselines3 Example

To train a PPO agent using the environment with Stable Baselines3 one first needs to install the required dependencies:

```shell
pip install stable-baselines3
pip install sb3-contrib
```

Then one can use the following code to train a PPO agent:

```python
import gymnasium as gym
import sb3_contrib
import stable_baselines3 as sb3

import numpy as np
from sb3_contrib.common.maskable.policies import MaskableActorCriticPolicy
from sb3_contrib.common.wrappers import ActionMasker

from graph_matrix_jsp_env.disjunctive_jsp_env import DisjunctiveGraphJspEnv

if __name__ == '__main__':
    
    custom_jsp_instance = np.array([
        [
            [0, 1, 2, 3],  # job 0
            [0, 2, 1, 3]  # job 1
        ],
        [
            [11, 3, 3, 12],  # task durations of job 0
            [5, 16, 7, 4]  # task durations of job 1
        ]

    ], dtype=np.int32)
    
    # just make sure to import them from jsp_instance_utils.instances
    env = DisjunctiveGraphJspEnv(jsp_instance=custom_jsp_instance) 
    env = sb3.common.monitor.Monitor(env)


    def mask_fn(env: gym.Env) -> np.ndarray:
        return env.unwrapped.valid_action_mask()


    env = ActionMasker(env, mask_fn)

    model = sb3_contrib.MaskablePPO(
        MaskableActorCriticPolicy,
        env,
        verbose=1,
        device="cpu" # Note: You can also use "cuda" if you have a GPU with CUDA
    )

    # Train the agent
    model.learn(total_timesteps=10_000)
```

## Visualizations

The environment offers multiple visualisation options.
There are four visualisations that can be mixed and matched:
- `human` (default): prints a Gantt chart visualisation to the console.
- `ansi`: prints a visualisation of the graph matrix and the Gantt chart to the console.
- `debug`: prints a visualisation of the graph matrix. The debugs visualisation is maps the elements of the successor lists and unknown list to the original graph indices of the takes ad uses colors to separate the different elements. It also prints the Gantt chart and some additional information.
- `window`: creates a Gantt chart visualisation in a separate window.
- `rgb_array`: creates a Gantt chart visualisation as a RGB array. This mode return the RGB array of the `window` visualisation. This can be used to create a video of the Gantt chart visualisation. 

### Examples

For the following Job Shop Scheduling Problem (JSP) instance:

```python
from graph_matrix_jsp_env.disjunctive_jsp_env import DisjunctiveGraphJspEnv
import numpy as np

if __name__ == '__main__':
    custom_jsp_instance = np.array([
        [
            [0, 1, 2, 3],  # job 0
            [0, 2, 1, 3]  # job 1
        ],
        [
            [11, 3, 3, 12],  # task durations of job 0
            [5, 16, 7, 4]  # task durations of job 1
        ]

    ], dtype=np.int32)
    env = DisjunctiveGraphJspEnv(
        jsp_instance=custom_jsp_instance,
    )
    obs, info = env.reset()
    mode = 'debug' # replace with 'human', 'ansi', 'window', 'rgb_array' for different visualizations
    env.render(mode=mode) 

    for a in [5, 1, 2, 6, 3, 7, 4, 8]:
        env.step(a)
        env.render(mode=mode)

    env.render()
```

The individual rendering modes result in the following visualisations:

#### ANSI

![](https://github.com/Alexander-Nasuta/GraphMatrixJobShopEnv/raw/master/resources/asni-render.gif)

#### Debug

![](https://github.com/Alexander-Nasuta/GraphMatrixJobShopEnv/raw/master/resources/debug-render.gif)

#### Defualt (Human)

![](https://github.com/Alexander-Nasuta/GraphMatrixJobShopEnv/raw/master/resources/default-render.gif)

### window

![](https://github.com/Alexander-Nasuta/GraphMatrixJobShopEnv/raw/master/resources/window-render.gif)

The Terminal used for the visualisations is [Ghostty](https://github.com/ghostty-org/ghostty).

## State of the Project

This project is complementary material for a research paper. It will not be frequently updated.
Minor updates might occur.
Significant further development will most likely result in a new project. In that case, a note with a link will be added in the `README.md` of this project.  

## Dependencies

This project specifies multiple requirements files. 
`requirements.txt` contains the dependencies for the environment to work. These requirements will be installed automatically when installing the environment via `pip`.
`requirements_dev.txt` contains the dependencies for development purposes. It includes the dependencies for testing, linting, and building the project on top of the dependencies in `requirements.txt`.
`requirements_examples.txt` contains the dependencies for running the examples inside the project. It includes the dependencies in `requirements.txt` and additional dependencies for the examples.

In this Project the dependencies are specified in the `pyproject.toml` file with as little version constraints as possible.
The tool `pip-compile` translates the `pyproject.toml` file into a `requirements.txt` file with pinned versions. 
That way version conflicts can be avoided (as much as possible) and the project can be built in a reproducible way.

## Development Setup

If you want to check out the code and implement new features or fix bugs, you can set up the project as follows:

### Clone the Repository

clone the repository in your favorite code editor (for example PyCharm, VSCode, Neovim, etc.)

using https:
```shell
git clone https://github.com/Alexander-Nasuta/GraphMatrixJobShopEnv.git
```
or by using the GitHub CLI:
```shell
gh repo clone Alexander-Nasuta/GraphMatrixJobShopEnv
```

if you are using PyCharm, I recommend doing the following additional steps:

- mark the `src` folder as source root (by right-clicking on the folder and selecting `Mark Directory as` -> `Sources Root`)
- mark the `tests` folder as test root (by right-clicking on the folder and selecting `Mark Directory as` -> `Test Sources Root`)
- mark the `resources` folder as resources root (by right-clicking on the folder and selecting `Mark Directory as` -> `Resources Root`)

at the end your project structure should look like this:

todo

### Create a Virtual Environment (optional)

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:

```shell
conda create -n my-graph-jsp-env 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 my-graph-jsp-env
```

Replace `my-graph-jsp-env` 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.

### Install the Dependencies

To install the dependencies for development purposes, run the following command:

```shell
pip install -r requirements_dev.txt
pip install tox
```

The testing package `tox` is not included in the `requirements_dev.txt` file, because it sometimes causes issues when 
using github actions. 
Github Actions uses an own tox environment (namely 'tox-gh-actions'), which can cause conflicts with the tox environment on your local machine.

Reference: [Automated Testing in Python with pytest, tox, and GitHub Actions](https://www.youtube.com/watch?v=DhUpxWjOhME).

### Install the Project in Editable Mode

To install the project in editable mode, run the following command:

```shell
pip install -e .
```

This will install the project in editable mode, so you can make changes to the code and test them immediately.

### Run the Tests

This project uses `pytest` for testing. To run the tests, run the following command:

```shell
pytest
```
Here is a screenshot of what the output might look like:

![](https://github.com/Alexander-Nasuta/GraphMatrixJobShopEnv/raw/master/resources/pytest-screenshot.png)

For testing with `tox` run the following command:

```shell
tox
```

Here is a screenshot of what the output might look like:

![](https://github.com/Alexander-Nasuta/GraphMatrixJobShopEnv/raw/master/resources/tox-screenshot.png)

Tox will run the tests in a separate environment and will also check if the requirements are installed correctly.

### Builing and Publishing the Project to PyPi 

In order to publish the project to PyPi, the project needs to be built and then uploaded to PyPi.

To build the project, run the following command:

```shell
python -m build
```

It is considered good practice use the tool `twine` for checking the build and uploading the project to PyPi.
By default the build command creates a `dist` folder with the built project files.
To check all the files in the `dist` folder, run the following command:

```shell
twine check dist/**
```

If the check is successful, you can upload the project to PyPi with the following command:

```shell
twine upload dist/**
```

### Documentation
This project uses `sphinx` for generating the documentation. 
It also uses a lot of sphinx extensions to make the documentation more readable and interactive.
For example the extension `myst-parser` is used to enable markdown support in the documentation (instead of the usual .rst-files).
It also uses the `sphinx-autobuild` extension to automatically rebuild the documentation when changes are made.
By running the following command, the documentation will be automatically built and served, when changes are made (make sure to run this command in the root directory of the project):

```shell
sphinx-autobuild ./docs/source/ ./docs/build/html/
```

This project features most of the extensions featured in this Tutorial: [Document Your Scientific Project With Markdown, Sphinx, and Read the Docs | PyData Global 2021](https://www.youtube.com/watch?v=qRSb299awB0).



## Contact

If you have any questions or feedback, feel free to contact me via [email](mailto:alexander.nasuta@wzl-iqs.rwth-aachen.de) or open an issue on repository.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "graph-matrix-jsp-env",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "Alexander Nasuta",
    "author_email": "Alexander Nasuta <alexander.nasuta@wzl-iqs.rwth-aachen.de>",
    "download_url": "https://files.pythonhosted.org/packages/4b/c4/737238f7059710141699c75bfc711997637743db551b27f8b3fec4315638/graph_matrix_jsp_env-0.1.1.tar.gz",
    "platform": "unix",
    "description": "# Graph Matrix Job Shop Env\n\n![](https://github.com/Alexander-Nasuta/GraphMatrixJobShopEnv/raw/master/resources/asni-render.gif)\n\nA Gymnasium Environment for Job Shop Scheduling using the Graph Matrix Representation by [B\u0142a\u017cewicz et al.](https://www.sciencedirect.com/science/article/abs/pii/S0377221799004865).\n\n- Github: [GraphMatrixJobShopEnv](https://github.com/Alexander-Nasuta/GraphMatrixJobShopEnv)\n- Pypi: [GraphMatrixJobShopEnv](https://pypi.org/project/graph-matrix-jsp-env/)\n- Documentation: [GraphMatrixJobShopEnv Docs](https://graphmatrixjobshopenv.readthedocs.io/en/latest/)\n\n## Description\n\nA Gymnasium Environment for Job Shop Scheduling using the Graph Matrix Representation by [B\u0142a\u017cewicz et al.](https://www.sciencedirect.com/science/article/abs/pii/S0377221799004865).\nIt can be used to solve the Job Shop Scheduling Problem (JSP) using Reinforcement Learning with libraries like [Stable Baselines3](https://stable-baselines3.readthedocs.io/en/master/) or [RLlib](https://docs.ray.io/en/latest/rllib/index.html).\nA minimal working example is provided in the [Quickstart](#quickstart) section.\n\n## Quickstart\n\n```shell\npip install graph-matrix-jsp-env\n```\n\n### Random Agent Example\n\n```python\nfrom graph_matrix_jsp_env.disjunctive_jsp_env import DisjunctiveGraphJspEnv\nimport numpy as np\n\nif __name__ == '__main__':\n    custom_jsp_instance = np.array([\n        [\n            [0, 1, 2, 3],  # job 0\n            [0, 2, 1, 3]  # job 1\n        ],\n        [\n            [11, 3, 3, 12],  # task durations of job 0\n            [5, 16, 7, 4]  # task durations of job 1\n        ]\n\n    ], dtype=np.int32)\n    env = DisjunctiveGraphJspEnv(\n        jsp_instance=custom_jsp_instance,\n    )\n    obs, info = env.reset()\n\n    terminated = False\n\n    while not terminated:\n        action = env.action_space.sample(mask=env.valid_action_mask())\n        obs, reward, terminated, truncated, info = env.step(action)\n        env.render(mode='debug')\n```\n\n### Stable Baselines3 Example\n\nTo train a PPO agent using the environment with Stable Baselines3 one first needs to install the required dependencies:\n\n```shell\npip install stable-baselines3\npip install sb3-contrib\n```\n\nThen one can use the following code to train a PPO agent:\n\n```python\nimport gymnasium as gym\nimport sb3_contrib\nimport stable_baselines3 as sb3\n\nimport numpy as np\nfrom sb3_contrib.common.maskable.policies import MaskableActorCriticPolicy\nfrom sb3_contrib.common.wrappers import ActionMasker\n\nfrom graph_matrix_jsp_env.disjunctive_jsp_env import DisjunctiveGraphJspEnv\n\nif __name__ == '__main__':\n    \n    custom_jsp_instance = np.array([\n        [\n            [0, 1, 2, 3],  # job 0\n            [0, 2, 1, 3]  # job 1\n        ],\n        [\n            [11, 3, 3, 12],  # task durations of job 0\n            [5, 16, 7, 4]  # task durations of job 1\n        ]\n\n    ], dtype=np.int32)\n    \n    # just make sure to import them from jsp_instance_utils.instances\n    env = DisjunctiveGraphJspEnv(jsp_instance=custom_jsp_instance) \n    env = sb3.common.monitor.Monitor(env)\n\n\n    def mask_fn(env: gym.Env) -> np.ndarray:\n        return env.unwrapped.valid_action_mask()\n\n\n    env = ActionMasker(env, mask_fn)\n\n    model = sb3_contrib.MaskablePPO(\n        MaskableActorCriticPolicy,\n        env,\n        verbose=1,\n        device=\"cpu\" # Note: You can also use \"cuda\" if you have a GPU with CUDA\n    )\n\n    # Train the agent\n    model.learn(total_timesteps=10_000)\n```\n\n## Visualizations\n\nThe environment offers multiple visualisation options.\nThere are four visualisations that can be mixed and matched:\n- `human` (default): prints a Gantt chart visualisation to the console.\n- `ansi`: prints a visualisation of the graph matrix and the Gantt chart to the console.\n- `debug`: prints a visualisation of the graph matrix. The debugs visualisation is maps the elements of the successor lists and unknown list to the original graph indices of the takes ad uses colors to separate the different elements. It also prints the Gantt chart and some additional information.\n- `window`: creates a Gantt chart visualisation in a separate window.\n- `rgb_array`: creates a Gantt chart visualisation as a RGB array. This mode return the RGB array of the `window` visualisation. This can be used to create a video of the Gantt chart visualisation. \n\n### Examples\n\nFor the following Job Shop Scheduling Problem (JSP) instance:\n\n```python\nfrom graph_matrix_jsp_env.disjunctive_jsp_env import DisjunctiveGraphJspEnv\nimport numpy as np\n\nif __name__ == '__main__':\n    custom_jsp_instance = np.array([\n        [\n            [0, 1, 2, 3],  # job 0\n            [0, 2, 1, 3]  # job 1\n        ],\n        [\n            [11, 3, 3, 12],  # task durations of job 0\n            [5, 16, 7, 4]  # task durations of job 1\n        ]\n\n    ], dtype=np.int32)\n    env = DisjunctiveGraphJspEnv(\n        jsp_instance=custom_jsp_instance,\n    )\n    obs, info = env.reset()\n    mode = 'debug' # replace with 'human', 'ansi', 'window', 'rgb_array' for different visualizations\n    env.render(mode=mode) \n\n    for a in [5, 1, 2, 6, 3, 7, 4, 8]:\n        env.step(a)\n        env.render(mode=mode)\n\n    env.render()\n```\n\nThe individual rendering modes result in the following visualisations:\n\n#### ANSI\n\n![](https://github.com/Alexander-Nasuta/GraphMatrixJobShopEnv/raw/master/resources/asni-render.gif)\n\n#### Debug\n\n![](https://github.com/Alexander-Nasuta/GraphMatrixJobShopEnv/raw/master/resources/debug-render.gif)\n\n#### Defualt (Human)\n\n![](https://github.com/Alexander-Nasuta/GraphMatrixJobShopEnv/raw/master/resources/default-render.gif)\n\n### window\n\n![](https://github.com/Alexander-Nasuta/GraphMatrixJobShopEnv/raw/master/resources/window-render.gif)\n\nThe Terminal used for the visualisations is [Ghostty](https://github.com/ghostty-org/ghostty).\n\n## State of the Project\n\nThis project is complementary material for a research paper. It will not be frequently updated.\nMinor updates might occur.\nSignificant further development will most likely result in a new project. In that case, a note with a link will be added in the `README.md` of this project.  \n\n## Dependencies\n\nThis project specifies multiple requirements files. \n`requirements.txt` contains the dependencies for the environment to work. These requirements will be installed automatically when installing the environment via `pip`.\n`requirements_dev.txt` contains the dependencies for development purposes. It includes the dependencies for testing, linting, and building the project on top of the dependencies in `requirements.txt`.\n`requirements_examples.txt` contains the dependencies for running the examples inside the project. It includes the dependencies in `requirements.txt` and additional dependencies for the examples.\n\nIn this Project the dependencies are specified in the `pyproject.toml` file with as little version constraints as possible.\nThe tool `pip-compile` translates the `pyproject.toml` file into a `requirements.txt` file with pinned versions. \nThat way version conflicts can be avoided (as much as possible) and the project can be built in a reproducible way.\n\n## Development Setup\n\nIf you want to check out the code and implement new features or fix bugs, you can set up the project as follows:\n\n### Clone the Repository\n\nclone the repository in your favorite code editor (for example PyCharm, VSCode, Neovim, etc.)\n\nusing https:\n```shell\ngit clone https://github.com/Alexander-Nasuta/GraphMatrixJobShopEnv.git\n```\nor by using the GitHub CLI:\n```shell\ngh repo clone Alexander-Nasuta/GraphMatrixJobShopEnv\n```\n\nif you are using PyCharm, I recommend doing the following additional steps:\n\n- mark the `src` folder as source root (by right-clicking on the folder and selecting `Mark Directory as` -> `Sources Root`)\n- mark the `tests` folder as test root (by right-clicking on the folder and selecting `Mark Directory as` -> `Test Sources Root`)\n- mark the `resources` folder as resources root (by right-clicking on the folder and selecting `Mark Directory as` -> `Resources Root`)\n\nat the end your project structure should look like this:\n\ntodo\n\n### Create a Virtual Environment (optional)\n\nMost Developers use a virtual environment to manage the dependencies of their projects. \nI personally use `conda` for this purpose.\n\nWhen using `conda`, you can create a new environment with the name 'my-graph-jsp-env' following command:\n\n```shell\nconda create -n my-graph-jsp-env python=3.11\n```\n\nFeel free to use any other name for the environment or an more recent version of python.\nActivate the environment with the following command:\n\n```shell\nconda activate my-graph-jsp-env\n```\n\nReplace `my-graph-jsp-env` with the name of your environment, if you used a different name.\n\nYou can also use `venv` or `virtualenv` to create a virtual environment. In that case please refer to the respective documentation.\n\n### Install the Dependencies\n\nTo install the dependencies for development purposes, run the following command:\n\n```shell\npip install -r requirements_dev.txt\npip install tox\n```\n\nThe testing package `tox` is not included in the `requirements_dev.txt` file, because it sometimes causes issues when \nusing github actions. \nGithub Actions uses an own tox environment (namely 'tox-gh-actions'), which can cause conflicts with the tox environment on your local machine.\n\nReference: [Automated Testing in Python with pytest, tox, and GitHub Actions](https://www.youtube.com/watch?v=DhUpxWjOhME).\n\n### Install the Project in Editable Mode\n\nTo install the project in editable mode, run the following command:\n\n```shell\npip install -e .\n```\n\nThis will install the project in editable mode, so you can make changes to the code and test them immediately.\n\n### Run the Tests\n\nThis project uses `pytest` for testing. To run the tests, run the following command:\n\n```shell\npytest\n```\nHere is a screenshot of what the output might look like:\n\n![](https://github.com/Alexander-Nasuta/GraphMatrixJobShopEnv/raw/master/resources/pytest-screenshot.png)\n\nFor testing with `tox` run the following command:\n\n```shell\ntox\n```\n\nHere is a screenshot of what the output might look like:\n\n![](https://github.com/Alexander-Nasuta/GraphMatrixJobShopEnv/raw/master/resources/tox-screenshot.png)\n\nTox will run the tests in a separate environment and will also check if the requirements are installed correctly.\n\n### Builing and Publishing the Project to PyPi \n\nIn order to publish the project to PyPi, the project needs to be built and then uploaded to PyPi.\n\nTo build the project, run the following command:\n\n```shell\npython -m build\n```\n\nIt is considered good practice use the tool `twine` for checking the build and uploading the project to PyPi.\nBy default the build command creates a `dist` folder with the built project files.\nTo check all the files in the `dist` folder, run the following command:\n\n```shell\ntwine check dist/**\n```\n\nIf the check is successful, you can upload the project to PyPi with the following command:\n\n```shell\ntwine upload dist/**\n```\n\n### Documentation\nThis project uses `sphinx` for generating the documentation. \nIt also uses a lot of sphinx extensions to make the documentation more readable and interactive.\nFor example the extension `myst-parser` is used to enable markdown support in the documentation (instead of the usual .rst-files).\nIt also uses the `sphinx-autobuild` extension to automatically rebuild the documentation when changes are made.\nBy running the following command, the documentation will be automatically built and served, when changes are made (make sure to run this command in the root directory of the project):\n\n```shell\nsphinx-autobuild ./docs/source/ ./docs/build/html/\n```\n\nThis project features most of the extensions featured in this Tutorial: [Document Your Scientific Project With Markdown, Sphinx, and Read the Docs | PyData Global 2021](https://www.youtube.com/watch?v=qRSb299awB0).\n\n\n\n## Contact\n\nIf you have any questions or feedback, feel free to contact me via [email](mailto:alexander.nasuta@wzl-iqs.rwth-aachen.de) or open an issue on repository.\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2025 Alexander Nasuta  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
    "summary": "An enviorment for job shop scheduling using the disjunctive graph apporach and the graph matrix datastructure.",
    "version": "0.1.1",
    "project_urls": {
        "Homepage": "https://github.com/Alexander-Nasuta/pypitemplate"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "67f8d65723d955b5b9e456c78cb965f1ab59401a2a770a3ab1620294de56e77c",
                "md5": "4f6a353c9f38ccc6bd3ae15d2d48212b",
                "sha256": "64e76a36c52f876426d2a3d2178c8f66ffd6ea40a24003deb884639b8f0c2a2a"
            },
            "downloads": -1,
            "filename": "graph_matrix_jsp_env-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4f6a353c9f38ccc6bd3ae15d2d48212b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 19040,
            "upload_time": "2025-01-21T08:35:40",
            "upload_time_iso_8601": "2025-01-21T08:35:40.419054Z",
            "url": "https://files.pythonhosted.org/packages/67/f8/d65723d955b5b9e456c78cb965f1ab59401a2a770a3ab1620294de56e77c/graph_matrix_jsp_env-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4bc4737238f7059710141699c75bfc711997637743db551b27f8b3fec4315638",
                "md5": "e302e6f55becf3ab1034639e9b88790b",
                "sha256": "41623d247afaece4fb9edff1600fbd510425035500ad19b2602d08fff17fc22b"
            },
            "downloads": -1,
            "filename": "graph_matrix_jsp_env-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "e302e6f55becf3ab1034639e9b88790b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 32670,
            "upload_time": "2025-01-21T08:35:43",
            "upload_time_iso_8601": "2025-01-21T08:35:43.041525Z",
            "url": "https://files.pythonhosted.org/packages/4b/c4/737238f7059710141699c75bfc711997637743db551b27f8b3fec4315638/graph_matrix_jsp_env-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-21 08:35:43",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Alexander-Nasuta",
    "github_project": "pypitemplate",
    "github_not_found": true,
    "lcname": "graph-matrix-jsp-env"
}
        
Elapsed time: 2.23358s