Skip to main content

Documentation Index

Fetch the complete documentation index at: https://scvxgen.com/llms.txt

Use this file to discover all available pages before exploring further.

Supported platforms: SCvxGEN\text{{\footnotesize{SC}}{\small{vx}}{\footnotesize{GEN}}} is currently supported on Linux and macOS.
Prerequisite: These instructions assume you have conda installed on your machine.

​
Instructions

Follow these steps to install and run SCvxGEN\text{{\footnotesize{SC}}{\small{vx}}{\footnotesize{GEN}}} on your machine. Step 1: Clone SCvxGEN\text{{\footnotesize{SC}}{\small{vx}}{\footnotesize{GEN}}}:
git
git clone https://github.com/abhikamath/scvxgen.git
Step 2: Navigate to the scvxgen directory:
bash
cd scvxgen
Step 3: Create a conda environment and activate it:
conda
conda create --name scvxgen
conda activate scvxgen
Step 4: Install pip:
pip
conda install pip
This should also automatically install Python in the scvxgen environment. Step 5: Install SCvxGEN\text{{\footnotesize{SC}}{\small{vx}}{\footnotesize{GEN}}}: 
pip install -e .

​
Test Installation

Step 1: Navigate to the tests directory:
bash
cd tests
Step 2: Run the following command(s): 
pip install pytest pytest-xdist
pytest -n auto