Skip to content

Commit

Permalink
Add CQ-editor installer instructions (#1340)
Browse files Browse the repository at this point in the history
* Add CQ-editor installer instructions

* Fix README link

* Minor tweaks

---------

Co-authored-by: AU <adam-urbanczyk@users.noreply.github.com>
  • Loading branch information
lorenzncode and adam-urbanczyk authored Jun 4, 2023
1 parent 0fc683c commit 7143ead
Show file tree
Hide file tree
Showing 2 changed files with 79 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,10 @@ The original version of CadQuery was built on the FreeCAD API. This was great be

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

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.
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. The CQ-editor installer bundles both CQ-editor and CadQuery (recommended). See the [CQ-editor installation instructions](https://cadquery.readthedocs.io/en/latest/installation.html#adding-a-nicer-gui-via-cq-editor).


The CadQuery library (with or without CQ-editor) and its dependencies may be installed using conda, or pip. Note that conda (or the CQ-editor installer) is the better supported option.

See the documentation for detailed CadQuery [installation instructions](https://cadquery.readthedocs.io/en/latest/installation.html).

Expand All @@ -56,11 +59,9 @@ There are also videos covering installation:
* Linux [installation video](https://youtu.be/sjLTePOq8bQ)
* Windows [installation video](https://youtu.be/3Tg_RJhqZRg)

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.

### CadQuery Installation Via Conda

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).
To first install the Conda package manager see [Install the Conda Package Manager](https://cadquery.readthedocs.io/en/latest/installation.html#install-the-conda-package-manager).

The steps to install cadquery with conda are as follows:

Expand Down
74 changes: 74 additions & 0 deletions doc/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
Installing CadQuery
===================

To install both Cadquery and CQ-Editor together with a single installer see the instructions below `Adding a Nicer GUI via CQ-editor`_.

CadQuery may be installed with either conda or pip. The conda installation method is the better tested and more mature option.


Expand Down Expand Up @@ -100,6 +102,78 @@ Adding a Nicer GUI via CQ-editor
If you prefer to have a GUI available, your best option is to use
`CQ-editor <https://github.com/CadQuery/CQ-editor>`_.


You can download the newest build `here`_. Install and run the *run.sh* (Linux/MacOS) or *run.bat* (Windows) script in the root CQ-editor directory. The CQ-editor window should launch.

.. _here: https://github.com/CadQuery/CQ-editor/releases/tag/nightly

Linux/MacOS
```````````

1. Download the installer (.sh script matching OS and platform).

2. Select the script in the file browser and make executable. Choose **Properties** from the context menu and select **Permissions**, **Allow executing file as a program** (or similar, this step varies depending on OS and window manager).

3. Select the script in the file browser and choose **Run as Program** (or similar).

Follow the prompts to accept the license and optionally change the installation location.

The default installation location is ``/home/<username>/cq-editor``.

4. Launch the **run.sh** script from the file brower (again make executable first and then run as program).


To install from command line, download the installer using curl or wget or your favorite program and run the script.::

curl -LO https://github.com/CadQuery/CQ-editor/releases/download/nightly/CQ-editor-master-Linux-x86_64.sh
sh CQ-editor-master-Linux-x86_64.sh


To run from command.::

$HOME/cq-editor/run.sh


Windows
```````

1. Download the installer (.exe) and double click it on the file browser.

Follow the prompts to accept the license and optionally change the installation location.

The default installation location is ``C:\Users\<username>\cq-editor``.

2. Launch the **run.bat** script from the file brower (select **Open**).


To run from command line, activate the environment, then run cq-editor::

C:\Users\<username>\cq-editor\run.bat


Installing extra packages
```````````````````````````

*mamba*, and *pip* are bundled with the CQ-editor installer and available for package installation.

First activate the environment, then call mamba or pip to install additional packages.

On windows.::

C:\Users\<username>\cq-editor\Scripts\activate
mamba install <packagename>

On Linux/MacOS. ::

source $HOME/cq-editor/bin/activate
mamba install <packagename>


Adding CQ-editor to an Existing Environment
--------------------------------------------

You can install CQ-editor into a conda environment or Python virtual environment using conda (mamba) or pip.

Example cq-editor installation with conda (this installs both cadquery and cq-editor)::

conda create -n cqdev
Expand Down

0 comments on commit 7143ead

Please sign in to comment.