Installing the DREAM3D_SDK on Windows (7, 8, 8.1)

In order to compile DREAM.3D the developer will need to install all the dependent libraries that are needed by DREAM.3D. In order to help streamline this process the DREAM.3D development team has created some shell scripts and source archives that enable the developer to quickly generate what we call the DREAM3D_SDK or DREAM.3D Software Development Kit. The developer should be comfortable executing commands from a terminal in order to successfully get everything compiled and installed.

The first step that needs to be performed by the developer is to install Microsoft Visual Studio 2013 Community or Visual Studio 2013 Professional ($500). The DREAM3D SDK libraries are built against this version of Visual Studio and WILL NOT work with any other version. The community version is free for any open source project. Once Visual Studio is installed correctly the next steps can be performed.

​Download the pre-built libraries from our websiteDREAM3D_SDK_x64_VS2013_SP4_V64.exe. Once downloaded, double click the installer to install all the libraries. The image below shows an example location to install the SDK into.

Once the DREAM3D_SDK installer is complete (this may take 15-30 minutes to complete depending on the speed of the computer and the speed of the internet connection)  The developer is also strongly encouraged to install http://download.qt.io/official_releases/vsaddin/qt-vs-addin-1.2.4-opensource.exe as it will aid in debugging Qt data structures. Part of the DREAM3D_SDK installation will install Qt 5.6.0 into the DREAM3D_SDK directory. Qt 5.6 will be downloaded directly from the Qt-Project servers located at http://download.qt.io.

The developer will need to clone the DREAM.3D repository at http://github.com/dream3d. An easy way to get Git on your Windows system is to install SourceTree for windows. After SourceTree is installed launch SourceTree and click the "Clone/New" icon in the toolbar. A new window will appear with some basic information that the developer needs to fill out. See the image below for details. After the details are filled in correctly, click the "Clone" button to get started. The clone can take a few minutes to complete so be patient.

When the clone is complete, the SourceTree app should look like the image below.

Now we can move on to configuring and compiling DREAM.3D using CMake and Visual Studio 2013 (Pro or Community). Look in the DREAM3D_SDK and the CMake 3.5.x folder for the CMake-gui.exe application. Double click to launch CMake Gui and set the source code and binary directories like the image below.

Next, Click on the "Add Entry" button to add a CMake variable that describes where the DREAM3D_SDK is located. Again, fill out the fields like the image below and click "OK".

The CMake window should now look like this image.

  • Click on the "Configure" button which then reveals the next image. Select the appropriate Generator for Visual Studio as seen in the image below and then click the "Finish" button. This will start the configuration process which will take a few minutes. During the first configuration run of CMake three (3) more repositories will be cloned:
  • http://github.com/bluequartzsoftware/CMP
  • http://github.com/bluequartzsoftware/SIMPLib
  • http://github.com/bluequartzsoftware/SIMPLView

These repositories can be large so be patient while the remaining sources are downloaded.

After it completes the main CMake window will appear and the developer should click the "Configure" button once more. In order for Visual Studio to take advantage of modern multi-core computer the developer should add the "/MP" argument to the CMAKE_CXX_FLAGS variable (See image below). Once that configure run completes the developer should now click the "Generate" button.

After generation is complete the developer can open the DREAM3DProj.sln file that is located in the "Where to build the binaries" location. Once the project is open in Visual Studio the developer can simply compile DREAM.3D in Debug or Release mode.

Enter your text here...