# Installation

## Quick Install (pip)

OpenVCAD is available on PyPI. Supported Python versions: **3.11, 3.12, and 3.13**
on Windows, Linux, and macOS (Apple Silicon).

```bash
pip install OpenVCAD
```

This installs `pyvcad`, `pyvcad_compilers`, and `pyvcad_rendering`.

## Recommended Setup

We **strongly recommend** using a virtual environment to keep dependencies
clean and avoid conflicts with other Python projects.

### 1. Create a project directory

```bash
mkdir my_openvcad_project
cd my_openvcad_project
```

### 2. Create and activate a virtual environment

```bash
# macOS / Linux
python3 -m venv venv
source venv/bin/activate

# Windows
python -m venv venv
venv\Scripts\activate
```

You should see `(venv)` at the beginning of your prompt.

### 3. Install OpenVCAD

```bash
pip install --upgrade pip
pip install OpenVCAD
```

### 4. Verify the installation

```python
import pyvcad as pv
print(pv.version())
```

## Getting the Examples

Clone the examples repository to get started with runnable demos:

```bash
git clone https://github.com/MacCurdyLab/OpenVCAD-Public.git
cd OpenVCAD-Public/examples
```

See the [Getting Started](getting-started.md) guide for a walkthrough of the
example scripts.

## Getting the Source Code

The OpenVCAD source code is open-source under a **non-commercial license**.
You can request access to the source repository here:

[Request Access Form](https://forms.gle/MAjCmG66xZ6p1JcE9)

## Deactivating the Virtual Environment

When you are done working, deactivate the environment with:

```bash
deactivate
```

Reactivate later with `source venv/bin/activate` (macOS/Linux) or
`venv\Scripts\activate` (Windows).