Skip to content

Commit 85663cb

Browse files
jmwrightmarcus7070
authored andcommitted
Added Docker section to readme and fixed two small doc errors
1 parent 7f9cde3 commit 85663cb

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,13 @@ CadQuery supports Jupyter notebook out of the box using the jupyter-cadquery ext
9292

9393
<img src="https://raw.githubusercontent.com/bernhard-42/jupyter-cadquery/master/screenshots/0_intro.png" alt="CadQuery Jupyter extension screenshot" width="800"/>
9494

95+
### Docker
96+
97+
A list of Docker images can be found [here](https://github.com/RubenRubens/cq-containers), and includes images for the following projects.
98+
* [Core CadQuery library](https://github.com/RubenRubens/cq-containers/tree/master/cq-conda), which allows users to run CadQuery Python scripts without a GUI.
99+
* [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).
100+
* [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.
101+
95102
### Standalone Stable Version
96103

97104
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.

cadquery/cq.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1961,7 +1961,7 @@ def parametricCurve(
19611961
:param N: number of points for discretization
19621962
:param start: starting value of the parameter t
19631963
:param stop: final value of the parameter t
1964-
:param tol: tolerance of the algorithm (default: 1e-3)
1964+
:param tol: tolerance of the algorithm (default: 1e-6)
19651965
:param minDeg: minimum spline degree (default: 1)
19661966
:param maxDeg: maximum spline degree (default: 6)
19671967
:param smoothing: optional parameters for the variational smoothing algorithm (default: (1,1,1))
@@ -2626,7 +2626,7 @@ def polygon(
26262626
26272627
The first vertex is always oriented in the x direction.
26282628
2629-
:param nSides: number of sides, must be > 3
2629+
:param nSides: number of sides, must be >= 3
26302630
:param diameter: the size of the circle the polygon is inscribed into
26312631
:return: a polygon wire
26322632
"""

0 commit comments

Comments
 (0)