Difference between revisions of "CompileOnMac/fr"

From FreeCAD Documentation
Jump to: navigation, search
(Updating to match new version of source page)
(Updating to match new version of source page)
Line 1: Line 1:
This page explains how to compile the latest FreeCAD source code on Mac OS X.
+
This page explains how to compile the latest FreeCAD source code on Mac OS X. It is meant as a starting point for developing on FreeCAD; if you instead want to try using the latest pre-release version of FreeCAD, downloads are available from our continuous integration system at https://github.com/FreeCAD/FreeCAD/releases .  
 
 
See also [[Compiling_(Speeding_up)|Compiling - Speeding up]] How to speed up compilation.
 
  
 
== Prerequisites ==
 
== Prerequisites ==
 
First of all, you will need to install the following software.
 
First of all, you will need to install the following software.
 
=== 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.
 
<pre>
 
xcode-select --install
 
</pre>
 
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.
 
  
 
=== Package Manager ===
 
=== Package Manager ===
You will want to use a package manager to install prerequisite software, this page gives instructions for two of the common package managers in use for OS X: [http://brew.sh/ Homebrew] and [https://www.macports.org/ MacPorts].  It's easiest to pick one package manager for your system, and not have multiple package managers installed concurrently.  Currently (October 2015), Homebrew has more up-to-date libraries relating to FreeCAD than MacPorts.
+
For FreeCAD, we usually use [https://brew.sh/ Homebrew], though MacPorts was used previously.
 
 
==== Homebrew ====
 
To install Homebrew, enter the following in Terminal:
 
<pre>
 
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
 
</pre>
 
 
 
==== MacPorts ====
 
To install MacPorts, follow the instructions [https://www.macports.org/install.php from their website]
 
  
 
=== CMake ===
 
=== CMake ===
FreeCAD uses [http://www.cmake.org/ CMake] to build the source.  CMake comes in two versions, command-line and GUI. Choose the one you prefer.
+
FreeCAD uses [http://www.cmake.org/ CMake] to build the source.  CMake comes in two versions, command-line and GUI. Use whichever you prefer.
  
==== Homebrew ====
+
The command-line version of CMake will be automatically installed by Homebrew in the prerequisites step, or the GUI version can be downloaded directly from https://www.cmake.org/download .
 
 
Command-line version:
 
 
 
<pre>
 
brew install cmake
 
</pre>
 
 
 
GUI:
 
 
 
Install directly from http://www.cmake.org/download.
 
 
 
==== MacPorts ====
 
 
 
Command-line:
 
 
 
<pre>
 
sudo port install cmake
 
</pre>
 
 
 
GUI:
 
 
 
<pre>
 
sudo port install cmake +gui
 
</pre>
 
  
 
== Installing the Dependencies ==
 
== Installing the Dependencies ==
All of the needed libraries can be installed using either Homebrew or MacPorts.
+
All of the needed libraries can be installed using Homebrew. We maintain a "tap" including a formula for FreeCAD, it can be used to get the relevant dependencies:
  
=== Homebrew Dependencies ===
+
''Note that there is currently a bug where the dependencies aren't all installed on the first run of brew install... - the duplicate line below is intentional''
 
<pre>
 
<pre>
 
brew tap homebrew/science
 
brew tap homebrew/science
brew tap sanelson/freecad
+
brew tap freecad/freecad
brew install boost eigen freetype oce python qt pyside pyside-tools xerces-c boost-python
+
brew install --only-dependencies freecad
brew install --without-framework --without-soqt sanelson/freecad/coin
+
brew install --only-dependencies freecad
brew install --HEAD pivy
 
brew install --with-oce nglib
 
</pre>
 
 
 
=== MacPorts Dependencies ===
 
<pre>
 
sudo port install qt4-mac boost eigen3 freetype oce py27-pyside-tools xercesc Coin vtk hdf5
 
 
</pre>
 
</pre>
  
Line 78: Line 29:
 
cd ~/FreeCAD
 
cd ~/FreeCAD
 
</pre>
 
</pre>
To get the FreeCAD source code, run:
+
To get the FreeCAD source code, this command will create a "clone" of the FreeCAD git repository in to a new directory called FreeCAD-git:
 
<pre>
 
<pre>
 
git clone https://github.com/FreeCAD/FreeCAD FreeCAD-git
 
git clone https://github.com/FreeCAD/FreeCAD FreeCAD-git
Line 84: Line 35:
  
 
== Building FreeCAD ==
 
== Building FreeCAD ==
First, create a new folder for the build:
+
Create a new folder for the build:
 
<pre>
 
<pre>
 
mkdir ~/FreeCAD/build
 
mkdir ~/FreeCAD/build
Line 96: Line 47:
 
! Name !! Value  !! Notes
 
! Name !! Value  !! Notes
 
|-               
 
|-               
| BUILD_ROBOT || 0 (unchecked) || The robot module depends on Orocos KDL, and the version of KDL included with FreeCAD currently (October 2015) doesn't build on recent MacOS.  To build the robot module, install Orocos KDL (no MacPorts package is currently available), and specify FREECAD_USE_EXTERNAL_KDL=1 instead.
+
| FREECAD_USE_EXTERNAL_KDL || 1 (checked) ||  
|-             
 
| CMAKE_BUILD_TYPE || Release ||
 
|-             
 
| FREECAD_USE_EXTERNAL_PIVY  || 1 (checked) || Homebrew only
 
|-             
 
| FREETYPE_INCLUDE_DIR_freetype2 || /usr/local/include/freetype2 for Homebrew, /opt/local/include/freetype2 for MacPorts|| Only CMake version older than 3.1.0
 
 
|-
 
|-
| BUILD_FEM_NETGEN || 1 (checked) || Homebrew only
+
| CMAKE_BUILD_TYPE || Debug || Can be Debug or Release.  Debug is generally used for development
 
|-
 
|-
| QT_QMAKE_EXECUTABLE || /opt/local/libexec/qt4/bin/qmake || MacPorts only (and probably temporary)
+
| BUILD_FEM_NETGEN || 1 (checked) ||
 
|-
 
|-
| FREECAD_CREATE_MAC_APP || 1 (checked) || If you want to make a FreeCAD.app Then when you run "make install" it will create the FreeCAD.app where ever CMAKE_INSTALL_PREFIX is set to.
+
| FREECAD_CREATE_MAC_APP || 1 (checked) || If you want to make a FreeCAD.app , this CMake option will cause "make install" to create a FreeCAD.app bundle in CMAKE_INSTALL_PREFIX .
 
|}
 
|}
  
Line 121: Line 66:
 
<pre>
 
<pre>
 
$cd ~/FreeCAD/build
 
$cd ~/FreeCAD/build
$cmake -DBUILD_ROBOT="0" ...options continue... -DFREECAD_CREATE_MAC_APP ="1" ../FreeCAD-git
+
$cmake -DFREECAD_USE_EXTERNAL_KDL="1" ...options continue... -DFREECAD_CREATE_MAC_APP ="1" ../FreeCAD-git
 
</pre>
 
</pre>
  
Line 131: Line 76:
 
</pre>
 
</pre>
 
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.
 +
 +
See also [[Compiling_(Speeding_up)|Compiling - Speeding up]].
  
 
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.
 
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.
  
 
== Updating ==
 
== Updating ==
FreeCAD development happens fast; everyday or so there are bug fixes or new features. To get these changes, run:
+
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.
<pre>
 
cd ~/FreeCAD/FreeCAD-git
 
git pull
 
</pre>
 
And then repeat the compile step above.
 
  
 
== Troubleshooting ==
 
== Troubleshooting ==
  
 
=== Fortran ===
 
=== 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, for Macports, do "sudo port install gcc49" and give 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!
+
''"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!
  
 
=== OpenGL ===
 
=== OpenGL ===
See [[OpenGL_on_MacOS|OpenGL on MacOS]]
+
See [[OpenGL_on_MacOS|OpenGL on MacOS]] for OpenGL issues when Qt 4.8 and earlier are used on MacOS.
 +
 
 +
=== 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
  
 
{{docnav/fr|[[CompileOnUnix/fr|CompileOnUnix]]|[[Third Party Libraries/fr|Third Party Libraries]]}}
 
{{docnav/fr|[[CompileOnUnix/fr|CompileOnUnix]]|[[Third Party Libraries/fr|Third Party Libraries]]}}

Revision as of 20:18, 19 February 2017

This page explains how to compile the latest FreeCAD source code on Mac OS X. It is meant as a starting point for developing on FreeCAD; if you instead want to try using the latest pre-release version of FreeCAD, downloads are available from our continuous integration system at https://github.com/FreeCAD/FreeCAD/releases .

Prerequisites

First of all, you will need to install the following software.

Package Manager

For FreeCAD, we usually use Homebrew, though MacPorts was used previously.

CMake

FreeCAD uses CMake to build the source. CMake comes in two versions, command-line and GUI. Use whichever you prefer.

The command-line version of CMake will be automatically installed by Homebrew in the prerequisites step, or the GUI version can be downloaded directly from https://www.cmake.org/download .

Installing the Dependencies

All of the needed libraries can be installed using Homebrew. We maintain a "tap" including a formula for FreeCAD, it can be used to get the relevant dependencies:

Note that there is currently a bug where the dependencies aren't all installed on the first run of brew install... - the duplicate line below is intentional

brew tap homebrew/science
brew tap freecad/freecad
brew install --only-dependencies freecad
brew install --only-dependencies freecad

Getting the source

In this guide, the source and build folders are created in /Users/username/FreeCAD, but you can of course use whatever folder you want.

mkdir ~/FreeCAD
cd ~/FreeCAD

To get the FreeCAD source code, this command will create a "clone" of the FreeCAD git repository in to a new directory called FreeCAD-git:

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

Building FreeCAD

Create a new folder for the build:

mkdir ~/FreeCAD/build

Now you will need to run CMake to generate the build files. Several options will need to be given to CMake, which can be accomplished either with the CMake GUI application, or via the command line.

CMake Options

Name Value Notes
FREECAD_USE_EXTERNAL_KDL 1 (checked)
CMAKE_BUILD_TYPE Debug Can be Debug or Release. Debug is generally used for development
BUILD_FEM_NETGEN 1 (checked)
FREECAD_CREATE_MAC_APP 1 (checked) If you want to make a FreeCAD.app , this CMake option will cause "make install" to create a FreeCAD.app bundle in CMAKE_INSTALL_PREFIX .

CMake GUI

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.

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

Open a terminal, cd in to the build directory that was created above. Run cmake with options from the table above, following the formula -D(Name)="(Value)", and the path to your FreeCAD source directory as the final argument.

$cd ~/FreeCAD/build
$cmake -DFREECAD_USE_EXTERNAL_KDL="1" ...options continue... -DFREECAD_CREATE_MAC_APP ="1" ../FreeCAD-git

Make

Finally, from a terminal run make to compile FreeCAD.

cd ~/FreeCAD/build
make –j3

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, either from Terminal with ./bin/FreeCAD, or by double clicking the executable in Finder.

Updating

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.

Troubleshooting

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!

OpenGL

See OpenGL on MacOS for OpenGL issues when Qt 4.8 and earlier are used on MacOS.

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

Arrow-left.svg Page précédente: CompileOnUnix
Page suivante: Third Party Libraries Arrow-right.svg
Other languages:
čeština • ‎Deutsch • ‎English • ‎español • ‎français • ‎italiano • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎русский • ‎svenska • ‎Türkçe