CMake on Windows, Linux, and MacOS X Operating Systems
This build system is currently only available when using the GSFC-internal GMAT Git repository.
Before starting, make sure that you have cloned GMAT from the GSFC-internal repository.
These instructions refer to
<GMAT> as the top-level GMAT repository folder.
Figure 1. The
<GMAT> repository layout
The GMAT build process can be broken down into four main steps:
- Download and configure the dependencies (e.g. CSPICE, wxWidgets, etc.)
- Create the build system using CMake
- Build GMAT. Optionally, you can also install GMAT after building.
- Run GMAT
The first two steps are generally "one-time" processes that are performed immediately after downloading the GMAT repository. They result in a build system (e.g. Visual Studio solution or makefiles) that will intelligently rebuild GMAT components as needed when source or configuration files are changed.
Step 1: Download and Configure GMAT Dependencies
<GMAT>/depends folder contains scripts to automatically download and configure the GMAT dependencies.
- Windows: Visual Studio 2010 or 2013 (Express or Paid versions). If using VS2010 Express, you will need the Microsoft 7.1 SDK.
- Mac: XCode tools, with the command line developer tools
- Linux: gcc compiler tools
Figure 2. <GMAT>/depends folder layout after dependency configuration
→ To set up GMAT dependencies, double-click the
configure.sh (Mac/Linux) or
configure.bat (Windows) script.
- On Windows you will be prompted to select 32-vs-64 bit dependencies and a VisualStudio version. Choose according to your VisualStudio installation. On Mac/Linux these choices are currently auto-selected based on the system architecture.
- You can also run these scripts by name from the Terminal (Mac/Linux) or Command Prompt (Windows).
→ The script will download, build, and configure the GMAT dependencies. The resulting
<GMAT>/depends folder structure should look like Figure 2.
Step 2: Create GMAT Build System Using CMake
Requirements (in addition to Step 1 requirements):
- All Operating Systems: CMake (Minimum version 2.8.12)
- Linux: libgtk2.0-dev or libgtk-3-dev
- Optional: MATLAB (if building MatlabInterface or CInterface plugins)
→ Launch the CMake GUI:
Tip: Make sure to select the "Grouped" option in the CMake GUI (Figure 3) to sort CMake variables and make them easier to find.
Figure 3. Components of the CMake GUI
→ Enter values into the CMake GUI in the following order (as annotated in Figure 3):
- Enter the full path to the
<GMAT> cloned repository on your computer
- Enter the full path to the folder where all CMake files and build products should be placed
- CMake produces out-of-source builds. It is recommended to use
<GMAT>/build/<OS>/cmake-build for this value.
- Click "Configure"
- CMake may ask for permission to create the folder you chose in Step 2 ("Where to build the binaries")
- CMake will ask you to choose a generator (see Figure 4). See the CMake Generator webpage for an explanation of available generators.
Recommended generators are:
- Mac: Unix Makefiles (although XCode has also been observed to work)
- Linux: Unix Makefiles
- Windows: Visual Studio (note e.g. "Visual Studio 12 2013" is 32-bit, whereas "Visual Studio 12 2013 x64" is 64-bit)
Figure 4. Choosing a generator in CMake
- CMake will start the configuration process, after which the Variable List and Configure Results sections (Figure 3 sections
4b) will be populated:
Figure 5. Output of CMake Configure
Use the Configure results output box (Figure 3 section
4a) to change variables in CMake variable list (Figure 3 section
4b) as follows:
- Always start at the top of the configure results output box and correct errors one-by-one
- For each error: change the appropriate CMake variable, re-configure, confirm the error was fixed (in the results output box), then repeat for next error
In addition to errors, there are several CMake variables that allow you to control how the build system configures GMAT:
|CMake Variable (Group)||Description||Associated CMake Error|
|Path to CSPICE root directory|
|CSPICE NOT FOUND|
|Path to F2C root directory|
Note: this should generally be
|F2C NOT FOUND|
|On makefile systems, this specifies the desired build type |
On VisualStudio/XCode systems, this specifies all possible build types
Note: On makefile systems, you should create a separate out-of-source build folder for each desired build type (Figure 3 box
|Location to install GMAT when doing |
or building the VisualStudio->
|Whether to build the GMAT GUI||N/A|
|Full path to the top-level GMAT Proprietary Plugins folder.|
|Path to MATLAB root directory |
(on Mac, this is the path to MATLAB_R20xxx.app)
|Matlab NOT FOUND|
|Whether to build a particular GMAT Plugin |
Note: the proprietary plugins only show up here if
GMAT_PROPRIETARY_PLUGINS has been correctly set
|Mac/Linux: Path to wxWidgets |
(usually this is the wxWidgets
Windows: Path to wxWidgets
|wxWidgets NOT FOUND|
When all CMake errors are handled and you have specified all desired GMAT options, click "Generate".
CMake will create the build system in the chosen out-of-source build folder (Figure 3 box 2).
Step 3: Build and Install GMAT
→ Go to the build system folder (chosen in Figure 3 box 2), and follow the OS-specific instructions below.
Windows (Visual Studio)
- Open the
GMAT.sln Visual Studio solution. After loading, you should see the following projects:
Figure 5. CMake-generated VisualStudio2013 Solution
NOTE: This list may vary according to the GMAT plugins you chose in Step 2.
The common projects you will see are:
ALL_BUILD: The default startup project. Ensures that all other projects are up-to-date, then builds them.
ZERO_CHECK: Performs the work to ensure all other projects are up-to-date. It is automatically built along with all other projects.
INSTALL: Creates a standalone GMAT folder containing all executables, plugins, data files, samples, and documentation.
GmatGUI, Plugins: The various GMAT components. You can build these individually if desired.
- Choose a build configuration, e.g.
- Build the
ALL_BUILD project. Depending on your system speed and number of selected GMAT components, this may take a while!
- (Optional) Build the
INSTALL project if you want a fully standalone and relocatable version of GMAT.
MacOS and Linux (makefiles)
Makefiles are run through the command line, which on Mac and Linux can be accessed via the Terminal application.
In these instructions,
<CMake_binary_path> is the path to the build system folder that you chose in Step 2 (Figure 3 box 2).
- Open a command prompt and type the following commands (assuming
$ is your command prompt):
$ cd <CMake_binary_path>
- Note: if you know your computer has N cores, you can also do "
make -jN" to significantly speed up the compile time
- (Optional) Do "
make install" if you want a fully standalone and relocatable version of GMAT.
Step 4: Run GMAT
After building, you have several options for how to run GMAT:
- All Operating Systems: GMAT executables and plugins are placed in the
<GMAT>/application directory. You can run GMAT from the
debug/) subfolders without having to perform the optional INSTALL step. This allows for a more rapid edit-build-test cycle.
- All Operating Systems: If you built the optional INSTALL project in Step 3, then a standalone copy of GMAT is placed in the
CMAKE_INSTALL_PREFIX folder that you chose in Step 2. The GMAT executables will be in the
- Windows: In addition to the above two methods, you can also run the
GmatGUI projects directly from within VisualStudio. This allows for in-program debugging with breakpoints.
- Select the configuration that you want to run (
Right-click on the
GmatGUI project, and select "Set as Startup Project"
Select menu item Debug -> Start Debugging (or Starting Without Debugging for Release configurations)
Building GMAT Navigation branch using CMake on Windows
- Git clone GMAT Navigation branch. The following example dialog shows the GMAT git repository URL and Directory where Navigation branch will be cloned. Use the correct URL and your id in the URL field. Note that Branch checkbox is checked and branch name is “navigation.” Click “OK” to start cloning the repository.
- Follow Steps 1 and 2 for configuring and generating VS 2013 solution using CMake from the wiki link http://gmatcentral.org/display/GW/GMAT+CMake+Build+System
- Navigation build needs additional library called “xerces” (https://xerces.apache.org/xerces-c/). At this time, the XML Parser (Xerces) is not automatically downloaded and configured in Step 2 above (it will be added in a future). Temporarily you can copy “xerces” files from the \Builds\windows\xerces-c-3.1.2 on mesa-file server. The “xerces” libraries on mesa-file were built using VS 2013. If you have other version of VS C++, you will need to build “xerces” libraries on your own and configure CMake to build GMAT using the same compiler. In order to manually add “xerces” include and library to GmatEstimation project, first open GMAT.sln in where it was configured and generated from the CMake. The example solution was generated in C:\Projects\GmatNavigation\build\windows-VS2013-CMake-32. The following shows when GMAT.sln is opened.
- First, add “xerces” include file to “Plugin GmatEstimation” project. Right click on “Plugin GmatEstimation” and select “Properties.” Expand “C/C++” and select “General.” In “Additional Include Directories” field, add “xerces” source directory where you coped into. The example shows “C:\xerces-c-3.1.2\src” was added at the end. You can also add it by clicking the down error symbol and “<Edit…>.”
- Next, add “xerces” library to “Plugin GmatEstimation” project. While “Plugin GmatEstimation Properties Pages” is still open, expand “Linker” and select “Input.” Add “YourXercesDir\Build\Win32\VC12\Release\xerces-c_3.lib” to “Additional Dependencies” field. The example shows C:\xerces-c-3.1.2\Build\Win32\VC12\Release\xerces-c_3.lib was added at the end.
- Next, build the solution. Right click on “ALL_BUILD” and select “Rebuild.”
- When build has finished, the GMAT executable and base dynamic libraries (DLLS) are located in /application/bin directory. Other Plugin DLLS are located in application/plugins.
- Before running GMAT, copy the xerces DLL “xerces-c_3_1.dll” from “YourXercesDir\Build\Win32\VC12\Release” to /application/bin directory. Now you can double click on GMAT.exe to launch GMAT application.