73 lines
2.3 KiB
ReStructuredText
73 lines
2.3 KiB
ReStructuredText
.. _installation:
|
|
|
|
Installing CadQuery
|
|
===================================
|
|
|
|
CadQuery is based on `FreeCAD <http://sourceforge.net/apps/mediawiki/free-cad/index.php?title=Main_Page>`_,
|
|
which is turn based on the open-source `OpenCascade <http://www.opencascade.com/>`_ modelling kernel.
|
|
|
|
Prerequisites--FreeCAD and Python 2.6 or 2.7
|
|
----------------------------------------------
|
|
CadQuery requires FreeCAD and Python version 2.6.x or 2.7.x *Python 3.x is NOT supported*
|
|
|
|
Installation
|
|
-------------------
|
|
|
|
Ubuntu
|
|
^^^^^^^^^^^^^^
|
|
|
|
On Ubuntu, you can type::
|
|
|
|
sudo apt-get install -y freecad freecad-doc
|
|
pip install cadquery
|
|
|
|
This `Unix Installation Video <http://youtu.be/InZu8jgaYCA>`_ will walk you through the installation
|
|
|
|
|
|
Windows & Mac
|
|
^^^^^^^^^^^^^^^^^^^^
|
|
|
|
1. Install FreeCAD using the appropriate installer for your platform, on `www.freecadweb.org <http://www.freecadweb.org/wiki/?title=Download>`_
|
|
2. pip install cadquery
|
|
|
|
This `Windows Installation video <https://www.youtube.com/watch?v=dWw4Y_ah-8k>`_ will walk you through the installation on Windows
|
|
|
|
|
|
Anaconda (cross-platform)
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Alternatively you can use Anaconda's package management system to install
|
|
cadquery and its dependencies, including FreeCAD.
|
|
|
|
1. Install `Anaconda <https://www.anaconda.com/download>`_
|
|
2. Open an anaconda prompt and run:
|
|
|
|
::
|
|
|
|
conda install -c conda-forge cadquery
|
|
|
|
|
|
Test Your Installation
|
|
------------------------
|
|
|
|
If all has gone well, you can open a command line/prompt, and type::
|
|
|
|
$ python
|
|
>>> import cadquery
|
|
>>> cadquery.Workplane('XY').box(1,2,3).toSvg()
|
|
|
|
Adding a Nicer GUI via the cadquery-freecad-module
|
|
--------------------------------------------------------
|
|
|
|
If you prefer to have a GUI available, your best option is to use
|
|
`The CadQuery Freecad Module <https://github.com/jmwright/cadquery-freecad-module>`_.
|
|
|
|
Simply extract cadquery-freecad-module into your FreeCAD installation. You'll end up
|
|
with a cadquery workbench that allows you to interactively run scripts, and then see the results in the FreeCAD GUI
|
|
|
|
Zero Step Install
|
|
-------------------------------------------------
|
|
|
|
If you would like to use cadquery with no installation all, you can
|
|
use mybinder to `launch a Jupyter Notebook Server <https://mybinder.org/v2/gh/RustyVermeer/tryCQ/master>`_ pre-configured to run CadQuery.
|