< Back to Developer Documentation

Getting Started

These instructions assume that you are running Linux. If you are a developer running Windows or MacOS, please feel free to open an issue and ask that these instructions be updated for those operating systems. Pull requests are also welcome, and can be submitted for these docs as well.

Before Starting

It is highly recommended that you set up a virtual environment for CQCad development. Once you have activated the virtual environment you can follow the procedure below to get the app up and running.

Clone

Clone this repository to your local system.

git clone --recursive https://github.com/jmwright/cqcad.git

Notice the recursive option in the line below. Extensions and layouts are often included in this repository as git submodules. Without the recursive clone you will not get everything that is needed for the applicaiton to run properly. Downloading the zip of the repo from GitHub will not provide you with all the submodules either.

Install Pre-Requisites

For now, Anaconda is used to set up the PythonOCC environment. Eventaully PythonOCC will be embedded with this application. Be sure to install the Python 3.x version of Anaconda.

source ~/ANACONDA_INSTALL_DIR/bin/activate 
conda create -n cq-occ-testing -c pythonocc -c oce -c conda-forge -c dlr-sc -c CadQuery cadquery-occ
source activate cq-occ-testing

Change into the cqcad root directory and install the pre-requisite Python packages.

cd cqcad/
pip install -r requirements.txt

PyQt5 is one of the pre-requisites installed, and is the framework used to create the GUI portion of CQCad.

Run CQCad

cqcad/cqcad/cqcad.py is the entry point for the application. When you run it, the main CQCad window should appear and be functional.

cd cqcad/
./cqcad.py

Looking Around