Installation

Installation#

Library#

This library utilizes the Mosek Solver. While it is possible to use any solver compatible with CVXPY, it is recommended to use Mosek for optimal performance. Please follow the installation instructions on the Mosek website to set it up.

To ensure a clean and isolated development environment, it is recommended to use Python’s virtual environment (venv).

Linux / macOS#

python3.12 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Windows#

py -m venv venv
.\venv\Scripts\activate
pip install -r requirements.txt

Documentation#

Navigate to the docs folder:

cd docs

Create and activate a virtual environment:

python3.12 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Generate the documentation:

make html

Once the HTML files are created, you can serve them locally:

python -m http.server --directory build/html 8000

Open your browser and visit:

http://localhost:8000

Contents