How to install additional workbenches: Difference between revisions
(Remove repeated information and banner; keep it simple, this information has already been added to the beginning of the text) |
mNo edit summary |
||
(15 intermediate revisions by 6 users not shown) | |||
Line 1: | Line 1: | ||
<languages/> |
<languages/> |
||
<translate> |
<translate> |
||
<!--T:1--> |
<!--T:1--> |
||
{{TutorialInfo |
{{TutorialInfo |
||
Line 11: | Line 12: | ||
}} |
}} |
||
==Description== |
==Description== <!--T:38--> |
||
<!--T:2--> |
<!--T:2--> |
||
Line 17: | Line 18: | ||
<!--T:25--> |
<!--T:25--> |
||
{{Emphasis|Note:}} starting from version 0.17, FreeCAD features an [[File: |
{{Emphasis|Note:}} starting from version 0.17, FreeCAD features an [[File:Std_AddonMgr.svg|24px]] [[Std_AddonMgr|Addon Manager]] in the {{MenuCommand|Tools → Addon Manager}} menu, that allows installing both macros and workbenches. The instructions below are only required if you wish to manually install a workbench. This may be necessary if for some reason the Addon Manager doesn't work but you have access to the workbench downloaded as a {{FileName|.zip}} package. |
||
⚫ | |||
<div class="mw-collapsible mw-collapsed toccolours"> |
<div class="mw-collapsible mw-collapsed toccolours"> |
||
Line 27: | Line 29: | ||
<div class="mw-collapsible-content"> |
<div class="mw-collapsible-content"> |
||
=== |
=== Manual Install === <!--T:40--> |
||
<!--T: |
<!--T:9--> |
||
{{Emphasis|Note:}} |
{{Emphasis|Note:}} This method is possible but not necessary with the introduction of the [[Std_AddonMgr|Addon Manager]]. Nevertheless, the information here may still be useful to some. |
||
⚫ | |||
Use the [https://github.com/FreeCAD/FreeCAD-addons addons-installer from Github]. |
|||
⚫ | |||
During Google Summer of Code 2016 student Mandeep Singh started work on an improved version ([https://github.com/mandeeps708/PluginManager available here]) but that version needs further work before it can be fully integrated in FreeCAD. |
|||
=== Manual Install === <!--T:9--> |
|||
⚫ | |||
<!--T:10--> |
<!--T:10--> |
||
* Download the workbench from github by clicking on the button {{Button|Clone}} or {{Button|Download}} on the github page (upper right corner) and choosing "Download ZIP" |
* Download the workbench from github by clicking on the button {{Button|Clone}} or {{Button|Download}} on the github page (upper right corner) and choosing "Download ZIP" |
||
* Unpack the downloaded archive on your local hard disk |
* Unpack the downloaded archive on your local hard disk |
||
* Within FreeCAD, locate the macro path by choosing {{MenuCommand|Edit → Preferences → |
* Within FreeCAD, locate the macro path by choosing {{MenuCommand|Edit → Preferences → Python → Macro}} and look for the ”Macro path” |
||
* Supposed your Windows-Login is “''username''” the default macro path is {{FileName|%APPDATA%\FreeCAD\}} which is usually {{FileName|C:\Users\''username''\Appdata\Roaming\FreeCAD}} |
* Supposed your Windows-Login is “''username''” the default macro path is {{FileName|%APPDATA%\FreeCAD\}} which is usually {{FileName|C:\Users\''username''\Appdata\Roaming\FreeCAD}} |
||
* Within the macro-directory create (if not already present) a folder called “{{FileName|Mod}}” |
* Within the macro-directory create (if not already present) a folder called “{{FileName|Mod}}” |
||
Line 60: | Line 53: | ||
</div> <!-- END of Windows section collapsible div. Please do not remove ---> |
</div> <!-- END of Windows section collapsible div. Please do not remove ---> |
||
<translate> |
<translate> |
||
<!--T:37--> |
<!--T:37--> |
||
Line 71: | Line 63: | ||
<div class="mw-collapsible-content"> |
<div class="mw-collapsible-content"> |
||
===Using git=== <!--T: |
===Using git=== <!--T:41--> |
||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
<!--T:14--> |
<!--T:14--> |
||
Line 93: | Line 87: | ||
}} |
}} |
||
===Manual Installation=== <!--T: |
===Manual Installation=== <!--T:42--> |
||
⚫ | |||
<!--T:17--> |
|||
⚫ | |||
<!--T:18--> |
<!--T:18--> |
||
* Download the workbench from github by clicking on the button {{Button|Clone}} or {{Button|Download}} on the github page (upper right corner) and choosing "Download ZIP" |
* Download the workbench from github by clicking on the button {{Button|Clone}} or {{Button|Download}} on the github page (upper right corner) and choosing "Download ZIP" |
||
* Unpack the downloaded archive on your local hard disk |
* Unpack the downloaded archive on your local hard disk |
||
* Within FreeCAD, locate the macro path by choosing {{MenuCommand|Edit → Preferences → |
* Within FreeCAD, locate the macro path by choosing {{MenuCommand|Edit → Preferences → Python → Macro}} and look for the ”Macro path” |
||
* By default, the macro directory is the (hidden) {{MenuCommand|./.FreeCAD/}} directory in your home-directory |
* By default, the macro directory is the (hidden) {{MenuCommand|./.FreeCAD/}} directory in your home-directory |
||
* Within the macro-directory create (if not already present) a folder called “{{FileName|Mod}}” |
* Within the macro-directory create (if not already present) a folder called “{{FileName|Mod}}” |
||
Line 111: | Line 107: | ||
<translate> |
<translate> |
||
<!--T:5--> |
|||
<div class="mw-collapsible mw-collapsed toccolours"> |
<div class="mw-collapsible mw-collapsed toccolours"> |
||
==Installing on Mac== |
==Installing on Mac== |
||
<!--T:34--> |
<!--T:34--> |
||
How to install additional workbenches and addons on |
How to install additional workbenches and addons on macOS |
||
<div class="mw-collapsible-content"> |
<div class="mw-collapsible-content"> |
||
===Manual Installation=== <!--T: |
===Manual Installation=== <!--T:43--> |
||
{{Emphasis|Note:}} This method is possible but not necessary with the introduction of the [[Addon Manager]]. Nevertheless, the information here may still be useful to some. |
|||
<!--T:36--> |
|||
⚫ | |||
<!--T:20--> |
<!--T:20--> |
||
For the sake of this example, say you've chosen the [[Curves Workbench]] as the external workbench you want to install: |
For the sake of this example, say you've chosen the [[Curves Workbench]] as the external workbench you want to install: |
||
* Choose and download the git repository of your chosen external workbench as a ZIP file |
* Choose and download the git repository of your chosen external workbench as a ZIP file |
||
* There are two possible locations for your Addon workbench 'Mods': |
|||
* Assuming FreeCAD is installed in {{FileName|/Applications/FreeCAD/v0.xx}}", go to {{FileName|/Applications/FreeCAD/v0.xx}}" in the Browser, and select FreeCAD.app |
|||
# All Users: {{FileName|/Applications/FreeCAD.app/Contents/Resources/Mod}} |
|||
⚫ | |||
# Current user only: {{FileName|/Users/myusername/Library/Application Support/FreeCAD/Mod}} |
|||
⚫ | |||
* If you use Finder to navigate manually to the All Users location in Applications you will need to |
|||
* In the folder "Mod" create a new folder named "Curves" |
|||
** go to {{FileName|/Applications}}" and select FreeCAD.app |
|||
⚫ | |||
⚫ | |||
⚫ | |||
* Once you are in whichever "Mod" folder you want to use, create a New Folder named "Curves" |
|||
⚫ | |||
</translate> |
</translate> |
||
</div> <!-- END of Windows section collapsible div. Please do not remove ---> |
</div> <!-- END of Windows section collapsible div. Please do not remove ---> |
||
Line 138: | Line 140: | ||
<!--T:22--> |
<!--T:22--> |
||
* |
* Don't use special characters (for example German umlauts) in your windows user name, otherwise FreeCAD will not recognize files and folders in the macro path. |
||
*If you have already set up a user name with special characters either create a new user name or point the macro path to a directory not using special characters |
* If you have already set up a user name with special characters either create a new user name or point the macro path to a directory not using special characters. |
||
* |
* Go to {{MenuCommand|Edit → Preferences → Workbenches}} and make sure the workbench is not set to invisible. |
||
* |
* With 32-bit systems and FreeCAD 0.16.6706, after attempts to install, the additional Workbenches may not be available. In this case |
||
** |
** keep the [[report_view|report view]] open while starting FreeCAD, and read the error, |
||
** see this forum thread |
** see this forum thread [http://forum.freecadweb.org/viewtopic.php?t=12839#p102933 Assembly2 in Version: 0.16.5602 (Git)] |
||
</translate> |
</translate> |
Latest revision as of 19:53, 9 August 2023
Tutorial |
Topic |
---|
Programming |
Level |
Medium programmer |
Time to complete |
15 minutes |
Authors |
r-frank |
FreeCAD version |
All |
Example files |
none |
See also |
None |
Description
Power users have extended FreeCAD with various custom external workbenches that are not integrated into the core source code but are easy to install on an existing FreeCAD distribution. Here we will cover the installation methods for the different operating systems.
Note: starting from version 0.17, FreeCAD features an Addon Manager in the Tools → Addon Manager menu, that allows installing both macros and workbenches. The instructions below are only required if you wish to manually install a workbench. This may be necessary if for some reason the Addon Manager doesn't work but you have access to the workbench downloaded as a .zip package.
Installing on Windows
How to install additional workbenches and addons on Windows
Manual Install
Note: This method is possible but not necessary with the introduction of the Addon Manager. Nevertheless, the information here may still be useful to some.
- Download the workbench from github by clicking on the button Clone or Download on the github page (upper right corner) and choosing "Download ZIP"
- Unpack the downloaded archive on your local hard disk
- Within FreeCAD, locate the macro path by choosing Edit → Preferences → Python → Macro and look for the ”Macro path”
- Supposed your Windows-Login is “username” the default macro path is %APPDATA%\FreeCAD\ which is usually C:\Users\username\Appdata\Roaming\FreeCAD
- Within the macro-directory create (if not already present) a folder called “Mod”
- Within the Mod folder, create a folder with the name of the workbench, for example “Curves”
- Now move the unpacked files and sub-folders of the workbench to the just created workbench-folder
- After restart of FreeCAD you should now have an entry in the workbench selector
Additional Recommendation for updating workbenches
On windows, when updating an already installed workbench, Windows keeps the old .py files as .pyc. Since this may lead to trouble, it is recommended to uninstall the workbench, restart FreeCAD and install the new version of the workbench.
Installing on Linux
How to install additional workbenches and addons on Linux
Using git
Adding the community-ppa within the ppa-manager.
Installing the workbenches via Synaptic Packet Manager.
$ sudo apt-get install git python-numpy python-pyside
$ mkdir ~/.FreeCAD/Mod
$ cd ~/.FreeCAD/Mod
$ git clone https://github.com/tomate44/CurvesWB.git
In FreeCAD you will now have a new workbench-entry called "CurvesWB". Once installed, use git to upgrade to the latest version:
$ cd ~/.FreeCAD/Mod/CurvesWB
$ git pull
$ rm *.pyc
Manual Installation
Note: This method is possible but not necessary with the introduction of the Addon Manager. Nevertheless, the information here may still be useful to some.
- Download the workbench from github by clicking on the button Clone or Download on the github page (upper right corner) and choosing "Download ZIP"
- Unpack the downloaded archive on your local hard disk
- Within FreeCAD, locate the macro path by choosing Edit → Preferences → Python → Macro and look for the ”Macro path”
- By default, the macro directory is the (hidden) ./.FreeCAD/ directory in your home-directory
- Within the macro-directory create (if not already present) a folder called “Mod”
- Within the Mod/ folder, create a folder with the name of the workbench, for example “Curves”
- Now move the unpacked files and sub-folders of the workbench to the just created workbench-folder
- After restart of FreeCAD you should now have an entry in the workbench selector
Installing on Mac
How to install additional workbenches and addons on macOS
Manual Installation
Note: This method is possible but not necessary with the introduction of the Addon Manager. Nevertheless, the information here may still be useful to some.
For the sake of this example, say you've chosen the Curves Workbench as the external workbench you want to install:
- Choose and download the git repository of your chosen external workbench as a ZIP file
- There are two possible locations for your Addon workbench 'Mods':
- All Users: /Applications/FreeCAD.app/Contents/Resources/Mod
- Current user only: /Users/myusername/Library/Application Support/FreeCAD/Mod
- If you use Finder to navigate manually to the All Users location in Applications you will need to
- go to /Applications" and select FreeCAD.app
- right-mouse-click and select "Show Package Contents", a new window will appear with a folder named "Contents"
- single-click on the folder "Contents" then on "Resources" and double-click to open the folder "Mod"
- Once you are in whichever "Mod" folder you want to use, create a New Folder named "Curves"
- Unzip downloaded repository in the folder "Mod/Curves"
General troubleshooting
- Don't use special characters (for example German umlauts) in your windows user name, otherwise FreeCAD will not recognize files and folders in the macro path.
- If you have already set up a user name with special characters either create a new user name or point the macro path to a directory not using special characters.
- Go to Edit → Preferences → Workbenches and make sure the workbench is not set to invisible.
- With 32-bit systems and FreeCAD 0.16.6706, after attempts to install, the additional Workbenches may not be available. In this case
- keep the report view open while starting FreeCAD, and read the error,
- see this forum thread Assembly2 in Version: 0.16.5602 (Git)
- Getting started
- Installation: Download, Windows, Linux, Mac, Additional components, Docker, AppImage, Ubuntu Snap
- Basics: About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties, Help FreeCAD, Donate
- Help: Tutorials, Video tutorials
- Workbenches: Std Base, Arch, Assembly, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Start, Surface, TechDraw, Test Framework, Web
- Hubs: User hub, Power users hub, Developer hub
- FreeCAD scripting: Python, Introduction to Python, Python scripting tutorial, FreeCAD Scripting Basics
- Modules: Builtin modules, Units, Quantity
- Workbenches: Workbench creation, Gui Commands, Commands, Installing more workbenches
- Meshes and Parts: Mesh Scripting, Topological data scripting, Mesh to Part, PythonOCC
- Parametric objects: Scripted objects, Viewproviders (Custom icon in tree view)
- Scenegraph: Coin (Inventor) scenegraph, Pivy
- Graphical interface: Interface creation, Interface creation completely in Python (1, 2, 3, 4, 5), PySide, PySide examples beginner, intermediate, advanced
- Macros: Macros, How to install macros
- Embedding: Embedding FreeCAD, Embedding FreeCADGui
- Other: Expressions, Code snippets, Line drawing function, FreeCAD vector math library (deprecated)
- Hubs: User hub, Power users hub, Developer hub