Installation#
Warning
OpenVCAD 2 is deprecated and frozen at version 2.3.8. New projects should use
OpenVCAD v3. Version 3 is not
directly backwards compatible, so existing version 2 scripts must be updated
before they can run with version 3. Continue to use OpenVCAD==2.3.8 for
legacy projects that have not yet been migrated.
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).
pip install OpenVCAD==2.3.8
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#
mkdir my_openvcad_project
cd my_openvcad_project
2. Create and activate a virtual environment#
# 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#
pip install --upgrade pip
pip install OpenVCAD==2.3.8
4. Verify the installation#
import pyvcad as pv
print(pv.version())
Getting the Examples#
Clone the examples repository to get started with runnable demos:
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.
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:
Deactivating the Virtual Environment#
When you are done working, deactivate the environment with:
deactivate
Reactivate later with source venv/bin/activate (macOS/Linux) or
venv\Scripts\activate (Windows).