How to install additional workbenches: Difference between revisions

From FreeCAD Documentation
(Created page with "<translate> <!--T:1--> {{TutorialInfo|Topic=Programming|Level=Medium programmer|Time=15 minutes|FCVersion=All|Author=r-frank}} ==Description==<!--T:2--> To d...")
 
No edit summary
Line 4: Line 4:


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

Installing additional workbenches


==Installing on Windows==<!--T:3-->
==Installing on Windows==<!--T:3-->
Line 12: Line 11:
'''Recommended installation method'''
'''Recommended installation method'''


Use the addons-installer from Github.<br />
Use the [https://github.com/FreeCAD/FreeCAD-addons addons-installer from Github].<br />
During Google Summer of Code 2016 student Mandeep Singh started work on an improved<br />
During Google Summer of Code 2016 student Mandeep Singh started work on an improved<br />
version (available here) but that version needs further work before it can be fully integrated in FreeCAD.<br />
version ([https://github.com/mandeeps708/PluginManager available here]) but that version needs further work before it can be fully integrated in FreeCAD.<br />


'''Alternative installation method “manual install”'''
'''Alternative installation method “manual install”'''


*download the workbench from github by clicking on the button “blabla” on the github page (upper right corner)
*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 donwloaded archive on your local hard disk
*unpack the downloaded archive on your local hard disk
*within FreeCAD, locate the macro path by choosing “Edit > Preferences > General > Makro” and look for the ”Macro target path”
*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”
*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 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”
*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
*now move the unpacked files and sub-folders of the workbench to the just created workbench-folder
Line 31: Line 30:
'''Recommended installation method'''
'''Recommended installation method'''


Adding the community-ppa within the ppa-manager.<br />
Adding the [https://launchpad.net/~freecad-community/+archive/ubuntu/ppa community-ppa] within the ppa-manager.<br />
Installing the workbenches via synaptic.
Installing the workbenches via synaptic packet manager.


'''Alternative installation method “Installing via Git”'''
'''Alternative installation method “Installing via Git”'''


{{Code|code=
bla
$ sudo apt-get install git python-numpy python-pyside
blub
$ mkdir ~/.FreeCAD/Mod
$ cd ~/.FreeCAD/Mod
$ git clone https://github.com/hamish2014/FreeCAD_assembly2.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

{{Code|code=
$ cd ~/.FreeCAD/Mod/FreeCAD_assembly2
$ git pull
$ rm *.pyc
}}


'''Alternative installation method “manual install”'''
'''Alternative installation method “manual install”'''


*download the workbench from github by clicking on the button “blabla” on the github page (upper right corner)
*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 donwloaded archive on your local hard disk
*unpack the downloaded archive on your local hard disk
*within FreeCAD, locate the macro path by choosing “Edit > Preferences > General > Makro” and look for the ”Macro target path”
*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
*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 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”
*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
*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
*after restart of FreeCAD you should now have an entry in the workbench-pulldown-menu
Line 53: Line 64:


'''Recommended installation method'''
'''Recommended installation method'''



'''Alternative installation method'''
'''Alternative installation method'''

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==<!--T:6-->
==General troubleshooting==<!--T:6-->

Revision as of 21:24, 13 September 2016

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 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.

Installing on Windows

Recommended installation method

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

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”

$ sudo apt-get install git python-numpy python-pyside
$ mkdir ~/.FreeCAD/Mod
$ cd ~/.FreeCAD/Mod
$ git clone https://github.com/hamish2014/FreeCAD_assembly2.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

$ cd ~/.FreeCAD/Mod/FreeCAD_assembly2
$ git pull
$ rm *.pyc

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

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