On recent linux distributions, FreeCAD is generally easy to build, since all dependencies are usually provided by the package manager. It basically involves 3 steps:
Below, you'll find detailed explanations of the whole process, some build scripts, and particularities you might encounter. If you find anything wrong or out-of-date in the text below (Linux distributions change often), or if you use a distribution which is not listed, please help us correcting it.
Before you can compile FreeCAD, you need the source code. There are 3 ways to get it:
The quickest and best way to get the code is to clone the read-only git repository now hosted on GitHub (you need the git package installed):
git clone https://github.com/FreeCAD/FreeCAD.git free-cad-code
This will place a copy of the latest version of the FreeCAD source code in a new directory called "free-cad-code".
The official FreeCAD repository is on Github: github.com/FreeCAD/FreeCAD
Alternatively you can download a source package, but they could be already quite old so it's always better to get the latest sources via git or github.
To compile FreeCAD under Linux you have to install all libraries mentioned in Third Party Libraries first. Please note that the names and availability of the libraries will depend on your distribution. Note that if you don't use the most recent version of your distribution, some of the packages below might be missing from your repositories. In that case, look in the Older and non-conventional distributions section below.
On Debian-based systems (Debian, Ubuntu, Mint, etc...) it is quite easy to get all needed dependencies installed. Most of the libraries are available via apt-get or synaptic package manager.
either:
or:
either:
or:
Additional instruction for libcoin80-dev Debian wheezy-backports, unstable, testing, Ubuntu 13.10 and forward
Note that liboce*-dev includes the following libraries:
You may have to install these packages by individual name.
Optionally you can also install these extra packages:
sudo apt install build-essential cmake python python-matplotlib libtool libcoin80-dev libsoqt4-dev libxerces-c-dev libboost-dev libboost-filesystem-dev libboost-regex-dev libboost-program-options-dev libboost-signals-dev libboost-thread-dev libboost-python-dev libqt4-dev libqt4-opengl-dev qt4-dev-tools python-dev python-pyside pyside-tools libeigen3-dev libqtwebkit-dev libshiboken-dev libpyside-dev libode-dev swig libzipios++-dev libfreetype6-dev liboce-foundation-dev liboce-modeling-dev liboce-ocaf-dev liboce-visualization-dev liboce-ocaf-lite-dev libsimage-dev checkinstall python-pivy python-qt4 doxygen libspnav-dev oce-draw liboce-foundation-dev liboce-modeling-dev liboce-ocaf-dev liboce-ocaf-lite-dev liboce-visualization-dev libmedc-dev libvtk6-dev libproj-dev
Ubuntu 16.04 users please see also these Additional instructions.
You need the following packages :
(if coin2 is the latest available for your version of Fedora, use packages from http://www.zultron.com/rpm-repo/)
And optionally :
Easiest way to check which packages are needed to compile FreeCAD is to check via portage:
emerge -pv freecad
This should give a nice list of extra packages that you need installed on your system.
You need the following packages:
For FreeCAD 0.14 stable and 0.15 unstable, if Eigen3 and swig libraries are not found in standard repos, you can get them with a one-click install here:
Also, note that the Eigen3 Library from Factory Education was causing problems sometimes, so use the one from the KDE 4.8 Extra repo
Starting with 0.17pre Opensuse 13.2 is too old to build due to too old boost.
You will need the following libraries from the official repositories:
Also, make sure to check the AUR for any missing packages that are not on the repositories, currently:
sudo pacman -S boost-libs curl hicolor-icon-theme libspnav opencascade python2-pivy python2-matplotlib python2-pyside python2-shiboken qtwebkit shared-mime-info xerces-c boost cmake coin desktop-file-utils eigen gcc-fortran med python2-pyside-tools
On other distributions, we have very few feedback from users, so it might be harder to find the required packages. Try first locating the required libraries mentioned in Third Party Libraries. Beware that some of them might have a slightly different package name in your distribution (such as name, libname, name-dev, name-devel, etc...).
You also need the GNU gcc compiler version equal or above 3.0.0. g++ is also needed because FreeCAD is completely written in C++. During the compilation some Python scripts get executed. So the Python interpreter has to work properly. To avoid any linker problems during the build process it is also a good idea to have the library paths either in your LD_LIBRARY_PATH variable or in your ld.so.conf file. This is normally already the case in recent distributions.
For more details have also a look to README.Linux in your sources.
Pivy is not needed to build FreeCAD or to run it, but it is needed for the 2D Drafting module to work. If you are not going to use that module, you won't need pivy. By November 2015 the obsolete version of Pivy included with FreeCAD source code will no longer compile on many systems, due to its age. If you cannot find Pivy in your distribution's packages repository ort elsewhere, you can compile pivy yourself:
cMake is a newer build system which has the big advantage of being common for different target systems (Linux, Windows, MacOSX, etc). FreeCAD is now using the cMake system as its main building system. Compiling with cMake is usually very simple and happens in 2 steps. In the first step, cMake checks that every needed programs and libraries are present on your system and sets up all that's necessary for the subsequent compilation. You are given a few alternatives detailed below, but FreeCAD comes with sensible defaults. The second step is the compiling itself, which produces the FreeCAD executable. Changing any options for cmake away from their default values, is much easier with cmake-gui or other graphical cmake applications than with cmake on the command line, as the graphical applications will give you interactive feed back.
Since FreeCAD is a heavy application, compiling can take a bit of time (about 10 minutes on a fast machine, 30 minutes (or more) on a slow one)
If you are unsure then, due to its limitations, do not make an in-source build, create an out-of-source build as explained in the next section. However FreeCAD can be built in-source, which means that all the files resulting from the compilation stay in the same folder as the source code. This is fine if you are just looking at FreeCAD, and want to be able to remove it easily by just deleting that folder. But in case you are planning to compile it often, you are advised to make an out-of-source build, which offers many more advantages. The following commands will compile FreeCAD:
$ cd freecad (the folder where you cloned the freecad source)
If you want to use your system's copy of Pivy, which you most commonly will, then if not on Linux, set the compiler flag to use the correct pivy (via FREECAD_USE_EXTERNAL_PIVY=1). Using external Pivy became the default for Linux, during development of FreeCAD 0.16, so it does not need to be manually set when compiling this version onwards, on Linux. Also, set the build type to Debug if you want a debug build or Release if not. A Release build will run much faster than a Debug build. Sketcher becomes very slow with complex sketches if your FreeCAD is a Debug build. (NOTE: the space and "." after the cmake flags are CRITICAL!):
$ cmake -DFREECAD_USE_EXTERNAL_PIVY=1 -DCMAKE_BUILD_TYPE=Debug . # Note: to speed up build use all CPU cores: make -j$(nproc) $ make
$ cmake -DFREECAD_USE_EXTERNAL_PIVY=1 -DCMAKE_BUILD_TYPE=Release . # Note: to speed up build use all CPU cores: make -j$(nproc) $ make
Your FreeCAD executable will then reside in the "bin" folder, and you can launch it with:
$ ./bin/FreeCAD
This is a method, using Git, to repair your source code directory after accidentally running an in-source build.
1) delete everything in your source base directory EXCEPT the hidden .git folder 2) In terminal 'git reset --hard HEAD' //any remnants of an 'in source' build will be gone. 3) delete everything from your 'out of source' build directory and start over again with cmake and a full new clean build.
If you intend to follow the fast evolution of FreeCAD, building in a separate folder is much more convenient. Every time you update the source code, cMake will then intelligently distinguish which files have changed, and recompile only what is needed. Out-of-source builds are specially handy when using the Git system, because you can easily try other branches without confusing the build system. To build out-of-source, simply create a build directory, distinct from your FreeCAD source folder, and, from the build folder, point cMake (or if using cmake-gui replace "cmake" in the code below with "cmake-gui") to the source folder:
mkdir freecad-build cd freecad-build cmake ../freecad (or whatever the path is to your FreeCAD source folder) # Note: to speed up build use all CPU cores: make -j$(nproc) make
The FreeCAD executable will then reside in the "bin" directory (within your freecad-build directory).
There are a number of experimental or unfinished modules you may have to build if you want to work on them. To do so, you need to set the proper options for the configuration phase. Do it either on the command line, passing -D <var>:<type>=<value> options to cMake or using one of the availables gui-frontends (eg for Debian, packages cmake-qt-gui or cmake-curses-gui). Changing any options for cmake away from their default values, is much easier with cmake-gui or other graphical cmake applications than with cmake on the command line, as they will give you interactive feed back.
As an example, to configure FreeCAD with the Assembly module built just tick the box in a cmake gui application (e.g. cmake-gui) or on the command line issue:
cmake -D FREECAD_BUILD_ASSEMBLY:BOOL=ON ''path-to-freecad-root''
Possible options are listed in FreeCAD's root CmakeLists.txt file.
If you want to develop Qt stuff for FreeCAD, you'll need the Qt Designer plugin that provides all custom widgets of FreeCAD. Go to
freecad/src/Tools/plugins/widget
So far we don't provide a makefile -- but calling
qmake plugin.pro
creates it. Once that's done, calling
make
will create the library libFreeCAD_widgets.so. To make this library known to Qt Designer you have to copy the file to $QTDIR/plugin/designer
If you feel bold enough to dive in the code, you could take advantage to build and consult Doxygen generated FreeCAD's Source documentation
If you plan to build a Debian package out of the sources you need to install those packages first:
dh-make devscripts #optional, used for checking if packages are standard-compliant lintian
To build a package open a console, simply go to the FreeCAD directory and call
debuild
Once the package is built, you can use lintian to check if the package contains errors
#replace by the name of the package you just created lintian your-fresh-new-freecad-package.deb
When building FreeCAD for 64-bit there is a known issue with the OpenCASCADE 64-bit package. To get FreeCAD running properly you might need to run the ./configure script with the additional define _OCC64 set:
./configure CXXFLAGS="-D_OCC64"
For Debian based systems this workaround is not needed when using the prebuilt package because there the OpenCASCADE package is built to set internally this define. Now you just need to compile FreeCAD the same way as described above.
Here is all what you need for a complete build of FreeCAD. It's a one-script-approach and works on a fresh installed distro. The commands will ask for root password (for installation of packages) and sometime to acknowledge a fingerprint for an external repository server or https-subversion repository. These scripts should run on 32 and 64 bit versions. They are written for different versions, but are also likely to run on a later version with or without major changes.
If you have such a script for your preferred distro, please send it! We will incorporate it into this article.
These scripts provide a reliable way to install the correct set of dependencies required to build and run FreeCAD on Ubuntu. They make use of the FreeCAD Ubuntu PPA repositories, and should work on any version of Ubuntu targeted by the PPA. The 'daily' PPA targets recent versions of Ubuntu, and the 'stable' PPA targets all officially supported versions of Ubuntu.
This script installs dependencies for the daily development snapshot of FreeCAD.
#!/bin/sh sudo add-apt-repository --enable-source ppa:freecad-maintainers/freecad-daily && sudo apt-get update # Install the dependencies needed to build FreeCAD sudo apt-get build-dep freecad-daily # Install the dependencies needed to run FreeCAD (and a build of FreeCAD itself) sudo apt-get install freecad-daily
This script installs dependencies for the latest stable release of FreeCAD. (For Ubuntu 12.04, omit "--enable-source" from the add-apt-repository command.)
#!/bin/sh sudo add-apt-repository --enable-source ppa:freecad-maintainers/freecad-stable && sudo apt-get update # Install the dependencies needed to build FreeCAD sudo apt-get build-dep freecad # Install the dependencies needed to run FreeCAD (and a build of FreeCAD itself) sudo apt-get install freecad
(These scripts also install the PPA build of FreeCAD itself, as a side effect. You could then uninstall that while leaving the dependencies in place. However, leaving it installed will enable the package manager to keep the set of dependencies up to date, which is useful if you are following the development for a long time.)
After installing the dependencies, please see the generic instructions for getting the source code, running CMake, and compiling. The following script is an example of one way to do this.
#!/bin/sh # checkout the latest source git clone https://github.com/FreeCAD/FreeCAD.git freecad # go to source dir cd freecad # open cmake-gui window cmake-gui . # build configuration cmake . # build FreeCAD # Note: to speed up build use all CPU cores: make -j$(nproc) make
No external Repositories are needed to compile FreeCAD 0.13 with this release. However, there is an imcompatability with python3-devel which needs to be removed. FreeCAD can be compiled from GIT similar to in OpenSUSE 12.2
# install needed packages for development sudo zypper install gcc cmake OpenCASCADE-devel libXerces-c-devel \ python-devel libqt4-devel python-qt4 Coin-devel SoQt-devel boost-devel \ libode-devel libQtWebKit-devel libeigen3-devel gcc-fortran git swig # create new dir, and go into it mkdir FreeCAD-Compiled cd FreeCAD-Compiled # get the source git clone https://github.com/FreeCAD/FreeCAD.git free-cad # Now you will have subfolder in this location called free-cad. It contains the source # make another dir for compilation, and go into it mkdir FreeCAD-Build1 cd FreeCAD-Build1 # build configuration cmake ../free-cad # build FreeCAD make # test FreeCAD cd bin ./FreeCAD -t 0
Since you are using git, next time you wish to compile you do not have to clone everything, just pull from git and compile once more
# go into free-cad dir created earlier cd free-cad # pull git pull # get back to previous dir cd .. # Now repeat last few steps from before. # make another dir for compilation, and go into it mkdir FreeCAD-Build2 cd FreeCAD-Build2 # build configuration cmake ../free-cad # build FreeCAD # Note: to speed up build use all CPU cores: make -j$(nproc) make # test FreeCAD cd bin ./FreeCAD -t 0
# get the needed tools and libs sudo apt-get install build-essential python libcoin60-dev libsoqt4-dev \ libxerces-c2-dev libboost-dev libboost-date-time-dev libboost-filesystem-dev \ libboost-graph-dev libboost-iostreams-dev libboost-program-options-dev \ libboost-serialization-dev libboost-signals-dev libboost-regex-dev \ libqt4-dev qt4-dev-tools python2.5-dev \ libsimage-dev libopencascade-dev \ libsoqt4-dev libode-dev subversion cmake libeigen2-dev python-pivy \ libtool autotools-dev automake gfortran # checkout the latest source git clone https://github.com/FreeCAD/FreeCAD.git freecad # go to source dir cd freecad # build configuration cmake . # build FreeCAD # Note: to speed up build use all CPU cores: make -j$(nproc) make # test FreeCAD cd bin ./FreeCAD -t 0
Posted by user [PrzemoF] in the forum.
#!/bin/bash
#ARCH=x86_64
#ARCH=i686
ARCH=$(arch)
MAIN_DIR=FreeCAD
BUILD_DIR=build
#FEDORA_VERSION=22
FEDORA_VERSION=23
#FEDORA_VERSION=24
echo "Installing packages required to build FreeCAD"
sudo dnf -y install gcc cmake gcc-c++ boost-devel zlib-devel swig eigen3 qt-devel \
shiboken shiboken-devel pyside-tools python-pyside python-pyside-devel xerces-c \
xerces-c-devel OCE-devel smesh graphviz python-pivy python-matplotlib tbb-devel \
freeimage-devel Coin3 Coin3-devel med-devel vtk-devel
cd ~
mkdir $MAIN_DIR || { echo "~/$MAIN_DIR already exist. Quitting.."; exit; }
cd $MAIN_DIR
git clone https://github.com/FreeCAD/FreeCAD.git
mkdir $BUILD_DIR || { echo "~/$BUILD_DIR already exist. Quitting.."; exit; }
cd $BUILD_DIR
cmake ../FreeCAD
# Note: to speed up build use all CPU cores: make -j$(nproc)
make
FreeCAD development happens fast, everyday or so there are bug fixes or new features. The cmake systems allows you to intelligently update the source code, and only recompile what has changed, making subsequent compilations very fast. Updating the source code with git or subversion is very easy:
#Replace with the location where you cloned the source code the first time cd freecad #If you are using git git pull
Move into the appropriate build directory and run cmake again (as cmake updates the version number data for the Help menu, ...about FreeCAD), however you do not need to add the path to source code after "cmake", just a space and a dot:
#Replace with the location of the build directory cd ../freecad-build cmake . # to use all cpu cores change to: make -j$(nproc) make
See also Compiling - Speeding up How to speed up compilation