| Name | cgshop2024-pyutils JSON |
| Version |
1.2.1
JSON |
| download |
| home_page | |
| Summary | Utilities for verifying solutions of the CG:SHOP 2024 Competition. |
| upload_time | 2023-11-29 12:37:52 |
| maintainer | |
| docs_url | None |
| author | Dominik Krupke |
| requires_python | >=3.7 |
| license | LICENSE |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# CG:SHOP - Official pyutils24 for the 2024 Challenge on Packing Polygons
Utilities for verifying solutions of the CG:SHOP 2024 Competition. Feel free to
use the code, but it is optimized for _exact_ verification not for sampling or
other purposes.
## Installation
You can install this package via PyPI:
```bash
pip install -U -v cgshop2024-pyutils
```
During the installation, CGAL and other dependencies will be downloaded and
compiled. This can take a while but should happen mostly automatic. You need to
have a C++ compiler installed.
> Please check for updates of the utils frequently as we are still working on
> them.
## Usage
### Reading instances
```python
from cgshop_pyutils24 import InstanceDatabase
db = InstanceDatabase("../cgshop2024_benchmark.zip")
instance = db["atris1240"]
assert isinstance(instance, dict)
for instance in db:
print("Found", instance["instance_name"])
```
The instances are dicts of the following format:
```json
{
"type": "cgshop2024_instance",
"instance_name": "test",
"num_items": 9,
"container": {
"x": [26, 2, 0, 12, 91, 158, 180, 194, 225, 232, 225, 210, 200],
"y": [250, 202, 149, 107, 0, 30, 42, 56, 131, 151, 177, 225, 243]
},
"items": [
{
"value": 601,
"quantity": 1,
"x": [3, 40, 113, 134, 85, 143, 152, 157, 157, 92, 18, 12, 2, 0],
"y": [31, 59, 59, 27, 6, 0, 51, 95, 139, 141, 77, 145, 152, 65]
},
{
"value": 90,
"quantity": 1,
"x": [1, 6, 25, 54, 49, 39, 25, 31, 14, 0, 13],
"y": [11, 10, 8, 0, 23, 28, 37, 56, 34, 39, 26]
},
{ "value": 1, "quantity": 1, "x": [12, 0, 28], "y": [16, 26, 0] },
{
"value": 9,
"quantity": 1,
"x": [8, 5, 0, 12, 13],
"y": [14, 19, 12, 0, 5]
},
{ "value": 133, "quantity": 1, "x": [101, 61, 0], "y": [0, 104, 95] },
{ "value": 51, "quantity": 2, "x": [68, 48, 0, 71], "y": [45, 38, 17, 0] },
{ "value": 25, "quantity": 1, "x": [21, 28, 0, 1], "y": [0, 47, 17, 0] },
{
"value": 37,
"quantity": 1,
"x": [11, 1, 17, 26, 19, 0, 9],
"y": [16, 0, 16, 12, 34, 34, 26]
},
{ "value": 32, "quantity": 1, "x": [58, 73, 79, 0], "y": [5, 10, 39, 0] }
]
}
```
### Verifying solutions
```python
from cgshop2024_pyutils import (
verify,
InstanceDatabase,
InvalidSolution,
BadSolutionFile,
)
db = InstanceDatabase("../cgshop2024_benchmark.zip")
solution = parse_solution(SOLUTION_DATA)
instance = db[solution["instance_name"]]
try:
value = verify(instance, solution)
except InvalidSolution as inv_sol:
print("Solution is invalid:", inv_sol)
except BadSolutionFile as bad_sol:
print("Solution file is invalid:", bad_sol)
else:
print("Solution is valid and has value", value)
```
### Verifying a batch of solutions
```python
from cgshop2024_pyutils import (
verify_batch,
InstanceDatabase,
InvalidSolution,
BadSolutionFile,
ZipSolutionIterator,
ZipReaderError,
)
db = InstanceDatabase("../cgshop2024_benchmark.zip")
sol_it = ZipSolutionIterator()
try:
for solution in sol_it(ZIP_FILE):
instance = db[solution["instance_name"]]
try:
value = verify(instance, solution)
except InvalidSolution as inv_sol:
print("Solution is invalid:", inv_sol)
break
except BadSolutionFile as bad_sol:
print("Solution file is invalid:", bad_sol)
break
print("Solution is valid and has value", value)
except ZipReaderError as err:
print("Error while reading zip file:", err)
```
## Trouble Shooting
The native parts are known to cause trouble on some systems. Check out
[this page](https://github.com/d-krupke/skbuild-conan#common-problems) for
solutions of various problems.
## License
The code in this repository can be used under the terms of the MIT license.
However, the package binds against CGAL which is licensed under the
[GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html). This should still allow
you to modify and use the code for the competition.
## Changelog
- **1.2.1:** Fixing Issue #2 and a crash when the `type` field is missing.
- **1.2.0:** Fixing catching of exception of bad files at the wrong place. Improved error messages.
- **1.1.1:** A long on Windows is only 32bit, so changed to using the explicit `int64_t` type.
- **1.1.0:** The previous workaround could lead to excessive memory usage.
Changed quadtree implementation to keep large elements on higher levels even
if the node is full. Gives a warning in this case.
- **1.0.1:** Only giving a warning if a node cannot be split instead of throwing
an exception. [Issue #1](https://github.com/CG-SHOP/pyutils24/issues/1)
- **1.0.0:** Initial release
Raw data
{
"_id": null,
"home_page": "",
"name": "cgshop2024-pyutils",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Dominik Krupke",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/2c/bc/f295b003b8b1ef36615ad093542e3cd7673d7289a0ae41d5c6404ea2572f/cgshop2024_pyutils-1.2.1.tar.gz",
"platform": null,
"description": "# CG:SHOP - Official pyutils24 for the 2024 Challenge on Packing Polygons\n\nUtilities for verifying solutions of the CG:SHOP 2024 Competition. Feel free to\nuse the code, but it is optimized for _exact_ verification not for sampling or\nother purposes.\n\n## Installation\n\nYou can install this package via PyPI:\n\n```bash\npip install -U -v cgshop2024-pyutils\n```\n\nDuring the installation, CGAL and other dependencies will be downloaded and\ncompiled. This can take a while but should happen mostly automatic. You need to\nhave a C++ compiler installed.\n\n> Please check for updates of the utils frequently as we are still working on\n> them.\n\n## Usage\n\n### Reading instances\n\n```python\nfrom cgshop_pyutils24 import InstanceDatabase\n\ndb = InstanceDatabase(\"../cgshop2024_benchmark.zip\")\n\ninstance = db[\"atris1240\"]\nassert isinstance(instance, dict)\n\nfor instance in db:\n print(\"Found\", instance[\"instance_name\"])\n```\n\nThe instances are dicts of the following format:\n\n```json\n{\n \"type\": \"cgshop2024_instance\",\n \"instance_name\": \"test\",\n \"num_items\": 9,\n \"container\": {\n \"x\": [26, 2, 0, 12, 91, 158, 180, 194, 225, 232, 225, 210, 200],\n \"y\": [250, 202, 149, 107, 0, 30, 42, 56, 131, 151, 177, 225, 243]\n },\n \"items\": [\n {\n \"value\": 601,\n \"quantity\": 1,\n \"x\": [3, 40, 113, 134, 85, 143, 152, 157, 157, 92, 18, 12, 2, 0],\n \"y\": [31, 59, 59, 27, 6, 0, 51, 95, 139, 141, 77, 145, 152, 65]\n },\n {\n \"value\": 90,\n \"quantity\": 1,\n \"x\": [1, 6, 25, 54, 49, 39, 25, 31, 14, 0, 13],\n \"y\": [11, 10, 8, 0, 23, 28, 37, 56, 34, 39, 26]\n },\n { \"value\": 1, \"quantity\": 1, \"x\": [12, 0, 28], \"y\": [16, 26, 0] },\n {\n \"value\": 9,\n \"quantity\": 1,\n \"x\": [8, 5, 0, 12, 13],\n \"y\": [14, 19, 12, 0, 5]\n },\n { \"value\": 133, \"quantity\": 1, \"x\": [101, 61, 0], \"y\": [0, 104, 95] },\n { \"value\": 51, \"quantity\": 2, \"x\": [68, 48, 0, 71], \"y\": [45, 38, 17, 0] },\n { \"value\": 25, \"quantity\": 1, \"x\": [21, 28, 0, 1], \"y\": [0, 47, 17, 0] },\n {\n \"value\": 37,\n \"quantity\": 1,\n \"x\": [11, 1, 17, 26, 19, 0, 9],\n \"y\": [16, 0, 16, 12, 34, 34, 26]\n },\n { \"value\": 32, \"quantity\": 1, \"x\": [58, 73, 79, 0], \"y\": [5, 10, 39, 0] }\n ]\n}\n```\n\n### Verifying solutions\n\n```python\nfrom cgshop2024_pyutils import (\n verify,\n InstanceDatabase,\n InvalidSolution,\n BadSolutionFile,\n)\n\ndb = InstanceDatabase(\"../cgshop2024_benchmark.zip\")\nsolution = parse_solution(SOLUTION_DATA)\ninstance = db[solution[\"instance_name\"]]\n\ntry:\n value = verify(instance, solution)\nexcept InvalidSolution as inv_sol:\n print(\"Solution is invalid:\", inv_sol)\nexcept BadSolutionFile as bad_sol:\n print(\"Solution file is invalid:\", bad_sol)\nelse:\n print(\"Solution is valid and has value\", value)\n```\n\n### Verifying a batch of solutions\n\n```python\nfrom cgshop2024_pyutils import (\n verify_batch,\n InstanceDatabase,\n InvalidSolution,\n BadSolutionFile,\n ZipSolutionIterator,\n ZipReaderError,\n)\n\ndb = InstanceDatabase(\"../cgshop2024_benchmark.zip\")\nsol_it = ZipSolutionIterator()\ntry:\n for solution in sol_it(ZIP_FILE):\n instance = db[solution[\"instance_name\"]]\n try:\n value = verify(instance, solution)\n except InvalidSolution as inv_sol:\n print(\"Solution is invalid:\", inv_sol)\n break\n except BadSolutionFile as bad_sol:\n print(\"Solution file is invalid:\", bad_sol)\n break\n print(\"Solution is valid and has value\", value)\nexcept ZipReaderError as err:\n print(\"Error while reading zip file:\", err)\n```\n\n## Trouble Shooting\n\nThe native parts are known to cause trouble on some systems. Check out\n[this page](https://github.com/d-krupke/skbuild-conan#common-problems) for\nsolutions of various problems.\n\n## License\n\nThe code in this repository can be used under the terms of the MIT license.\nHowever, the package binds against CGAL which is licensed under the\n[GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html). This should still allow\nyou to modify and use the code for the competition.\n\n## Changelog\n\n- **1.2.1:** Fixing Issue #2 and a crash when the `type` field is missing.\n- **1.2.0:** Fixing catching of exception of bad files at the wrong place. Improved error messages.\n- **1.1.1:** A long on Windows is only 32bit, so changed to using the explicit `int64_t` type.\n- **1.1.0:** The previous workaround could lead to excessive memory usage.\n Changed quadtree implementation to keep large elements on higher levels even\n if the node is full. Gives a warning in this case.\n- **1.0.1:** Only giving a warning if a node cannot be split instead of throwing\n an exception. [Issue #1](https://github.com/CG-SHOP/pyutils24/issues/1)\n- **1.0.0:** Initial release\n",
"bugtrack_url": null,
"license": "LICENSE",
"summary": "Utilities for verifying solutions of the CG:SHOP 2024 Competition.",
"version": "1.2.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2cbcf295b003b8b1ef36615ad093542e3cd7673d7289a0ae41d5c6404ea2572f",
"md5": "c9389dd0bbdefd46f79c47a6641babf0",
"sha256": "4a1c658acb57c2ea21b77830971ffa4fde2a0fb5b4a71373b35d9d85d7296b30"
},
"downloads": -1,
"filename": "cgshop2024_pyutils-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "c9389dd0bbdefd46f79c47a6641babf0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 114220,
"upload_time": "2023-11-29T12:37:52",
"upload_time_iso_8601": "2023-11-29T12:37:52.375275Z",
"url": "https://files.pythonhosted.org/packages/2c/bc/f295b003b8b1ef36615ad093542e3cd7673d7289a0ae41d5c6404ea2572f/cgshop2024_pyutils-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-29 12:37:52",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "cgshop2024-pyutils"
}
