feloopy


Namefeloopy JSON
Version 0.3.6 PyPI version JSON
download
home_pagehttps://github.com/ktafakkori/feloopy
SummaryFelooPy: Efficient and feature-rich integrated decision environment
upload_time2024-09-30 10:39:43
maintainerKeivan Tafakkori
docs_urlNone
authorKeivan Tafakkori
requires_python>=3.10
licenseMIT
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
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <div align="center">
  <p>
    <a href="https://feloopy.github.io" target="_blank">
      <picture>
        <source media="(prefers-color-scheme: light)" srcset="https://github.com/feloopy/feloopy/raw/main/repo/assets/feloopy-logo-name-light.png">
        <source media="(prefers-color-scheme: dark)" srcset="https://github.com/feloopy/feloopy/raw/main/repo/assets/feloopy-logo-name-dark.png">
        <img alt="FelooPy's logo." src="https://github.com/feloopy/feloopy/raw/main/repo/assets/feloopy-logo-name-light.png" width="300" height="auto">
      </picture>
    </a>
  </p>
</div>

<p align="center">
  <strong>Efficient & Feature-Rich Integrated Decision Environment</strong>
</p>


<div align="center" style="margin-bottom: 2px;">

![Version](https://img.shields.io/static/v1?label=version&message=v0.3.6&color=orange&labelColor=blue)
![Release Date](https://img.shields.io/github/release-date/feloopy/feloopy?label=release&color=orange&labelColor=blue)
[![Downloads](https://static.pepy.tech/personalized-badge/feloopy?period=total&units=international_system&left_color=blue&right_color=orange&left_text=downloads)](https://pepy.tech/project/feloopy)
![License](https://img.shields.io/static/v1?label=license&message=MIT&color=orange&labelColor=blue)

</div>

<br>

### Quick Intro

FelooPy (/fɛlupaɪ/) is a user-friendly tool for coding, modeling, and solving decision problems. It helps you focus on analysis and offers and supports a wide range of mathematical and statistical models and algorithms for decision-making.

<br>

### Quick Features

- **Linear & Non-Linear Programming**: Exact algorithms for LP/NLP.
- **Integer & Mixed-Integer Programming**: Exact algorithms for IP/MIP.
- **General Purpose Programming**: Heuristic algorithms for various problems.
- **Constraint Programming**: Techniques for constraint satisfaction.
- **Multi-Objective Decision-Making**: Optimizing multiple objectives (MODM/MCDM).
- **Multi-Attribute Decision-Making**: Evaluating opinions on alternatives using multiple attributes (MADM/MCDM).

<br>

### Quick Installation

You can install `feloopy` inside a Python>=3.10.x virtual environment:

```bash
pip install -U "feloopy[stock]==0.3.6"
```

For supporting the developer, testing the latest version, and reporting bugs or contributing to the codebase, use:

```bash
pip install "feloopy[stock] @ git+https://github.com/feloopy/feloopy.git"
```

<br>

### Quick Testing

Here is an example to test FelooPy's functionality:

```python
import feloopy as flp

def example(m):
    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)
    return m

flp.search(example,directions=["max"]).clean_report()
```

<br>


### Quick 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:

<br>

#### APA 6th/7th Edition

Tafakkori, K. (2024). *Efficient and feature-rich integrated decision environment* [Python Library]. Retrieved from [https://github.com/feloopy/feloopy](https://github.com/feloopy/feloopy) (Original work published April 2024).

#### LaTeX/BiBTeX

```
@software{ktafakkori2024Apr,
author       = {Keivan Tafakkori},
title        = {{FelooPy: Efficient and feature-rich integrated decision environment}},
year         = {2024},
month        = apr,
publisher    = {GitHub},
url          = {https://github.com/feloopy/feloopy/}
}
```

<br>
<br>

<details>
<summary>Previous citations</summary>



#### Versions before 0.3.6

##### APA 6th/7th Edition

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).

##### LaTeX/BiBTeX
```
@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/}
}
```


</details>

            

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/89/c1/181dd8ef58afcd80fda76ecef9de5c75b390f9cbb5e7087897b195397612/feloopy-0.3.6.tar.gz",
    "platform": null,
    "description": "<div align=\"center\">\r\n  <p>\r\n    <a href=\"https://feloopy.github.io\" target=\"_blank\">\r\n      <picture>\r\n        <source media=\"(prefers-color-scheme: light)\" srcset=\"https://github.com/feloopy/feloopy/raw/main/repo/assets/feloopy-logo-name-light.png\">\r\n        <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://github.com/feloopy/feloopy/raw/main/repo/assets/feloopy-logo-name-dark.png\">\r\n        <img alt=\"FelooPy's logo.\" src=\"https://github.com/feloopy/feloopy/raw/main/repo/assets/feloopy-logo-name-light.png\" width=\"300\" height=\"auto\">\r\n      </picture>\r\n    </a>\r\n  </p>\r\n</div>\r\n\r\n<p align=\"center\">\r\n  <strong>Efficient & Feature-Rich Integrated Decision Environment</strong>\r\n</p>\r\n\r\n\r\n<div align=\"center\" style=\"margin-bottom: 2px;\">\r\n\r\n![Version](https://img.shields.io/static/v1?label=version&message=v0.3.6&color=orange&labelColor=blue)\r\n![Release Date](https://img.shields.io/github/release-date/feloopy/feloopy?label=release&color=orange&labelColor=blue)\r\n[![Downloads](https://static.pepy.tech/personalized-badge/feloopy?period=total&units=international_system&left_color=blue&right_color=orange&left_text=downloads)](https://pepy.tech/project/feloopy)\r\n![License](https://img.shields.io/static/v1?label=license&message=MIT&color=orange&labelColor=blue)\r\n\r\n</div>\r\n\r\n<br>\r\n\r\n### Quick Intro\r\n\r\nFelooPy (/f\u025blupa\u026a/) is a user-friendly tool for coding, modeling, and solving decision problems. It helps you focus on analysis and offers and supports a wide range of mathematical and statistical models and algorithms for decision-making.\r\n\r\n<br>\r\n\r\n### Quick Features\r\n\r\n- **Linear & Non-Linear Programming**: Exact algorithms for LP/NLP.\r\n- **Integer & Mixed-Integer Programming**: Exact algorithms for IP/MIP.\r\n- **General Purpose Programming**: Heuristic algorithms for various problems.\r\n- **Constraint Programming**: Techniques for constraint satisfaction.\r\n- **Multi-Objective Decision-Making**: Optimizing multiple objectives (MODM/MCDM).\r\n- **Multi-Attribute Decision-Making**: Evaluating opinions on alternatives using multiple attributes (MADM/MCDM).\r\n\r\n<br>\r\n\r\n### Quick Installation\r\n\r\nYou can install `feloopy` inside a Python>=3.10.x virtual environment:\r\n\r\n```bash\r\npip install -U \"feloopy[stock]==0.3.6\"\r\n```\r\n\r\nFor supporting the developer, testing the latest version, and reporting bugs or contributing to the codebase, use:\r\n\r\n```bash\r\npip install \"feloopy[stock] @ git+https://github.com/feloopy/feloopy.git\"\r\n```\r\n\r\n<br>\r\n\r\n### Quick Testing\r\n\r\nHere is an example to test FelooPy's functionality:\r\n\r\n```python\r\nimport feloopy as flp\r\n\r\ndef example(m):\r\n    x = m.bvar(name=\"x\")\r\n    y = m.pvar(name=\"y\", bound=[0, 1])\r\n    m.con(x + y <= 1, name=\"c1\")\r\n    m.con(x - y >= 1, name=\"c2\")\r\n    m.obj(x + y)\r\n    return m\r\n\r\nflp.search(example,directions=[\"max\"]).clean_report()\r\n```\r\n\r\n<br>\r\n\r\n\r\n### Quick 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<br>\r\n\r\n#### APA 6th/7th Edition\r\n\r\nTafakkori, K. (2024). *Efficient and feature-rich integrated decision environment* [Python Library]. Retrieved from [https://github.com/feloopy/feloopy](https://github.com/feloopy/feloopy) (Original work published April 2024).\r\n\r\n#### LaTeX/BiBTeX\r\n\r\n```\r\n@software{ktafakkori2024Apr,\r\nauthor       = {Keivan Tafakkori},\r\ntitle        = {{FelooPy: Efficient and feature-rich integrated decision environment}},\r\nyear         = {2024},\r\nmonth        = apr,\r\npublisher    = {GitHub},\r\nurl          = {https://github.com/feloopy/feloopy/}\r\n}\r\n```\r\n\r\n<br>\r\n<br>\r\n\r\n<details>\r\n<summary>Previous citations</summary>\r\n\r\n\r\n\r\n#### Versions before 0.3.6\r\n\r\n##### APA 6th/7th Edition\r\n\r\nTafakkori, 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##### LaTeX/BiBTeX\r\n```\r\n@software{ktafakkori2022Sep,\r\nauthor       = {Keivan Tafakkori},\r\ntitle        = { {FelooPy: An integrated optimization environment for AutoOR in Python} },\r\nyear         = {2022},\r\nmonth        = sep,\r\npublisher    = {GitHub},\r\nurl          = {https://github.com/ktafakkori/feloopy/}\r\n}\r\n```\r\n\r\n\r\n</details>\r\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "FelooPy: Efficient and feature-rich integrated decision environment",
    "version": "0.3.6",
    "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": "aa85a6dc01a998f41f6546544420ccb6b0c0d3ce8619feaf215287569f01b936",
                "md5": "e28476d602c955ea88646919676fef94",
                "sha256": "c88ffee7eebaea5d8124b491ecf333483a3ba95897276dc307a308d336fd692a"
            },
            "downloads": -1,
            "filename": "feloopy-0.3.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e28476d602c955ea88646919676fef94",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 193551,
            "upload_time": "2024-09-30T10:39:40",
            "upload_time_iso_8601": "2024-09-30T10:39:40.460596Z",
            "url": "https://files.pythonhosted.org/packages/aa/85/a6dc01a998f41f6546544420ccb6b0c0d3ce8619feaf215287569f01b936/feloopy-0.3.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "89c1181dd8ef58afcd80fda76ecef9de5c75b390f9cbb5e7087897b195397612",
                "md5": "2cfb5a2a02729175a7f587f612473c16",
                "sha256": "7946e512ede0ff4985a6e505900f5d27249e4b04be07d7a57e6291d89fc07b8c"
            },
            "downloads": -1,
            "filename": "feloopy-0.3.6.tar.gz",
            "has_sig": false,
            "md5_digest": "2cfb5a2a02729175a7f587f612473c16",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 118159,
            "upload_time": "2024-09-30T10:39:43",
            "upload_time_iso_8601": "2024-09-30T10:39:43.579336Z",
            "url": "https://files.pythonhosted.org/packages/89/c1/181dd8ef58afcd80fda76ecef9de5c75b390f9cbb5e7087897b195397612/feloopy-0.3.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-30 10:39:43",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ktafakkori",
    "github_project": "feloopy",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "feloopy"
}
        
Elapsed time: 1.04041s