search

jmwright / cadquery-gui

An Electron-based GUI for CadQuery
Apache License 2.0
38 stars 3 forks source link

readme

cadquery-gui (cqg)

An Electron-based CAD GUI built for CadQuery.

Note: Unless you have a compelling reason to use cadquery-gui, it is recommended that you transition to CQ-editor as it has better support and is fully CadQuery 2.x compatible.

User Interface Overview

General Prerequisites

  1. Install npm

CadQuery 1.0 Prerequisites

If you are wanting to use the FreeCAD based version of CadQuery (version 1.x), follow these prerequisite installation instructions.

  1. Install FreeCAD (>=0.16)
  2. Install the latest version of CadQuery from the GitHub repo. 
    pip install git+https://github.com/dcowden/cadquery.git

CadQuery 2.0 Prerequisites

NOTE: caduqery-gui is not yet compatible with the OCP (latest) version of CadQuery 2.0. Tessellation works differently in the new CadQuery version which has broken show_object processing and display.

If you are wanting to use the PythonOCC based version of CadQuery (version 2.x), follow these prerequisite installation instructions.

  1. Create a cadquery Anaconda environment conda create --name cadquery
  2. Activate the conda environment conda activate cadquery
  3. Follow the instructions here to install the prerequisites.

Install The Latest Development Version of cadquery-gui

The latest version can be cloned directly from this GitHub repo.

git clone https://github.com/jmwright/cadquery-gui.git
cd cadquery-gui/
npm install

Run The Latest Development Version of cadquery-gui

npm start