You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+35-76Lines changed: 35 additions & 76 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,6 +27,10 @@ CadQuery is often compared to [OpenSCAD](http://www.openscad.org/). Like OpenSCA
27
27
4. CadQuery scripts require less code to create most objects, because it is possible to locate features based on the position of other features, workplanes, vertices, etc.
28
28
5. CadQuery scripts can build STL, STEP, AMF and 3MF faster than OpenSCAD.
29
29
30
+
CadQuery was built to be used as a Python library without any GUI. This makes it great for use cases such as integration into servers, or creating scientific and engineering scripts. Options for visualziation are also available including CQ-Editor and JupyterLab.
31
+
32
+
For those who are interested, the [OCP repository](https://github.com/CadQuery/OCP) contains the current OCCT wrapper used by CQ.
33
+
30
34
### Key features
31
35
* Build 3D models with scripts that are as close as possible to how you would describe the object to a human.
32
36
* Create parametric models that can be very easily customized by end users.
@@ -43,86 +47,55 @@ The original version of CadQuery was built on the FreeCAD API. This was great be
43
47
44
48
To learn more about designing with CadQuery, visit the [documentation](https://cadquery.readthedocs.io/en/latest/intro.html), [examples](https://cadquery.readthedocs.io/en/latest/examples.html), and [cheatsheet](https://cadquery.readthedocs.io/en/latest/_static/cadquery_cheatsheet.html).
45
49
46
-
To get started playing around with CadQuery and see it's capabilities, take a look at the [CQ-editor GUI](https://github.com/CadQuery/CQ-editor). This easy-to-use IDE is a great way to get started desiging with CadQuery.
50
+
To get started playing around with CadQuery and see its capabilities, take a look at the [CQ-editor GUI](https://github.com/CadQuery/CQ-editor). This easy-to-use IDE is a great way to get started desiging with CadQuery.
47
51
48
-
There are currently 4 different ways to use CadQuery for designing your next project:
49
-
* Using the [CQ-editor GUI](https://github.com/CadQuery/CQ-editor)
50
-
* From a [Jupyter notebook](https://github.com/bernhard-42/jupyter-cadquery)
51
-
* Using a [VSCode extension](https://marketplace.visualstudio.com/items?itemName=roipoussiere.cadquery)
52
-
* As a standalone library
53
-
* Linux [installation video](https://youtu.be/sjLTePOq8bQ)
54
-
* Windows [installation video](https://youtu.be/3Tg_RJhqZRg)
52
+
See the documentation for detailed CadQuery [installation instructions](https://cadquery.readthedocs.io/en/latest/installation.html).
55
53
54
+
There are also videos covering installation:
56
55
57
-
There are two ways to install CadQuery and its dependencies. One is using conda, and the other is using pip. Pip is shown first below, followed by two sections on installing CadQuery via conda, and a non-intrusive way to install conda on a system. Note that conda is the better supported option.
58
-
59
-
### CadQuery Installation Via Pip
60
-
61
-
CadQuery has a complex set of dependencies including OCP, which is our set of bindings to the OpenCASCADE CAD kernel. OCP is distributed as binary wheels for Linux, MacOS and Windows. However, there are some limitations. Only Python 3.8 through 3.10 are currently supported, and some older Linux distributions such as Ubuntu 18.04 are not supported. If the pip installation method does not work for your system, you can try the conda installation method outlined in the next two sections.
56
+
* Linux [installation video](https://youtu.be/sjLTePOq8bQ)
57
+
* Windows [installation video](https://youtu.be/3Tg_RJhqZRg)
62
58
63
-
It is highly recommended that a virtual environment is used when installing CadQuery, although it is not strictly required. Installing CadQuery via pip requires a up-to-date version of pip, which can be obtained with the following command line (or a slight variation thereof).
64
-
```
65
-
python3 -m pip install --upgrade pip
66
-
```
67
-
Once a current version of pip is installed, CadQuery can be installed using the following command line.
68
-
```
69
-
pip install cadquery
70
-
```
59
+
There are two ways to install CadQuery and its dependencies. One is using conda, and the other is using pip. Note that conda is the better supported option.
71
60
72
-
It is also possible to install the very latest changes directly from CadQuery's GitHub repository, with the understanding that sometimes breaking changes can occur. To install from the git repository, run the following command line.
You should now have a working CadQuery installation, but developers or users who want to use CadQuery with IPython/Jupyter or to set up a developer environment can read the rest of this section.
63
+
To first install the Conda package manager see [Install the Conda Package Manager](https://cadquery.readthedocs.io/en/latest/installation#install-the-conda-package-manager).
78
64
79
-
If you are installing CadQuery to use with IPython/Jupyter, you may want to run the following command line to install the extra dependencies.
80
-
```
81
-
pip install cadquery[ipython]==2.2.0b2
82
-
```
65
+
The steps to install cadquery with conda are as follows:
83
66
84
-
If you want to create a developer setup to contribute to CadQuery, the following command line will install all the development dependencies that are needed.
85
-
```
86
-
pip install cadquery[dev]==2.2.0b2
87
-
```
88
-
89
-
### CadQuery Installation Via Conda
90
-
91
-
conda is included as part of a [miniforge](https://github.com/conda-forge/miniforge) installation (other distributions can be used as well). See the next section for more details regarding conda. The steps to install cadquery are as follows:
92
67
```
93
68
# Set up a new environment
94
69
conda create -n cadquery
95
70
96
71
# Activate the new environment
97
72
conda activate cadquery
98
73
99
-
# CadQuery development is moving quickly, so it is best to install the latest version from GitHub master
74
+
# Install the latest released version
75
+
conda install -c conda-forge cadquery occt=7.7.0
76
+
77
+
# Or install the dev version to get the latest changes
For those who are interested, the [OCP repository](https://github.com/CadQuery/OCP) contains the current OCCT wrapper used by CQ.
81
+
### CadQuery Installation Via Pip
104
82
105
-
### Conda Installation
83
+
CadQuery has a complex set of dependencies including OCP, which is our set of bindings to the OpenCASCADE CAD kernel. OCP is distributed as binary wheels for Linux, MacOS and Windows. However, there are some limitations. Only Python 3.8 through 3.10 are currently supported, and some older Linux distributions such as Ubuntu 18.04 are not supported. If the pip installation method does not work for your system, you can try the conda installation method.
106
84
107
-
For those unfamiliar (or uncomfortable) with conda, it is probably best to install Miniforge to a local directory and to avoid running `conda init`. After performing a local directory installation, Miniforge can be activated via the [scripts,bin]/activate scripts. This will help avoid polluting and breaking the local Python installation. In Linux, the local directory installation method looks something like this:
85
+
It is highly recommended that a virtual environment is used when installing CadQuery, although it is not strictly required. Installing CadQuery via pip requires a up-to-date version of pip, which can be obtained with the following command line (or a slight variation thereof).
It is also possible to install the very latest changes directly from CadQuery's GitHub repository, with the understanding that sometimes breaking changes can occur. To install from the git repository, run the following command line.
124
95
```
125
-
You might want to consider using `/NoScripts=0` to have an activation shortcut added to the start menu.
A list of Docker images can be found [here](https://github.com/RubenRubens/cq-containers), and includes images for the following projects.
151
-
*[Core CadQuery library](https://github.com/RubenRubens/cq-containers/tree/master/cq-conda), which allows users to run CadQuery Python scripts without a GUI.
152
-
*[cq-cli](https://github.com/RubenRubens/cq-containers/tree/master/cq-cli), a command line utility which is used to export the results of a CadQuery script to an output format (i.e. STL, STEP).
153
-
*[jupyter-cadquery](https://github.com/bernhard-42/jupyter-cadquery#b-using-a-docker-image), makes CadQuery accessible through Jupyter Labs and provides a web-based GUI. This is currently the only image that provides a GUI.
154
-
155
-
### Standalone Stable Version
156
-
157
-
CadQuery was built to be used as a Python library without any GUI. This makes it great for use cases such as integration into servers, or creating scientific and engineering scripts. Use Anaconda/Miniconda to install CadQuery, and then add `import cadquery` to the top of your Python scripts. If the stable version of CadQuery is desired, the following command will install it. However, be aware that the stable version can fall significantly behind the current state of CadQuery, so in many cases the `master` installation method at the beginning of the Getting Started section is preferable.
0 commit comments