Installation#

Supported Python versions: 3.12, 3.13, and 3.14 on Windows, Linux, and macOS. Pre-built wheels are published for those three versions only, so Python 3.11 and older cannot install OpenVCAD with pip.

Platform requirements for the pre-built wheels:

  • Windows: 64-bit.

  • Linux: 64-bit with glibc 2.39 or newer (manylinux_2_39), e.g. Ubuntu 24.04.

  • macOS: macOS 15 or newer on Apple silicon (arm64). The wheels are built with a macOS 15.0 deployment target, so pip finds no compatible wheel on older macOS releases.

Updating OpenVCAD#

To update to a newer version of OpenVCAD:

  1. Activate your dedicated OpenVCAD virtual environment.

  2. Run pip install with the --upgrade flag:

python -m pip install --upgrade OpenVCAD

Getting the Examples#

Clone the public repository to get started with runnable examples:

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

See the Getting Started guide for a walkthrough of the example scripts.

Deactivating the Virtual Environment#

When you are done working, deactivate the environment with:

deactivate

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