Compile on MacOS: Difference between revisions

From FreeCAD Documentation
m (Fix typos)
(Undo revision 1238386 by Donatello (talk). I realized that I didn't do it the right way. I had to rename the page (which creates a redirect link automatically) and not create a redirect link to a new page. Sorry!)
Tags: Removed redirect Undo
 
(131 intermediate revisions by 18 users not shown)
Line 1: Line 1:
<languages/>
<translate>
<translate>
This page explains how to compile the latest FreeCAD source code on Mac OS X.


<!--T:132-->
== Prerequisites ==
{{Docnav
First of all, you will need to install the following software.
|[[Compile_on_Linux|Compile on Linux]]
|[[Compile_on_Docker|Compile on Docker]]
}}

<!--T:136-->
{{VeryImportantMessage|There is an experimental FreeCAD Docker container that is being tested for FreeCAD development. Read more about it at [[Compile on Docker]]}}


=== Xcode Development Tools ===
Unless you want to use the Xcode IDE for FreeCAD development, you will only need to install the Command Line Tools. To do this on 10.9 and later, open Terminal, run the following command, and then click Install in the dialog that comes up.
</translate>
</translate>
{{TOCright}}
<pre>
xcode-select --install
</pre>
<translate>
<translate>
For other versions of OS X, you can get the package from the Apple developer [https://developer.apple.com/downloads/index.action?q=xcode downloads page] (sign in with the same Apple ID you use for other Apple services). Specifically, you will need to download Development Tools 3.2 for OS X 10.6, and Command Line Tools 4.8 for OS X 10.8.


=== CMake ===
== Overview == <!--T:137-->

Install the latest version of CMake from http://www.cmake.org/download. Although Homebrew will also install CMake, it only installs the command line executable.
<!--T:72-->
This page describes how to compile the FreeCAD source code on macOS. For other platforms, see [[Compiling|Compiling]].

<!--T:134-->
These instructions have been tested on macOS Catalina with standard XCode 11.6. It is known to work on macOS BigSur Beta with XCode 12.0 beta. If you plan to use XCode Beta, please be sure to download Command Line Tools add on through a dmg package to workaround some libz dependency issues.

<!--T:119-->
This page serves as a quick start, and is not intended to be comprehensive with regard to describing all the available build options.

<!--T:120-->
If you just want to evaluate the latest pre-release build of FreeCAD, you can download pre-built binaries [https://github.com/FreeCAD/FreeCAD/releases from here].

== Install Prerequisites == <!--T:73-->

<!--T:139-->
The following software must be installed to support the build process.

=== Homebrew Package Manager === <!--T:76-->

<!--T:140-->
Homebrew is a command line based package manager for macOS. The [https://brew.sh/ Homebrew main page] provides an installation command line that you simply paste into a terminal window.

=== CMake === <!--T:79-->

<!--T:141-->
CMake is a build tool that generates a build configuration based on variables you specify. You then issue the 'make' command to actually build that configuration. The command-line version of CMake is automatically installed as part of the Homebrew installation, above. If you prefer to use a GUI version of CMake, you can download it from [https://www.cmake.org/downloadDownload here].

== Install Dependencies == <!--T:82-->

<!--T:142-->
FreeCAD maintains a Homebrew 'cask' which installs the required formulas and dependencies. Issue the following brew commands in your terminal.


=== Homebrew ===
To install Homebrew, enter the following in Terminal:
</translate>
</translate>
{{Code|code=
<pre>
brew tap freecad/freecad
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
brew install eigen
</pre>
brew install --only-dependencies freecad
}}
<translate>
<translate>

== Getting the source ==
<!--T:121-->
In this guide, the source and build folders are created in '''/Users/username/FreeCAD''', but you can of course use whatever folder you want.
{{Incode|brew install}} may take quite a while, so you may want go grab a beverage. :-).

<!--T:155-->
Alternately, you can install the individual dependencies manually by installing the following packages using {{Incode|brew install ...}}:

<!--T:156-->
* {{incode|cmake}}
* {{incode|swig}}
* {{incode|boost}}
* {{incode|boost-python3}}
* {{incode|eigen}}
* {{incode|gts}}
* {{incode|vtk}}
* {{incode|xerces-c}}
* {{incode|qt@5}} - Only Qt5 is currently supported, support for Qt6 is a work-in-progress
* {{incode|opencascade}}
* {{incode|doxygen}}
* {{incode|pkgconfig}}
* {{incode|coin3d}} - Note that as of this writing (Nov. 2022) this will install an unusable version of pyside@2 as a dependency.

<!--T:157-->
There are several packages that are only available when you have tapped the freecad cask: you must do that ({{incode|brew tap freecad/freecad}}). Due to some historical bug workarounds, at the time of this writing (Nov. 2022) the versions of PySide2 and Shiboken2 installed by Homebrew are not usable because they force the use of Py_Limited_API, which FreeCAD does not support. It is expected that this workaround will be removed in the coming months, but in the meantime you must use the FreeCAD cask versions of PySide and Shiboken. Use {{incode|brew install ...}}, install the following packages:

<!--T:158-->
* {{incode|freecad/freecad/pyside2@5.15.5}}
* {{incode|freecad/freecad/shiboken2@5.15.5}}
* {{incode|freecad/freecad/med-file}}
* {{incode|freecad/freecad/netgen}}

<!--T:159-->
You will also need to "link" PySide and Shiboken:

<!--T:160-->
{{Code|code=
brew link freecad/freecad/pyside2@5.15.5 freecad/freecad/shiboken2@5.15.5
}}

<!--T:161-->
In some cases the packages installed by Homebrew do not use the same Python version: for example, at the time of this writing PySide2 uses Python 3.10, but boost-python3 uses Python 3.11. While it is possible to "roll back" the more advanced version (so that in this case boost-python3 uses Python 3.10) this is an advanced operation, and in many cases it is best to wait for an update to the other package. If you want to pursue that path anyway, look at the "brew extract" command, which you can use to extract a formula into a new cask (typically freecad/freecad). You can then edit that formula as needed.

<!--T:162-->
You will need to set the path to Qt: Qt5 is currently supported, while support for Qt6 is a work-in-progress. Set FREECAD_QT_VERSION to "Auto" or "5" to select Qt5 (the default). On the command line, use something like:

<!--T:163-->
{{Code|code=
cmake \
-DCMAKE_BUILD_TYPE="Release" \
-DPYTHON_EXECUTABLE="/usr/local/bin/python3" \
-DQt5_DIR="/usr/local/Cellar/qt@5/5.15.7/lib/cmake/Qt5" \
-DPySide2_DIR="/usr/local/Cellar/pyside2@5.15.5/5.15.5/lib/cmake/PySide2-5.15.5" \
-DShiboken2_DIR="/usr/local/Cellar/shiboken2@5.15.5/5.15.5_1/lib/cmake/Shiboken2-5.15.5" \
../freecad-source
}}

== Get the source == <!--T:85-->

<!--T:143-->
In the following instructions, the source and build folders are created side-by-side under

</translate>
{{Code|code=
/Users/username/FreeCAD
}}
<translate>

<!--T:123-->
but you can use whatever folders you want.

</translate>
</translate>
{{Code|code=
<pre>
mkdir ~/FreeCAD
mkdir ~/FreeCAD
cd ~/FreeCAD
cd ~/FreeCAD
}}
</pre>
<translate>
<translate>
To get the FreeCAD source code, run:
</translate>
<pre>
git clone git://git.code.sf.net/p/free-cad/code FreeCAD-git
</pre>
<translate>
Alternatively, you can use the github mirror: https://github.com/FreeCAD/FreeCAD_sf_master.git


<!--T:86-->
== Installing the Dependencies ==
The following command will clone the FreeCAD git repository into a directory called FreeCAD-git.
All of the needed libraries can be installed using Homebrew.

</translate>
</translate>
{{Code|code=
<pre>
git clone https://github.com/FreeCAD/FreeCAD FreeCAD-git
brew tap homebrew/science
}}
brew tap sanelson/freecad
brew install boost eigen freetype oce python qt pyside pyside-tools xerces-c
brew install --without-framework --without-soqt sanelson/freecad/coin
brew install --HEAD pivy
</pre>
<translate>
<translate>

== Compiling FreeCAD ==
<!--T:89-->
First, create a new folder for the build:
Create the build folder.

</translate>
</translate>
{{Code|code=
<pre>
mkdir ~/FreeCAD/build
mkdir ~/FreeCAD/build
}}
</pre>
<translate>
<translate>
Now you will need to run CMake to generate the build files. Open the CMake app, and fill in the source and build folder fields. In this case, it would be '''/Users/username/FreeCAD/FreeCAD-git''' for the source, and '''/Users/username/FreeCAD/build''' for the build folder.


== Run CMake == <!--T:88-->
Next, click the '''Configure''' button. This will display a dialog asking you to specify what generator to use. Leave it at the default '''Unix Makefiles.''' Configuring will fail the first time because there are some options that need to be changed. Note: You will need to check the '''Advanced''' checkbox to get all of the options.


<!--T:124-->
Next, we will run CMake to generate the build configuration. Several options must be passed to CMake. The following table describes the options and gives some background.

=== CMake Options === <!--T:90-->

<!--T:91-->
{| class="wikitable" style="text-align:left"
{| class="wikitable" style="text-align:left"
|-
|-
! Option name !! Value !! Notes
! Name !! Value !! Notes
|-
| CMAKE_BUILD_TYPE || Release (STRING) || Release or Debug. Debug is generally used for developer-level testing but may also be required for user-level testing and troubleshooting.
|-
|-
| CMAKE_PREFIX_PATH || "/usr/local/opt/qt5152;" ... (PATH) || Required to build with Qt5. See note below. You also need to add path to VTK libraries and NGLIB libraries cmake configuration file.
| BUILD_ROBOT || OFF (unchecked) || As of 12/19/2014, the robot module fails to build using newer versions of clang (OS X 10.9 and later)

<!--T:125-->
|-
|-
| FREECAD_CREATE_MAC_APP || 1 (BOOL) || Create a FreeCAD.app bundle at the location specified in CMAKE_INSTALL_PREFIX, when the 'make install' command issued.
| CMAKE_BUILD_TYPE || Release ||
|-
|-
| CMAKE_INSTALL_PREFIX || "./.." (PATH) || Path where you want to generate the FreeCAD.app bundle.
| FREECAD_USE_EXTERNAL_PIVY || ON (checked) ||
|-
| FREETYPE_INCLUDE_DIR_freetype2 || /usr/local/include/freetype2 || You will only need to set this if you are using a CMake version older than 3.1.0
|-
| OCE_DIR || /usr/local/Cellar/oce/0.16.1/OCE.framework/Versions/0.16/Resources ||
|-
| PYSIDERCC4BINARY || /usr/local/bin/pyside-rcc ||
|-
|-
| FREECAD_USE_EXTERNAL_KDL || 1 (BOOL) || Required.
| PYSIDEUIC4BINARY || /usr/local/bin/pyside-uic ||
|-
| PYTHON_EXECUTABLE || /usr/local/bin/python ||
|-
| PYTHON_INCLUDE_DIR || /usr/local/Cellar/python/2.7.9/Frameworks/Python.framework/Versions/2.7/include/python2.7 ||
|-
| PYTHON_LIBRARY || /usr/local/Cellar/python/2.7.9/Frameworks/Python.framework/Versions/2.7/lib/libpython2.7.dylib ||
|-
|-
| BUILD_FEM_NETGEN || 1 (BOOL) || Required if choosing to build the FEM tools.
|}
|}
Note: The above paths for OCE and Python are for versions 0.16.1 and 2.7.9, respectively -- change as needed.


<!--T:126-->
Now click '''Configure''' again and then '''Generate'''.
Note: Command line to generate CMAKE_PREFIX_PATH:


Finally, run '''make''' to compile FreeCAD.
</translate>
</translate>
<!--NOT CHANGE THE <pre> </pre> BALISE CAUSE THE PIPE OR SPACE IN MACRO CODE CUT THE MACRO-->
<pre>
ls -d $(brew list -1 | grep qt | tail -1 | xargs brew --cellar)/*/lib/cmake
<translate>

=== CMake GUI === <!--T:92-->

<!--T:144-->
Open the CMake app, and fill in the source and build folder fields. In this example, it would be '''/Users/username/FreeCAD/FreeCAD-git''' for the source, and '''/Users/username/FreeCAD/build''' for the build folder.

<!--T:93-->
Next, click the '''Configure''' button to populate the list of configuration options. This will display a dialog asking you to specify what generator to use. Leave it at the default '''Unix Makefiles.''' Configuring will fail the first time because there are some options that need to be changed. Note: You will need to check the '''Advanced''' checkbox to get all of the options.

<!--T:135-->
Set options from the table above, then click '''Configure''' again and then '''Generate'''.

=== CMake command line === <!--T:94-->

<!--T:145-->
Enter the following in the terminal.

</translate>
{{Code|code=
export PREFIX_PATH="/usr/local/opt/qt5152;\
/usr/local/Cellar/nglib/v6.2.2007/Contents/Resources;\
/usr/local/Cellar/vtk@8.2/8.2.0_1/lib/cmake;"
}}
<translate>

</translate>
{{Code|code=
$cd ~/FreeCAD/build
$cmake \
-DCMAKE_BUILD_TYPE="Release" \
-DBUILD_QT5=1 \
-DWITH_PYTHON3=1 \
-DCMAKE_PREFIX_PATH="$PREFIX_PATH" \
-DPYTHON_EXECUTABLE="/usr/local/bin/python3" \
-DFREECAD_USE_EXTERNAL_KDL=1 \
-DCMAKE_CXX_FLAGS='-std=c++14' \
-DBUILD_FEM_NETGEN=1 \
-DFREECAD_CREATE_MAC_APP=1 \
-DCMAKE_INSTALL_PREFIX="./.." \
../FreeCAD-git/

}}
<translate>

== Run make == <!--T:127-->

<!--T:146-->
Finally, from a terminal run '''make''' to compile and link FreeCAD, and generate the app bundle.

</translate>
{{Code|code=
cd ~/FreeCAD/build
cd ~/FreeCAD/build
make –j3
make -j5 install
}}
</pre>
<translate>
<translate>

<!--T:96-->
The -j option specifies how many make processes to run at once. One plus the number of CPU cores is usually a good number to use. However, if compiling fails for some reason, it is useful to rerun make without the -j option, so that you can see exactly where the error occurred.
The -j option specifies how many make processes to run at once. One plus the number of CPU cores is usually a good number to use. However, if compiling fails for some reason, it is useful to rerun make without the -j option, so that you can see exactly where the error occurred.


<!--T:115-->
If make finishes without any errors, you can now launch FreeCAD, either from Terminal with '''./bin/FreeCAD''', or by double clicking the executable in Finder.
See also [[Compiling_(Speeding_up)|Compiling - Speeding up]].
== Creating an application bundle ==

TODO
<!--T:97-->
== Updating ==
If make finishes without any errors, you can now launch FreeCAD by double clicking the executable in the Finder.
FreeCAD development happens fast; everyday or so there are bug fixes or new features. To get these changes, run:

== Updating from Github == <!--T:98-->

<!--T:147-->
FreeCAD development happens fast; every day or so there are bug fixes or new features. To get the latest changes, use git to update the source directory (see [[Source code management]]), then re-run the CMake and make steps above. It is not usually necessary to start with a clean build directory in this case, and subsequent compiles will generally go much faster than the first one.

== Building with Qt4 and Python 2.7 == <!--T:100-->

<!--T:148-->
FreeCAD has transitioned from Qt 4 to Qt 5 as well as homebrew. Qt 4 is no longer available as an option for new build on macOS following Qt 5 transition. Python 2.7 has been deprecated within homebrew and upcoming macOS and we do not support it anymore for macOS build either.

== Troubleshooting == <!--T:130-->

=== Segfault on Qt5 launch === <!--T:131-->

<!--T:149-->
If Qt4 was previously installed via brew, and you then build with Qt5, you may get a EXC_BAD_ACCESS (SEGSEGV) exception when launching the new Qt5 build. The fix for this is to manually uninstall Qt4.

</translate>
</translate>
{{Code|code=
<pre>
brew uninstall --ignore-dependencies --force cartr/qt4/shiboken@1.2 cartr/qt4/pyside@1.2 cartr/qt4/pyside-tools@1.2 cartr/qt4/qt-legacy-formula
cd ~/FreeCAD/FreeCAD-git
}}
git pull
</pre>
<translate>
<translate>
And then repeat the compile step above.
== Troubleshooting ==
TODO
{{docnav|CompileOnUnix|Third Party Libraries}}


=== Fortran === <!--T:101-->
[[Category:Developer Documentation]]

<!--T:150-->
''"No CMAKE_Fortran_COMPILER could be found."'' during configuration - Older versions of FreeCAD will need a fortran compiler installed. With Homebrew, do "brew install gcc" and try configuring again, giving cmake the path to Fortran ie -DCMAKE_Fortran_COMPILER=/opt/local/bin/gfortran-mp-4.9 . Or, preferably use a more current version of FreeCAD source!

=== FreeType === <!--T:117-->

<!--T:152-->
When using CMake versions older than 3.1.0, it's necessary to set CMake variable FREETYPE_INCLUDE_DIR_freetype2 manually, eg /usr/local/include/freetype2

=== Additional Build Instructions === <!--T:153-->

<!--T:154-->
FreeCAD can be built against the latest git master hosted on github, and launched from a CLI using libraries provided by the homebrew-freecad tap. For a complete list of build instructions see [https://github.com/ipatch/homebrew-us-05/tree/dev/freecad#building-freecad-for-macos-by-macos here].

<!--T:102-->
{{Docnav
|[[Compile_on_Linux|Compile on Linux]]
|[[Compile_on_Docker|Compile on Docker]]
}}


</translate>
</translate>
{{Userdocnavi{{#translation:}}}}
{{clear}}
[[Category:Developer_Documentation{{#translation:}}]]
<languages/>
[[Category:Developer{{#translation:}}]]

Latest revision as of 01:55, 13 March 2023

Other languages:
There is an experimental FreeCAD Docker container that is being tested for FreeCAD development. Read more about it at Compile on Docker

Overview

This page describes how to compile the FreeCAD source code on macOS. For other platforms, see Compiling.

These instructions have been tested on macOS Catalina with standard XCode 11.6. It is known to work on macOS BigSur Beta with XCode 12.0 beta. If you plan to use XCode Beta, please be sure to download Command Line Tools add on through a dmg package to workaround some libz dependency issues.

This page serves as a quick start, and is not intended to be comprehensive with regard to describing all the available build options.

If you just want to evaluate the latest pre-release build of FreeCAD, you can download pre-built binaries from here.

Install Prerequisites

The following software must be installed to support the build process.

Homebrew Package Manager

Homebrew is a command line based package manager for macOS. The Homebrew main page provides an installation command line that you simply paste into a terminal window.

CMake

CMake is a build tool that generates a build configuration based on variables you specify. You then issue the 'make' command to actually build that configuration. The command-line version of CMake is automatically installed as part of the Homebrew installation, above. If you prefer to use a GUI version of CMake, you can download it from here.

Install Dependencies

FreeCAD maintains a Homebrew 'cask' which installs the required formulas and dependencies. Issue the following brew commands in your terminal. 

brew tap freecad/freecad
brew install eigen
brew install --only-dependencies freecad

brew install may take quite a while, so you may want go grab a beverage. :-).

Alternately, you can install the individual dependencies manually by installing the following packages using brew install ...:

  • cmake
  • swig
  • boost
  • boost-python3
  • eigen
  • gts
  • vtk
  • xerces-c
  • qt@5 - Only Qt5 is currently supported, support for Qt6 is a work-in-progress
  • opencascade
  • doxygen
  • pkgconfig
  • coin3d - Note that as of this writing (Nov. 2022) this will install an unusable version of pyside@2 as a dependency.

There are several packages that are only available when you have tapped the freecad cask: you must do that (brew tap freecad/freecad). Due to some historical bug workarounds, at the time of this writing (Nov. 2022) the versions of PySide2 and Shiboken2 installed by Homebrew are not usable because they force the use of Py_Limited_API, which FreeCAD does not support. It is expected that this workaround will be removed in the coming months, but in the meantime you must use the FreeCAD cask versions of PySide and Shiboken. Use brew install ..., install the following packages:

  • freecad/freecad/pyside2@5.15.5
  • freecad/freecad/shiboken2@5.15.5
  • freecad/freecad/med-file
  • freecad/freecad/netgen

You will also need to "link" PySide and Shiboken: 

brew link freecad/freecad/pyside2@5.15.5 freecad/freecad/shiboken2@5.15.5

In some cases the packages installed by Homebrew do not use the same Python version: for example, at the time of this writing PySide2 uses Python 3.10, but boost-python3 uses Python 3.11. While it is possible to "roll back" the more advanced version (so that in this case boost-python3 uses Python 3.10) this is an advanced operation, and in many cases it is best to wait for an update to the other package. If you want to pursue that path anyway, look at the "brew extract" command, which you can use to extract a formula into a new cask (typically freecad/freecad). You can then edit that formula as needed.

You will need to set the path to Qt: Qt5 is currently supported, while support for Qt6 is a work-in-progress. Set FREECAD_QT_VERSION to "Auto" or "5" to select Qt5 (the default). On the command line, use something like: 

cmake \
  -DCMAKE_BUILD_TYPE="Release" \
  -DPYTHON_EXECUTABLE="/usr/local/bin/python3" \
  -DQt5_DIR="/usr/local/Cellar/qt@5/5.15.7/lib/cmake/Qt5" \
  -DPySide2_DIR="/usr/local/Cellar/pyside2@5.15.5/5.15.5/lib/cmake/PySide2-5.15.5" \
  -DShiboken2_DIR="/usr/local/Cellar/shiboken2@5.15.5/5.15.5_1/lib/cmake/Shiboken2-5.15.5" \
  ../freecad-source

Get the source

In the following instructions, the source and build folders are created side-by-side under 

/Users/username/FreeCAD

but you can use whatever folders you want. 

mkdir ~/FreeCAD
cd ~/FreeCAD

The following command will clone the FreeCAD git repository into a directory called FreeCAD-git. 

git clone https://github.com/FreeCAD/FreeCAD FreeCAD-git

Create the build folder. 

mkdir ~/FreeCAD/build

Run CMake

Next, we will run CMake to generate the build configuration. Several options must be passed to CMake. The following table describes the options and gives some background.

CMake Options

Name Value Notes
CMAKE_BUILD_TYPE Release (STRING) Release or Debug. Debug is generally used for developer-level testing but may also be required for user-level testing and troubleshooting.
CMAKE_PREFIX_PATH "/usr/local/opt/qt5152;" ... (PATH) Required to build with Qt5. See note below. You also need to add path to VTK libraries and NGLIB libraries cmake configuration file.
FREECAD_CREATE_MAC_APP 1 (BOOL) Create a FreeCAD.app bundle at the location specified in CMAKE_INSTALL_PREFIX, when the 'make install' command issued.
CMAKE_INSTALL_PREFIX "./.." (PATH) Path where you want to generate the FreeCAD.app bundle.
FREECAD_USE_EXTERNAL_KDL 1 (BOOL) Required.
BUILD_FEM_NETGEN 1 (BOOL) Required if choosing to build the FEM tools.

Note: Command line to generate CMAKE_PREFIX_PATH: 

ls -d $(brew list -1 | grep qt | tail -1 | xargs brew --cellar)/*/lib/cmake

CMake GUI

Open the CMake app, and fill in the source and build folder fields. In this example, it would be /Users/username/FreeCAD/FreeCAD-git for the source, and /Users/username/FreeCAD/build for the build folder.

Next, click the Configure button to populate the list of configuration options. This will display a dialog asking you to specify what generator to use. Leave it at the default Unix Makefiles. Configuring will fail the first time because there are some options that need to be changed. Note: You will need to check the Advanced checkbox to get all of the options.

Set options from the table above, then click Configure again and then Generate.

CMake command line

Enter the following in the terminal. 

export PREFIX_PATH="/usr/local/opt/qt5152;\
/usr/local/Cellar/nglib/v6.2.2007/Contents/Resources;\
/usr/local/Cellar/vtk@8.2/8.2.0_1/lib/cmake;"

$cd ~/FreeCAD/build
$cmake \
  -DCMAKE_BUILD_TYPE="Release"   \
  -DBUILD_QT5=1                  \
  -DWITH_PYTHON3=1               \
  -DCMAKE_PREFIX_PATH="$PREFIX_PATH" \
  -DPYTHON_EXECUTABLE="/usr/local/bin/python3" \
  -DFREECAD_USE_EXTERNAL_KDL=1   \
  -DCMAKE_CXX_FLAGS='-std=c++14' \
  -DBUILD_FEM_NETGEN=1           \
  -DFREECAD_CREATE_MAC_APP=1     \
  -DCMAKE_INSTALL_PREFIX="./.."  \
  ../FreeCAD-git/

Run make

Finally, from a terminal run make to compile and link FreeCAD, and generate the app bundle. 

cd ~/FreeCAD/build
make -j5 install

The -j option specifies how many make processes to run at once. One plus the number of CPU cores is usually a good number to use. However, if compiling fails for some reason, it is useful to rerun make without the -j option, so that you can see exactly where the error occurred.

See also Compiling - Speeding up.

If make finishes without any errors, you can now launch FreeCAD by double clicking the executable in the Finder.

Updating from Github

FreeCAD development happens fast; every day or so there are bug fixes or new features. To get the latest changes, use git to update the source directory (see Source code management), then re-run the CMake and make steps above. It is not usually necessary to start with a clean build directory in this case, and subsequent compiles will generally go much faster than the first one.

Building with Qt4 and Python 2.7

FreeCAD has transitioned from Qt 4 to Qt 5 as well as homebrew. Qt 4 is no longer available as an option for new build on macOS following Qt 5 transition. Python 2.7 has been deprecated within homebrew and upcoming macOS and we do not support it anymore for macOS build either.

Troubleshooting

Segfault on Qt5 launch

If Qt4 was previously installed via brew, and you then build with Qt5, you may get a EXC_BAD_ACCESS (SEGSEGV) exception when launching the new Qt5 build. The fix for this is to manually uninstall Qt4. 

brew uninstall --ignore-dependencies --force cartr/qt4/shiboken@1.2 cartr/qt4/pyside@1.2 cartr/qt4/pyside-tools@1.2 cartr/qt4/qt-legacy-formula

Fortran

"No CMAKE_Fortran_COMPILER could be found." during configuration - Older versions of FreeCAD will need a fortran compiler installed. With Homebrew, do "brew install gcc" and try configuring again, giving cmake the path to Fortran ie -DCMAKE_Fortran_COMPILER=/opt/local/bin/gfortran-mp-4.9 . Or, preferably use a more current version of FreeCAD source!

FreeType

When using CMake versions older than 3.1.0, it's necessary to set CMake variable FREETYPE_INCLUDE_DIR_freetype2 manually, eg /usr/local/include/freetype2

Additional Build Instructions

FreeCAD can be built against the latest git master hosted on github, and launched from a CLI using libraries provided by the homebrew-freecad tap. For a complete list of build instructions see here.

User documentation
Retrieved from "http://wiki.freecad.org/index.php?title=Compile_on_MacOS&oldid=1238390"