cvxRiskOpt

Name	cvxRiskOpt JSON
Version	0.1.4 JSON
	download
home_page	https://github.com/TSummersLab/cvxRiskOpt
Summary	Risk-Based Optimization tool using CVXPY and CVXPYgen
upload_time	2024-05-07 19:24:35
maintainer	Sleiman Safaoui
docs_url	None
author	Sleiman Safaoui, Tyler Summers
requires_python	>=3.10
license	GPL-3.0
keywords	dro risk optimization robust code generation mpc
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # CVXPY Risk Optimization

A package for risk-based optimization using CVXPY and CVXPYgen.

## Installation

### Installing from PyPI
The package can be installed using pip:
```
pip install cvxRiskOpt
```
Notes:
- The installation will also include cvxpy and cvxpygen.
- Please refer to cvxpy's documentation for [installing additional solvers](https://www.cvxpy.org/install/).
- Compiling code with Clarabel requires `Rust`, `Eigen`, and `cbindgen`. (e.g. These can be installed with `homebrew` on MacOS) 

### Installing from source
- Clone/Download the package
- Create and activate conda env 
```
conda create --name cvxRiskOpt python=3.10 pip -y
conda activate cvxRiskOpt
```
- Install dependencies (see `setup.py`)
- Install the package
```
python3 -m pip install -e .
```

## Tests
To run tests, execute the following from the root of the package.
```
pytest
```

## Examples
There are several examples in `examples` demonstrating the usage of the package.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/TSummersLab/cvxRiskOpt",
    "name": "cvxRiskOpt",
    "maintainer": "Sleiman Safaoui",
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "snsafaoui@gmail.com",
    "keywords": "dro, risk, optimization, robust, code generation, mpc",
    "author": "Sleiman Safaoui, Tyler Summers",
    "author_email": "snsafaoui@gmail.com, tyler.summers@utdallas.edu",
    "download_url": "https://files.pythonhosted.org/packages/f2/4f/657c003470dddc73b2aec26215928e7df8ad716cceaf6c1c95a777415807/cvxriskopt-0.1.4.tar.gz",
    "platform": null,
    "description": "# CVXPY Risk Optimization\n\nA package for risk-based optimization using CVXPY and CVXPYgen.\n\n## Installation\n\n### Installing from PyPI\nThe package can be installed using pip:\n```\npip install cvxRiskOpt\n```\nNotes:\n- The installation will also include cvxpy and cvxpygen.\n- Please refer to cvxpy's documentation for [installing additional solvers](https://www.cvxpy.org/install/).\n- Compiling code with Clarabel requires `Rust`, `Eigen`, and `cbindgen`. (e.g. These can be installed with `homebrew` on MacOS) \n\n### Installing from source\n- Clone/Download the package\n- Create and activate conda env \n```\nconda create --name cvxRiskOpt python=3.10 pip -y\nconda activate cvxRiskOpt\n```\n- Install dependencies (see `setup.py`)\n- Install the package\n```\npython3 -m pip install -e .\n```\n\n## Tests\nTo run tests, execute the following from the root of the package.\n```\npytest\n```\n\n## Examples\nThere are several examples in `examples` demonstrating the usage of the package.\n",
    "bugtrack_url": null,
    "license": "GPL-3.0",
    "summary": "Risk-Based Optimization tool using CVXPY and CVXPYgen",
    "version": "0.1.4",
    "project_urls": {
        "Homepage": "https://github.com/TSummersLab/cvxRiskOpt"
    },
    "split_keywords": [
        "dro",
        " risk",
        " optimization",
        " robust",
        " code generation",
        " mpc"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "96fb822829ad50d118285cab9e4eaf75a51d78ef1108266d1a76599a3ee0307a",
                "md5": "c9cdf409d4f127178d5f02e90086c7f5",
                "sha256": "5cd907ef4a63a0db7cad34a699f8abe75db26af3c191e7d3e9211788f2639fbf"
            },
            "downloads": -1,
            "filename": "cvxRiskOpt-0.1.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c9cdf409d4f127178d5f02e90086c7f5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 26929,
            "upload_time": "2024-05-07T19:24:33",
            "upload_time_iso_8601": "2024-05-07T19:24:33.769121Z",
            "url": "https://files.pythonhosted.org/packages/96/fb/822829ad50d118285cab9e4eaf75a51d78ef1108266d1a76599a3ee0307a/cvxRiskOpt-0.1.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f24f657c003470dddc73b2aec26215928e7df8ad716cceaf6c1c95a777415807",
                "md5": "578d310c078b2e32d1771773de1fca41",
                "sha256": "8b28b0eebd916c197c537cc7f5fbd1f4d0348f63575c567e35d2c8f35a6e13ca"
            },
            "downloads": -1,
            "filename": "cvxriskopt-0.1.4.tar.gz",
            "has_sig": false,
            "md5_digest": "578d310c078b2e32d1771773de1fca41",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 30444,
            "upload_time": "2024-05-07T19:24:35",
            "upload_time_iso_8601": "2024-05-07T19:24:35.541202Z",
            "url": "https://files.pythonhosted.org/packages/f2/4f/657c003470dddc73b2aec26215928e7df8ad716cceaf6c1c95a777415807/cvxriskopt-0.1.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-07 19:24:35",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "TSummersLab",
    "github_project": "cvxRiskOpt",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "cvxriskopt"
}