Installation

Supported platforms: $\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 $\text{{\footnotesize{SC}}{\small{vx}}{\footnotesize{GEN}}}$ on your machine.

Step 1: Clone $\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 $\text{{\footnotesize{SC}}{\small{vx}}{\footnotesize{GEN}}}$ :

pip install -e .

Step 1: Navigate to the tests directory:

bash
cd tests

Step 2: Run the following command(s):

pip install -U pytest
pytest