Skip to content

Commit

Permalink
Added Docker section to readme and fixed two small doc errors
Browse files Browse the repository at this point in the history
  • Loading branch information
jmwright authored and marcus7070 committed May 8, 2021
1 parent 7f9cde3 commit 85663cb
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,13 @@ CadQuery supports Jupyter notebook out of the box using the jupyter-cadquery ext

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

### Docker

A list of Docker images can be found [here](https:/RubenRubens/cq-containers), and includes images for the following projects.
* [Core CadQuery library](https:/RubenRubens/cq-containers/tree/master/cq-conda), which allows users to run CadQuery Python scripts without a GUI.
* [cq-cli](https:/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).
* [jupyter-cadquery](https:/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.

### Standalone Stable Version

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.
Expand Down
4 changes: 2 additions & 2 deletions cadquery/cq.py
Original file line number Diff line number Diff line change
Expand Up @@ -1961,7 +1961,7 @@ def parametricCurve(
:param N: number of points for discretization
:param start: starting value of the parameter t
:param stop: final value of the parameter t
:param tol: tolerance of the algorithm (default: 1e-3)
:param tol: tolerance of the algorithm (default: 1e-6)
:param minDeg: minimum spline degree (default: 1)
:param maxDeg: maximum spline degree (default: 6)
:param smoothing: optional parameters for the variational smoothing algorithm (default: (1,1,1))
Expand Down Expand Up @@ -2626,7 +2626,7 @@ def polygon(
The first vertex is always oriented in the x direction.
:param nSides: number of sides, must be > 3
:param nSides: number of sides, must be >= 3
:param diameter: the size of the circle the polygon is inscribed into
:return: a polygon wire
"""
Expand Down

0 comments on commit 85663cb

Please sign in to comment.