<div align="center">
<p>
<a align="center" href="" target="https://ktafakkori.github.io">
<img
width="100%"
src="docs/assets/banner.png"
>
</a>
</p>
</div>
<h2 align='center'>Efficient & Feature-Rich Integrated Decision Environment</h2>
<div align="center" style="margin-bottom: 2px;">
[](https://feloopy.readthedocs.io/en/latest/?badge=latest&color=darkgreen&label=docs)
[](https://discord.gg/VpZDeG8wbv)
[](https://pepy.tech/project/feloopy?&left_text=totalusers)
[](https://pypistats.org/packages/feloopy)
</div>
FelooPy (pronounced /fɛlupaɪ/) is a comprehensive and versatile Decision Science and Operations Research library. It allows for coding, modeling, and solving decision problems and aligns with low or no-code requirements, letting you focus more on analytics. The library covers various categories of mathematical and statistical methods for decision-making and utilizes numerous interfaces and solvers without requiring prompting large language models or learning complex coding syntaxes. It is primarily developed in Python, which makes it accessible and callable from multiple programming languages.
[This](https://github.com/ktafakkori/feloopy) is FelooPy project's repository hosted by GitHub. For more information, please refer to FelooPy's [documentation](https://feloopy.readthedocs.io/en/latest/).
## Quick installation
You can install `feloopy` inside a Python>=3.10.x environment.
```py
pip install -U "feloopy[stock]==0.2.9"
```
## Quick test
Here is an example to test FelooPy's functionality:
```py
import feloopy as flp
m = flp.model(name="model_name", method="exact", interface="pymprog")
x = m.bvar(name="x")
y = m.pvar(name="y", bound=[0, 1])
m.con(x + y <= 1, name="c1")
m.con(x - y >= 1, name="c2")
m.obj(x + y)
m.sol(directions=["max"], solver="glpk")
m.clean_report()
```
## Citation
To cite or give credit to FelooPy in publications, projects, presentations, web pages, blog posts, etc. please use one of the following entries, based on the used version:
### Version<=0.2.8
- LaTeX:
```console
@software{ktafakkori2022Sep,
author = {Keivan Tafakkori},
title = { {FelooPy: An integrated optimization environment for AutoOR in Python} },
year = {2022},
month = sep,
publisher = {GitHub},
url = {https://github.com/ktafakkori/feloopy/}
}
```
- APA:
Tafakkori, K. (2022). FelooPy: An integrated optimization environment for AutoOR in Python [Python Library]. Retrieved from https://github.com/ktafakkori/feloopy (Original work published September 2022).
### Version>=0.2.9
- LaTeX:
```console
@software{ktafakkori2024Apr,
author = {Keivan Tafakkori},
title = { {FelooPy: Efficient and feature-rich integrated decision environment} },
year = {2024},
month = apr,
publisher = {GitHub},
url = {https://github.com/ktafakkori/feloopy/}
}
```
- APA:
Tafakkori, K. (2024). Efficient and feature-rich integrated decision environment [Python Library]. Retrieved from https://github.com/ktafakkori/feloopy (Original work published April 2024).
- In-text:
* _Note_ 1: Please write the version you used, the latest is v0.2.9.
* _Note_ 2: Using secondary interfaces or solvers might also require a citation to their projects.
Example: FelooPy (v0.2.9) was used in conjunction with [interface x] (v0.0.0) (except `feloopy` itself) as the interface and [solver y] (v0.0.0) as the solver.
Raw data
{
"_id": null,
"home_page": "https://github.com/ktafakkori/feloopy",
"name": "feloopy",
"maintainer": "Keivan Tafakkori",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "k.tafakkori@gmail.com",
"keywords": "computer science, data science, decision making, decision science, industrial engineering, machine learning, management science, mathematical modeling, operations management, operations research, optimization, simulation, supply chain",
"author": "Keivan Tafakkori",
"author_email": "k.tafakkori@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f2/fe/3a4795563e9b9bf5f5e15d1e3f65f7c4129e918483f0aabd605917bb3049/feloopy-0.2.9.tar.gz",
"platform": null,
"description": "<div align=\"center\">\r\n <p>\r\n <a align=\"center\" href=\"\" target=\"https://ktafakkori.github.io\">\r\n <img\r\n width=\"100%\"\r\n src=\"docs/assets/banner.png\"\r\n >\r\n </a>\r\n </p>\r\n</div>\r\n\r\n<h2 align='center'>Efficient & Feature-Rich Integrated Decision Environment</h2>\r\n\r\n\r\n<div align=\"center\" style=\"margin-bottom: 2px;\">\r\n\r\n\r\n\r\n[](https://feloopy.readthedocs.io/en/latest/?badge=latest&color=darkgreen&label=docs)\r\n[](https://discord.gg/VpZDeG8wbv)\r\n\r\n\r\n[](https://pepy.tech/project/feloopy?&left_text=totalusers)\r\n[](https://pypistats.org/packages/feloopy)\r\n\r\n</div>\r\n\r\nFelooPy (pronounced /f\u025blupa\u026a/) is a comprehensive and versatile Decision Science and Operations Research library. It allows for coding, modeling, and solving decision problems and aligns with low or no-code requirements, letting you focus more on analytics. The library covers various categories of mathematical and statistical methods for decision-making and utilizes numerous interfaces and solvers without requiring prompting large language models or learning complex coding syntaxes. It is primarily developed in Python, which makes it accessible and callable from multiple programming languages.\r\n\r\n[This](https://github.com/ktafakkori/feloopy) is FelooPy project's repository hosted by GitHub. For more information, please refer to FelooPy's [documentation](https://feloopy.readthedocs.io/en/latest/).\r\n\r\n## Quick installation\r\n\r\nYou can install `feloopy` inside a Python>=3.10.x environment.\r\n\r\n```py\r\npip install -U \"feloopy[stock]==0.2.9\"\r\n```\r\n\r\n## Quick test\r\n\r\nHere is an example to test FelooPy's functionality:\r\n\r\n```py\r\nimport feloopy as flp\r\n\r\nm = flp.model(name=\"model_name\", method=\"exact\", interface=\"pymprog\")\r\n\r\nx = m.bvar(name=\"x\")\r\ny = m.pvar(name=\"y\", bound=[0, 1])\r\nm.con(x + y <= 1, name=\"c1\")\r\nm.con(x - y >= 1, name=\"c2\")\r\nm.obj(x + y)\r\n\r\nm.sol(directions=[\"max\"], solver=\"glpk\")\r\n\r\nm.clean_report()\r\n```\r\n\r\n## Citation\r\n\r\nTo cite or give credit to FelooPy in publications, projects, presentations, web pages, blog posts, etc. please use one of the following entries, based on the used version:\r\n\r\n### Version<=0.2.8\r\n\r\n- LaTeX:\r\n\r\n ```console\r\n @software{ktafakkori2022Sep,\r\n author = {Keivan Tafakkori},\r\n title = { {FelooPy: An integrated optimization environment for AutoOR in Python} },\r\n year = {2022},\r\n month = sep,\r\n publisher = {GitHub},\r\n url = {https://github.com/ktafakkori/feloopy/}\r\n }\r\n ```\r\n\r\n- APA:\r\n\r\n Tafakkori, K. (2022). FelooPy: An integrated optimization environment for AutoOR in Python [Python Library]. Retrieved from https://github.com/ktafakkori/feloopy (Original work published September 2022).\r\n\r\n### Version>=0.2.9\r\n\r\n\r\n- LaTeX:\r\n\r\n ```console\r\n @software{ktafakkori2024Apr,\r\n author = {Keivan Tafakkori},\r\n title = { {FelooPy: Efficient and feature-rich integrated decision environment} },\r\n year = {2024},\r\n month = apr,\r\n publisher = {GitHub},\r\n url = {https://github.com/ktafakkori/feloopy/}\r\n }\r\n ```\r\n\r\n- APA:\r\n\r\n Tafakkori, K. (2024). Efficient and feature-rich integrated decision environment [Python Library]. Retrieved from https://github.com/ktafakkori/feloopy (Original work published April 2024).\r\n\r\n- In-text:\r\n\r\n * _Note_ 1: Please write the version you used, the latest is v0.2.9.\r\n * _Note_ 2: Using secondary interfaces or solvers might also require a citation to their projects.\r\n\r\n Example: FelooPy (v0.2.9) was used in conjunction with [interface x] (v0.0.0) (except `feloopy` itself) as the interface and [solver y] (v0.0.0) as the solver.\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "FelooPy: Efficient and feature-rich integrated decision environment",
"version": "0.2.9",
"project_urls": {
"Download": "https://github.com/ktafakkori/feloopy/releases",
"Homepage": "https://github.com/ktafakkori/feloopy"
},
"split_keywords": [
"computer science",
" data science",
" decision making",
" decision science",
" industrial engineering",
" machine learning",
" management science",
" mathematical modeling",
" operations management",
" operations research",
" optimization",
" simulation",
" supply chain"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "75d344e7983f7036962ecd347c509c84c3bf79c55858ae13379f3a1019cd2fdb",
"md5": "c872d16abd766ea07a04e56edcace822",
"sha256": "fae26aae0a67ab70b12ce3e942517e705747cebf791ebd3fb121d4a6a91ea66b"
},
"downloads": -1,
"filename": "feloopy-0.2.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c872d16abd766ea07a04e56edcace822",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 170122,
"upload_time": "2024-04-07T21:21:20",
"upload_time_iso_8601": "2024-04-07T21:21:20.070472Z",
"url": "https://files.pythonhosted.org/packages/75/d3/44e7983f7036962ecd347c509c84c3bf79c55858ae13379f3a1019cd2fdb/feloopy-0.2.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f2fe3a4795563e9b9bf5f5e15d1e3f65f7c4129e918483f0aabd605917bb3049",
"md5": "6f151b49972615e428be83968918c384",
"sha256": "afdcf9940c6eab0be390c7aa1452de59c3263b7149032b774867647dc5770fe4"
},
"downloads": -1,
"filename": "feloopy-0.2.9.tar.gz",
"has_sig": false,
"md5_digest": "6f151b49972615e428be83968918c384",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 103285,
"upload_time": "2024-04-07T21:21:22",
"upload_time_iso_8601": "2024-04-07T21:21:22.961967Z",
"url": "https://files.pythonhosted.org/packages/f2/fe/3a4795563e9b9bf5f5e15d1e3f65f7c4129e918483f0aabd605917bb3049/feloopy-0.2.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-07 21:21:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ktafakkori",
"github_project": "feloopy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "feloopy"
}
JSON
