Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
A
algorithmic_cad
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Erik Strand
algorithmic_cad
Commits
eabab8fa
Commit
eabab8fa
authored
3 years ago
by
Erik Strand
Browse files
Options
Downloads
Patches
Plain Diff
Update README
parent
e91883e9
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
cadquery/README.md
+25
-4
25 additions, 4 deletions
cadquery/README.md
with
25 additions
and
4 deletions
cadquery/README.md
+
25
−
4
View file @
eabab8fa
...
...
@@ -9,7 +9,28 @@
-
[
main repo
](
https://github.com/CadQuery/cadquery
)
-
[
GUI repo
](
https://github.com/CadQuery/CQ-editor
)
## Standalone
## About
CADQuery is a Python library for doing CAD with code. In this regard it follows in the footsteps of
[
OpenSCAD
](
https://openscad.org/
)
. However CADQuery has a higher level API that allows you to write
scripts that look more like reasonable verbal descriptions of the part (or at least what you'd do to
make it in a standard CAD program). In particular, it's easy to define new workplanes, make 2D
sketches in them, and extrude, as one would in standard CAD. CADQuery also has support for common
operations like filleting, chamfers, and hollowing (making shells). And it supports constraints!
CADQuery started as a wrapper around the
[
FreeCAD
](
https://www.freecadweb.org/
)
API. But now it's
built on top of the underlying
[
Open CASCADE
kernel
](
https://www.opencascade.com/open-cascade-technology/
)
directly so that it can support some
more advanced geometric selection and editing.
Most importantly, CADQuery functions as a Python library, so you can write Python scripts that
generate geometry and export it (as STL, STEP, etc.). There's also a dedicated GUI that shows your
code in one pane, and the constructed part in another (along with a console and some debugging
info).
## Installation
### Standalone
The instructions here are based off of
[
this video
](
https://www.youtube.com/watch?v=sjLTePOq8bQ
)
.
...
...
@@ -48,12 +69,12 @@ Type "help", "copyright", "credits" or "license" for more information.
<cadquery.cq.Workplane object at 0x7fd6a24b21d0>
```
## GUI
##
#
GUI
There are several ways to install the CADQuery GUI. Their website recommends using an installer
script, but I would recommend using Miniconda as we did for the standalone version.
### Miniconda
###
#
Miniconda
First, clone the
[
CADQuery Editor repo
](
https://github.com/CadQuery/CQ-editor
)
. From within that
project, run
`conda env create -f cqgui_env.yml -n cqgui`
, followed by
`conda activate cqgui`
. You
...
...
@@ -63,7 +84,7 @@ Note: In theory, you can also install the GUI without cloning any repos by makin
environment (e.g.
`conda create -n cqgui`
), activating it (
`conda activate cqgui`
), and running
`conda install -c cadquery -c conda-forge cq-editor=master`
. But this didn't work for me.
### Installer Script
###
#
Installer Script
The easiest way to install the GUI is to download and extract the
[
zipped
release
](
https://github.com/CadQuery/CQ-editor/releases
)
for your system. It contains a script
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment