How to install additional workbenches

Description
Power users have extended FreeCAD with various custom external workbenches, that are not integrated into the FreeCAD source code (yet!), but are easy to install on an existing FreeCAD installation. Here we will cover the installation methods for the different operating systems.

Note Starting from version 0.17, FreeCAD features an addons manager in the Tools menu, that allows to easily install a series of external workbenches. The instructions below are only necessary if you are running an earlier version, or if you want to install a workbench that is not in the list offered by the addons manager.

Installing on Windows
Recommended installation method

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.

Alternative installation method “manual install”


 * 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 “User-Name” the default macro path is “C:\User-Name\Appdata\Roaming\FreeCAD”
 * within the macro-directory create (if not already present) a folder called “Mod”
 * within the folder mod create a folder with the name of the workbench, for example “Assembly2”
 * 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-pulldown-menu

Additional Recommendation for upating 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 (Ubuntu/Mint)
Recommended installation method

Adding the community-ppa within the ppa-manager.

Installing the workbenches via synaptic packet manager.

Alternative installation method “Installing via Git”

FreeCAD you will now have a new workbench-entry called "Assembly 2". Once installed, use git to upgrade to the latest version through BASH as follows

Alternative installation method “manual install”


 * 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 folder "mod" create a folder with the name of the workbench, for example “Assembly2”
 * 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-pulldown-menu

Installing on Mac
Recommended installation method

Alternative installation method “manual install” - here a description for the workbench "assembly2"
 * download the git repository as ZIP
 * assuming FreeCAD is installed in "/Applications/FreeCAD/v0.15", go to "/Applications/FreeCAD/v0.15" in the Browser, and select FreeCAD.app
 * right-click 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 "assembly2"
 * unzip downloaded repository in the folder "Contents/Mod/assembly2"

Copy or unzip the drawing dimensioning folder to the directory FreeCAD.app/Contents/Mod where FreeCAD.app is the folder where FreeCAD is installed.

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