| Name | beeoptimal JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | A Python implementation of the Artificial Bee Colony (ABC) optimization algorithm |
| upload_time | 2024-12-14 17:28:34 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12.1 |
| license | MIT License Copyright (c) 2024 Giulio Fantuzzi 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 |
metahueristic
optimization
artificial bee colony
swarm intelligence
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align="center">
<img src="https://github.com/giuliofantuzzi/BeeOptimal/raw/main/assets/logo_BeeOptimal.png" alt="Logo" width="250">
<h3 align="center">BeeOptimal</h3>
<p align="center">
A Python implementation of the Artificial Bee Colony (ABC) optimization algorithm
<br />
<a href="https://beeoptimal.readthedocs.io/en/latest"><strong>Explore the docs ยป</strong></a>
<br />
</p>
</div>
# About
**`BeeOptimal`** is an open-source Python package that implements the **Artificial Bee Colony (ABC)** algorithm, a population-based optimization method
inspired by the foraging behavior of honeybee swarms and designed to solve complex optimization problems efficiently. Whether you are tackling high-dimensional
search spaces, multi-modal objective functions, or simply need a reliable optimizer, **`BeeOptimal`** offers a user-friendly and customizable solution for your needs.
# Installation
Before installing the package, make sure you have **`Python 3.12` or higher** installed on your system.
In case you want to avoid any conflicts with your system's Python packages, you might want to create (and activate) a dedicated virtual environment:
```bash
python -m venv /path/to/beeoptimal_env
source /path/to/beeoptimal_env/bin/activate
```
## Installing via PIP
You can install the package from the `Python Package Index (PyPI)` via pip:
```bash
pip install beeoptimal
```
## Installing from source
1. Clone the repository:
```bash
git clone https://github.com/giuliofantuzzi/BeeOptimal.git
```
2. Move into the repository directory and install the package with:
```bash
cd BeeOptimal/
pip install .
```
## Optional Dependencies
In addition to the core functionalities, this package offers optional dependencies for specific use cases.
To build and work with the documentation, you can install the package with the docs extra:
```bash
pip install beeoptimal[docs]
```
To use the tutorials and their required dependencies, install the package with the tutorials extra:
```bash
pip install beeoptimal[tutorials]
```
To install both the documentation and the tutorials, you can use directly:
```bash
pip install beeoptimal[docs,tutorials]
```
> [!NOTE]
> The same syntax can be followed when installing from source. Moreover, if you're using the `zsh` shell, you will need to wrap the extras in quotes to prevent conflicts with shell globbing (unquoted square brackets ([ ]) are used for pattern matching in `zsh`).
Raw data
{
"_id": null,
"home_page": null,
"name": "beeoptimal",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12.1",
"maintainer_email": null,
"keywords": "metahueristic, optimization, artificial bee colony, swarm intelligence",
"author": null,
"author_email": "Giulio Fantuzzi <giulio.fantuzzi01@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/79/4c/5ca0ae33f09e3f012d33259d1077ca35ef7065b3626a8c73ed59c6937170/beeoptimal-0.1.1.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n <img src=\"https://github.com/giuliofantuzzi/BeeOptimal/raw/main/assets/logo_BeeOptimal.png\" alt=\"Logo\" width=\"250\">\n <h3 align=\"center\">BeeOptimal</h3>\n <p align=\"center\">\n A Python implementation of the Artificial Bee Colony (ABC) optimization algorithm\n <br />\n <a href=\"https://beeoptimal.readthedocs.io/en/latest\"><strong>Explore the docs \u00bb</strong></a>\n <br />\n </p>\n</div>\n\n# About\n\n**`BeeOptimal`** is an open-source Python package that implements the **Artificial Bee Colony (ABC)** algorithm, a population-based optimization method \ninspired by the foraging behavior of honeybee swarms and designed to solve complex optimization problems efficiently. Whether you are tackling high-dimensional \nsearch spaces, multi-modal objective functions, or simply need a reliable optimizer, **`BeeOptimal`** offers a user-friendly and customizable solution for your needs.\n\n# Installation\n\nBefore installing the package, make sure you have **`Python 3.12` or higher** installed on your system. \nIn case you want to avoid any conflicts with your system's Python packages, you might want to create (and activate) a dedicated virtual environment:\n\n```bash\npython -m venv /path/to/beeoptimal_env\nsource /path/to/beeoptimal_env/bin/activate\n```\n\n## Installing via PIP\n\nYou can install the package from the `Python Package Index (PyPI)` via pip:\n\n```bash\npip install beeoptimal\n```\n\n## Installing from source\n\n1. Clone the repository:\n \n ```bash\n git clone https://github.com/giuliofantuzzi/BeeOptimal.git\n ```\n\n2. Move into the repository directory and install the package with:\n \n ```bash\n cd BeeOptimal/\n pip install .\n ```\n\n## Optional Dependencies\n\nIn addition to the core functionalities, this package offers optional dependencies for specific use cases.\n\nTo build and work with the documentation, you can install the package with the docs extra:\n\n```bash\npip install beeoptimal[docs]\n```\nTo use the tutorials and their required dependencies, install the package with the tutorials extra:\n \n```bash\npip install beeoptimal[tutorials]\n```\n\nTo install both the documentation and the tutorials, you can use directly:\n\n```bash\npip install beeoptimal[docs,tutorials]\n```\n\n> [!NOTE]\n> The same syntax can be followed when installing from source. Moreover, if you're using the `zsh` shell, you will need to wrap the extras in quotes to prevent conflicts with shell globbing (unquoted square brackets ([ ]) are used for pattern matching in `zsh`).\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Giulio Fantuzzi 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": "A Python implementation of the Artificial Bee Colony (ABC) optimization algorithm",
"version": "0.1.1",
"project_urls": {
"Documentation": "https://beeoptimal.readthedocs.io/en/latest/",
"Issues": "https://github.com/giuliofantuzzi/BeeOptimal/issues",
"Repository": "https://github.com/giuliofantuzzi/BeeOptimal"
},
"split_keywords": [
"metahueristic",
" optimization",
" artificial bee colony",
" swarm intelligence"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6de605f04fb2893393c4edd1bdbdb90f0bb4cf128e649e7f032d3b64213ef080",
"md5": "cae98a77b2b32b9c094181b941f831bf",
"sha256": "e3ce1bb4ec6a86a53fbbd54e5b2e356239fe9111052f43942cb5ea621b3afb4e"
},
"downloads": -1,
"filename": "beeoptimal-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cae98a77b2b32b9c094181b941f831bf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12.1",
"size": 48739,
"upload_time": "2024-12-14T17:28:31",
"upload_time_iso_8601": "2024-12-14T17:28:31.342534Z",
"url": "https://files.pythonhosted.org/packages/6d/e6/05f04fb2893393c4edd1bdbdb90f0bb4cf128e649e7f032d3b64213ef080/beeoptimal-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "794c5ca0ae33f09e3f012d33259d1077ca35ef7065b3626a8c73ed59c6937170",
"md5": "e18bfe815d35d4c3530bf94bd43d888c",
"sha256": "35d0db7c1a06497d60eb872a769343345f50c048798436a11bd31be45e56be85"
},
"downloads": -1,
"filename": "beeoptimal-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "e18bfe815d35d4c3530bf94bd43d888c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12.1",
"size": 50654,
"upload_time": "2024-12-14T17:28:34",
"upload_time_iso_8601": "2024-12-14T17:28:34.643908Z",
"url": "https://files.pythonhosted.org/packages/79/4c/5ca0ae33f09e3f012d33259d1077ca35ef7065b3626a8c73ed59c6937170/beeoptimal-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-14 17:28:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "giuliofantuzzi",
"github_project": "BeeOptimal",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "beeoptimal"
}
