|
4 | 4 | Installing CadQuery
|
5 | 5 | ===================
|
6 | 6 |
|
| 7 | +To install both Cadquery and CQ-Editor together with a single installer see the instructions below `Adding a Nicer GUI via CQ-editor`_. |
| 8 | + |
7 | 9 | CadQuery may be installed with either conda or pip. The conda installation method is the better tested and more mature option.
|
8 | 10 |
|
9 | 11 |
|
@@ -100,6 +102,78 @@ Adding a Nicer GUI via CQ-editor
|
100 | 102 | If you prefer to have a GUI available, your best option is to use
|
101 | 103 | `CQ-editor <https://github.com/CadQuery/CQ-editor>`_.
|
102 | 104 |
|
| 105 | + |
| 106 | +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. |
| 107 | + |
| 108 | +.. _here: https://github.com/CadQuery/CQ-editor/releases/tag/nightly |
| 109 | + |
| 110 | +Linux/MacOS |
| 111 | +``````````` |
| 112 | + |
| 113 | +1. Download the installer (.sh script matching OS and platform). |
| 114 | + |
| 115 | +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). |
| 116 | + |
| 117 | +3. Select the script in the file browser and choose **Run as Program** (or similar). |
| 118 | + |
| 119 | + Follow the prompts to accept the license and optionally change the installation location. |
| 120 | + |
| 121 | + The default installation location is ``/home/<username>/cq-editor``. |
| 122 | + |
| 123 | +4. Launch the **run.sh** script from the file brower (again make executable first and then run as program). |
| 124 | + |
| 125 | + |
| 126 | +To install from command line, download the installer using curl or wget or your favorite program and run the script.:: |
| 127 | + |
| 128 | + curl -LO https://github.com/CadQuery/CQ-editor/releases/download/nightly/CQ-editor-master-Linux-x86_64.sh |
| 129 | + sh CQ-editor-master-Linux-x86_64.sh |
| 130 | + |
| 131 | + |
| 132 | +To run from command.:: |
| 133 | + |
| 134 | + $HOME/cq-editor/run.sh |
| 135 | + |
| 136 | + |
| 137 | +Windows |
| 138 | +``````` |
| 139 | + |
| 140 | +1. Download the installer (.exe) and double click it on the file browser. |
| 141 | + |
| 142 | + Follow the prompts to accept the license and optionally change the installation location. |
| 143 | + |
| 144 | + The default installation location is ``C:\Users\<username>\cq-editor``. |
| 145 | + |
| 146 | +2. Launch the **run.bat** script from the file brower (select **Open**). |
| 147 | + |
| 148 | + |
| 149 | +To run from command line, activate the environment, then run cq-editor:: |
| 150 | + |
| 151 | + C:\Users\<username>\cq-editor\run.bat |
| 152 | + |
| 153 | + |
| 154 | +Installing extra packages |
| 155 | +``````````````````````````` |
| 156 | + |
| 157 | +*mamba*, and *pip* are bundled with the CQ-editor installer and available for package installation. |
| 158 | + |
| 159 | +First activate the environment, then call mamba or pip to install additional packages. |
| 160 | + |
| 161 | +On windows.:: |
| 162 | + |
| 163 | + C:\Users\<username>\cq-editor\Scripts\activate |
| 164 | + mamba install <packagename> |
| 165 | + |
| 166 | +On Linux/MacOS. :: |
| 167 | + |
| 168 | + source $HOME/cq-editor/bin/activate |
| 169 | + mamba install <packagename> |
| 170 | + |
| 171 | + |
| 172 | +Adding CQ-editor to an Existing Environment |
| 173 | +-------------------------------------------- |
| 174 | + |
| 175 | +You can install CQ-editor into a conda environment or Python virtual environment using conda (mamba) or pip. |
| 176 | + |
103 | 177 | Example cq-editor installation with conda (this installs both cadquery and cq-editor)::
|
104 | 178 |
|
105 | 179 | conda create -n cqdev
|
|
0 commit comments