| Name | anneal JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | |
| Summary | A package for various annealing and quenching techniques |
| upload_time | 2024-02-17 00:39:22 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.10.1 |
| license | MIT License Copyright (c) 2023 anneal core developers
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 (including the next
paragraph) 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 |
optimization
algorithms
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Anneal
This is a `python` package for simulated annealing (and quenching) in all its
many guises. The design decisions are described in the corresponding [ArXiV preprint](https://arxiv.org/abs/2302.02811v2).
## Development
`pdm` is used throughout.
``` sh
micromamba create -f environment.yml
micromamba activate anneal-dev
```
## Contributing
> All contributions are welcome!!
- We follow the [NumPy commit guidelines](https://numpy.org/doc/stable/dev/development_workflow.html#writing-the-commit-message).
- Please run `pdm all` and ensure no linting or test errors exist
- [Co-author commits](https://github.blog/2018-01-29-commit-together-with-co-authors/) generously
# License
MIT.
Raw data
{
"_id": null,
"home_page": "",
"name": "anneal",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10.1",
"maintainer_email": "Rohit Goswami <rgoswami@ieee.org>, Ruhila S <ruhila@ieee.org>, Amrita Goswami <amrita@hi.is>",
"keywords": "optimization algorithms",
"author": "",
"author_email": "Rohit Goswami <rgoswami@ieee.org>, Ruhila S <ruhila@ieee.org>, Amrita Goswami <amrita@hi.is>, Sonaly Goswami <sonaly@iitk.ac.in>, Debabrata Goswami <dgoswami@iitk.ac.in>",
"download_url": "https://files.pythonhosted.org/packages/a0/e9/4e485787df1e20c3ad584fe1207f4708b9e8e3b634a30ec271850dc2d33a/anneal-0.1.0.tar.gz",
"platform": null,
"description": "# Anneal\n\nThis is a `python` package for simulated annealing (and quenching) in all its\nmany guises. The design decisions are described in the corresponding [ArXiV preprint](https://arxiv.org/abs/2302.02811v2).\n\n## Development\n\n`pdm` is used throughout.\n\n``` sh\nmicromamba create -f environment.yml\nmicromamba activate anneal-dev\n```\n\n## Contributing\n\n> All contributions are welcome!!\n\n- We follow the [NumPy commit guidelines](https://numpy.org/doc/stable/dev/development_workflow.html#writing-the-commit-message).\n- Please run `pdm all` and ensure no linting or test errors exist\n- [Co-author commits](https://github.blog/2018-01-29-commit-together-with-co-authors/) generously\n\n# License\nMIT.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 anneal core developers\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is furnished\n to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice (including the next\n paragraph) shall be included in all copies or substantial portions of the\n Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\n FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS\n OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,\n WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF\n OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "A package for various annealing and quenching techniques",
"version": "0.1.0",
"project_urls": {
"Bug tracker": "https://github.com/HaoZeke/anneal/issues",
"Homepage": "https://github.com/HaoZeke/anneal"
},
"split_keywords": [
"optimization",
"algorithms"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "88265e21d1e4eba1f26e6d6a0615856da362fda713c442158ab1f447e3e7d72f",
"md5": "7a9d1b6d8e8569dfbd183d36ad8313fa",
"sha256": "37f408981344a3c4e69138b8c8d9bc500efbea8e0e0a4ea32722df0c7ff22cb7"
},
"downloads": -1,
"filename": "anneal-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7a9d1b6d8e8569dfbd183d36ad8313fa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10.1",
"size": 16540,
"upload_time": "2024-02-17T00:39:20",
"upload_time_iso_8601": "2024-02-17T00:39:20.490926Z",
"url": "https://files.pythonhosted.org/packages/88/26/5e21d1e4eba1f26e6d6a0615856da362fda713c442158ab1f447e3e7d72f/anneal-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a0e94e485787df1e20c3ad584fe1207f4708b9e8e3b634a30ec271850dc2d33a",
"md5": "c111910a6040ca2c560d3b00b1ded7ad",
"sha256": "84a6c78ca03fde5dd1eeb3445267d7b216dafb604d07905e3bf7a43a351ffe21"
},
"downloads": -1,
"filename": "anneal-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "c111910a6040ca2c560d3b00b1ded7ad",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10.1",
"size": 13506,
"upload_time": "2024-02-17T00:39:22",
"upload_time_iso_8601": "2024-02-17T00:39:22.318957Z",
"url": "https://files.pythonhosted.org/packages/a0/e9/4e485787df1e20c3ad584fe1207f4708b9e8e3b634a30ec271850dc2d33a/anneal-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-17 00:39:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "HaoZeke",
"github_project": "anneal",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "anneal"
}
