How to install additional workbenches
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
Recommended Installation
Obsolete
Note: using the "addons-installer" is not recommended any more. Using the Addon Manager in all systems is the recommended way.
Use the addons-installer from Github.
During Google Summer of Code 2016 student Mandeep Singh started work on an improved version (available here) but that version needs further work before it can be fully integrated in FreeCAD.
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 → General → 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
Recommended Installation
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 → General → 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
Recommended Installation
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
- Assuming FreeCAD is installed in /Applications/FreeCAD/v0.xx", go to /Applications/FreeCAD/v0.xx" in the Browser, and select FreeCAD.app
- RMB and select "Show Package Contents", a new window will appear with a folder named "Contents"
- single-click on the folder "Contents" and select the folder "Mod"
- In the folder "Mod" create a new folder named "Curves"
- Unzip downloaded repository in the folder "Contents/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
- Workbench still not showing up ? In FreeCAD, choose Tools → Customize → Workbenches and make sure it is not set to invisible
- Notes for users with 32-bit system and FreeCAD 0.16.6706 . After attempts to install, the additional Workbenches may not be available. In this case
- hold the Report panel open while starting FreeCAD, and read the error
- see this forum thread: http://forum.freecadweb.org/viewtopic.php?t=12839#p102933
- 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, Assembly, BIM, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Surface, TechDraw, Test Framework
- 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