> ## Documentation Index
> Fetch the complete documentation index at: https://scvxgen.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

<Note>
  **Supported platforms**: $\text{{\footnotesize{SC}}{\small{vx}}{\footnotesize{GEN}}}$ is currently supported on Linux and macOS.
</Note>

<Info>
  **Prerequisite**: These instructions assume you have `conda` installed on your machine.
</Info>

## 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}}}$:

```bash git theme={null}
git clone https://github.com/abhikamath/scvxgen.git
```

**Step 2**: Navigate to the `scvxgen` directory:

```bash bash theme={null}
cd scvxgen
```

**Step 3**: Create a `conda` environment and activate it:

```bash conda theme={null}
conda create --name scvxgen
conda activate scvxgen
```

**Step 4**: Install `pip`:

```bash pip theme={null}
conda install pip
```

This should also automatically install Python in the `scvxgen` environment.

**Step 5**: Install $\text{{\footnotesize{SC}}{\small{vx}}{\footnotesize{GEN}}}$:

<CodeGroup>
  ```bash regular theme={null}
  pip install -e .
  ```

  ```bash test theme={null}
  pip install -e ".[test]"
  ```
</CodeGroup>

## Test Installation

**Step 1**: Navigate to the `tests` directory:

```bash bash theme={null}
cd tests
```

**Step 2**: Run the following command(s):

<CodeGroup>
  ```bash regular theme={null}
  pip install pytest pytest-xdist
  pytest -n auto
  ```

  ```bash test theme={null}
  pytest -n auto
  ```
</CodeGroup>