# ENHSP Wrapper
This is a simple wrapper for the ENHSP planner. For most use cases of ENHSP in Python, you should look at [unified-planning](https://github.com/aiplan4eu/unified-planning) instead. This package does not automatically stay updated with the latest version of ENHSP. The version of ENHSP used in this package is 20-0.10.0 (this number may not even be correct if I forget to update it!), and is likely out-dated when you read this file.
If, for some reason, unified-planning does not work for you, then you may find this ENHSP wrapper useful. Unlike unified-planning, this wrapper does not try to parse the problem before passing it onto ENHSP. This is likely only useful if you are using a PDDL syntax that ENHSP supports, but unified-planning does not.
## Installation
Run
```sh
pip install enhsp-wrapper
```
to install the package. This will include the ENHSP jar files this package depends on, which in turn depend on Java 17. It may not work if you do not have Java 17 installed.
## Example Usage
```py
from enhsp_wrapper.enhsp import ENHSP, PlanningStatus
# pass ENHSP its command line arguments
planner = ENHSP('-s gbfs -h hadd -timeout 10')
# pass in the domain and problem PDDL files
result = planner.solve('d.pddl', 'p.pddl')
assert result.status == PlanningStatus.SUCCESS
print('\n'.join(result.plan))
```
## Contribute
To contribute to this project, install [poetry](https://python-poetry.org/docs/), clone the repository, then run
```sh
peotry shell
poetry install
```
Raw data
{
"_id": null,
"home_page": "https://gitlab.anu.edu.au/u6937003/enhsp_wrapper",
"name": "enhsp-wrapper",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Ryan Wang",
"author_email": "ryanxiaowang2001@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c5/97/5dfa92bac4a5ca9335046e401311e47d8e7dac2bd3698ea5fb76d2f13774/enhsp_wrapper-0.1.4.tar.gz",
"platform": null,
"description": "# ENHSP Wrapper\n\nThis is a simple wrapper for the ENHSP planner. For most use cases of ENHSP in Python, you should look at [unified-planning](https://github.com/aiplan4eu/unified-planning) instead. This package does not automatically stay updated with the latest version of ENHSP. The version of ENHSP used in this package is 20-0.10.0 (this number may not even be correct if I forget to update it!), and is likely out-dated when you read this file.\n\nIf, for some reason, unified-planning does not work for you, then you may find this ENHSP wrapper useful. Unlike unified-planning, this wrapper does not try to parse the problem before passing it onto ENHSP. This is likely only useful if you are using a PDDL syntax that ENHSP supports, but unified-planning does not.\n\n## Installation\n\nRun\n```sh\npip install enhsp-wrapper\n```\nto install the package. This will include the ENHSP jar files this package depends on, which in turn depend on Java 17. It may not work if you do not have Java 17 installed.\n\n## Example Usage\n\n```py\nfrom enhsp_wrapper.enhsp import ENHSP, PlanningStatus\n\n# pass ENHSP its command line arguments\nplanner = ENHSP('-s gbfs -h hadd -timeout 10')\n\n# pass in the domain and problem PDDL files\nresult = planner.solve('d.pddl', 'p.pddl')\n\nassert result.status == PlanningStatus.SUCCESS\nprint('\\n'.join(result.plan))\n```\n\n## Contribute\n\nTo contribute to this project, install [poetry](https://python-poetry.org/docs/), clone the repository, then run\n```sh\npeotry shell\npoetry install\n```",
"bugtrack_url": null,
"license": "MIT",
"summary": "Wrapper for the ENHSP planner",
"version": "0.1.4",
"project_urls": {
"Homepage": "https://gitlab.anu.edu.au/u6937003/enhsp_wrapper",
"Repository": "https://gitlab.anu.edu.au/u6937003/enhsp_wrapper"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "36d117b83b53f7eccfbef9dc974a9f4b07b7505839fa3c3929037d8e523e902c",
"md5": "f963ac8e52281ec3c3fe10be29e28c6d",
"sha256": "8cffad9f643ed9758480d9f0a1c4b1b52dc2b501a3f2c3a1b59806dec7de183e"
},
"downloads": -1,
"filename": "enhsp_wrapper-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f963ac8e52281ec3c3fe10be29e28c6d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 50662679,
"upload_time": "2023-09-25T12:09:00",
"upload_time_iso_8601": "2023-09-25T12:09:00.887463Z",
"url": "https://files.pythonhosted.org/packages/36/d1/17b83b53f7eccfbef9dc974a9f4b07b7505839fa3c3929037d8e523e902c/enhsp_wrapper-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c5975dfa92bac4a5ca9335046e401311e47d8e7dac2bd3698ea5fb76d2f13774",
"md5": "8a1dd78dba0c56c7b08d3fc221530e4a",
"sha256": "e2d6f33a89fc3f376e58a1cbadf4af0dae27f8978f940ecab349db830d29eeb2"
},
"downloads": -1,
"filename": "enhsp_wrapper-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "8a1dd78dba0c56c7b08d3fc221530e4a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 50641742,
"upload_time": "2023-09-25T12:09:38",
"upload_time_iso_8601": "2023-09-25T12:09:38.592913Z",
"url": "https://files.pythonhosted.org/packages/c5/97/5dfa92bac4a5ca9335046e401311e47d8e7dac2bd3698ea5fb76d2f13774/enhsp_wrapper-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-25 12:09:38",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "enhsp-wrapper"
}
JSON