How to install additional workbenches: Difference between revisions

From FreeCAD Documentation
m (modernized this page + added collapsible div to make less overwhelming)
(Marked this version for translation)
(16 intermediate revisions by 8 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
<translate>
<translate>

<!--T:1-->
<!--T:1-->
{{TutorialInfo
{{TutorialInfo
Line 11: Line 12:
}}
}}


==Description== <!--T:2-->
==Description== <!--T:38-->

Power users have extended FreeCAD with various custom [[external workbenches]], that are not integrated into the FreeCAD source code core,
<!--T:2-->
but are easy to install on an existing FreeCAD installation. Here we will cover the installation methods for the different operating systems.
Power users have extended FreeCAD with various custom [[external_workbenches|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.


<!--T:25-->
<!--T:25-->
'''Note''' Starting from version 0.17, FreeCAD features an [[Image:AddonManager.svg|24px|link=Addon Manager]] [[Addon Manager]] in the {{MenuCommand|Tools → Addon Manager}} 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 [[Addon Manager]].
{{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.


<!--T:39-->
<div class="mw-collapsible mw-collapsed toccolours">
<div class="mw-collapsible mw-collapsed toccolours">

==Installing on Windows== <!--T:3-->
==Installing on Windows== <!--T:3-->


<!--T:28-->
How to install additional workbenches and addons on Windows
How to install additional workbenches and addons on Windows
<div class="mw-collapsible-content">
<div class="mw-collapsible-content">


=== Obsolete === <!--T:30-->
=== Recommended Installation ===

<!--T:7-->
{{VeryImportantMessage|The modern recommended installation is using the {{MenuCommand|Tools → [[Image:AddonManager.svg|24px|link=Addon Manager]] [[Addon Manager]]}}.}}

=== Obsolete ===


<!--T:26-->
<!--T:26-->
{{Emphasis|Note:}} using the "addons-installer" is not recommended any more. Using the [[Addon Manager|Addon Manager]] in all systems is the recommended way.
{{Emphasis|Note:}} using the "addons-installer" is not recommended any more. Using the [[Std_AddonMgr|Addon Manager]] in all systems is the recommended way.


<!--T:8-->
<!--T:8-->
Line 39: Line 39:
<!--T:27-->
<!--T:27-->
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.
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:40-->


<!--T:9-->
<!--T:9-->
{{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.
=== Manual Install ===
{{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:10-->
<!--T:10-->
Line 48: Line 49:
* 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 → General → Macro}} and look for the ”Macro path”
* Within FreeCAD, locate the macro path by choosing {{MenuCommand|Edit → Preferences → General → Macro}} and look for the ”Macro path”
* Supposed your Windows-Login is “''User-Name''” the default macro path is {{FileName|C:\''User-Name''\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}}”
* Within the Mod folder, create a folder with the name of the workbench, for example “Curves”
* Within the Mod folder, create a folder with the name of the workbench, for example “Curves”
Line 65: Line 66:




<!--T:37-->
<div class="mw-collapsible mw-collapsed toccolours">
<div class="mw-collapsible mw-collapsed toccolours">

==Installing on Linux == <!--T:4-->
==Installing on Linux == <!--T:4-->


<!--T:31-->
How to install additional workbenches and addons on Linux
How to install additional workbenches and addons on Linux
<div class="mw-collapsible-content">
<div class="mw-collapsible-content">


===Using git=== <!--T:41-->
===Recommended Installation===

{{VeryImportantMessage|The modern recommended installation is using the {{MenuCommand|Tools → [[Image:AddonManager.svg|24px|link=Addon Manager]] [[Addon Manager]]}}.}}


===Using git===
<!--T:12-->
<!--T:12-->
Adding the [https://launchpad.net/~freecad-community/+archive/ubuntu/ppa community-ppa] within the ppa-manager.<br />
Adding the [https://launchpad.net/~freecad-community/+archive/ubuntu/ppa community-ppa] within the ppa-manager.<br />
Line 89: Line 90:


<!--T:15-->
<!--T:15-->
FreeCAD you will now have a new workbench-entry called "CurvesWB". Once installed, use git to upgrade to the latest version:
In FreeCAD you will now have a new workbench-entry called "CurvesWB". Once installed, use git to upgrade to the latest version:


<!--T:16-->
<!--T:16-->
Line 97: Line 98:
$ rm *.pyc
$ rm *.pyc
}}
}}

===Manual Installation=== <!--T:42-->


<!--T:17-->
<!--T:17-->
{{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.
===Manual Installation===
{{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:18-->
<!--T:18-->
Line 121: Line 123:
==Installing on Mac== <!--T:5-->
==Installing on Mac== <!--T:5-->


<!--T:34-->
How to install additional workbenches and addons on MacOS
How to install additional workbenches and addons on MacOS
<div class="mw-collapsible-content">
<div class="mw-collapsible-content">


===Recommended Installation===
===Manual Installation=== <!--T:43-->
{{VeryImportantMessage|The modern recommended installation is using the {{MenuCommand|Tools → [[Image:AddonManager.svg|24px|link=Addon Manager]] [[Addon Manager]]}}.}}


<!--T:36-->
===Manual Installation===
{{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.
{{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.


<!--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}}
* RMB and select "Show Package Contents", a new window will appear with a folder named "Contents"
# Current user only: {{FileName|/Users/myusername/Library/Preferences/FreeCAD/Mod}}
* single-click on the folder "Contents" and select the folder "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
* Unzip downloaded repository in the folder "Contents/Mod/Curves"
** 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"
</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 146: Line 152:


<!--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
* 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.
*Workbench still not showing up ? In FreeCAD, choose {{MenuCommand|Tools → Customize → Workbenches}} and make sure it is not set to invisible
* Go to {{MenuCommand|Tools → Customize → Workbenches}} and make sure the workbench 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
* With 32-bit systems 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
** keep the [[report_view|report view]] open while starting FreeCAD, and read the error,
** see this forum thread: http://forum.freecadweb.org/viewtopic.php?t=12839#p102933
** see this forum thread [http://forum.freecadweb.org/viewtopic.php?t=12839#p102933 Assembly2 in Version: 0.16.5602 (Git)]


</translate>
</translate>
[[Category:External Worbenches{{#translation:}}]]
{{Userdocnavi{{#translation:}}}}
{{Powerdocnavi{{#translation:}}}}
[[Category:External Workbenches{{#translation:}}]]
[[Category:Addons{{#translation:}}]]
[[Category:Addons{{#translation:}}]]
[[Category:Power Users{{#translation:}}]]

Revision as of 18:56, 30 July 2022

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

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

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

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':
  1. All Users: /Applications/FreeCAD.app/Contents/Resources/Mod
  2. Current user only: /Users/myusername/Library/Preferences/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 Tools → Customize → 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