Users:HowToUseCarat/InstallationWindows

From Carat++ Public Wiki
(Difference between revisions)
Jump to: navigation, search
(Created page with "This page shows how Carat++ can be compiled under a Windows environment. * Windows 10 64bit * Microsoft Visual Studio 2015 * TODO git/svn * CMake XXX * Boost 1.63.0 * MKL (Intel ...")
 
Line 18: Line 18:
 
== IDE ==  
 
== IDE ==  
  
−
The IDE of choice is Micrsoft Visual Studio 2015 and the related
+
The IDE of choice is Micrsoft Visual Studio 2015.
 +
Install it with user defined settings and make shure to check the C++ components as they are not installed by default:
 +
 
 +
TODO Anna, bitte hierzu screenshots machen, hab ich falsch gemacht:
 +
In Visual Studio 2015 ist Visual C++ nicht standardmäßig installiert Achten Sie bei der Installation darauf, Benutzerdefiniert und anschließend die erforderlichen C++-Komponenten auszuwählen. Wenn Visual Studio bereits installiert ist, wählen Sie Datei | Neu | Projekt | C++, anschließend werden Sie aufgefordert, die erforderlichen Komponenten zu installieren.
  
 
== Git ==
 
== Git ==
Line 40: Line 44:
 
== Boost ==
 
== Boost ==
  
−
Get the latest boost library from https://boost.org.
+
Get the boost library version 1.63.0 from https://boost.org.
 
Download and unpack it.  
 
Download and unpack it.  
 
Copy the unpacked folder with the version number into the "carat/libs" directory.
 
Copy the unpacked folder with the version number into the "carat/libs" directory.
Line 47: Line 51:
  
 
# Open the Windwos command prompt.
 
# Open the Windwos command prompt.
−
# Navigate to the "carat/libs/boost_X_XX directory.
+
# Navigate to the "carat/libs/boost_1_63_0 directory.
 
# Compile boost with the following lines in the command prompt.
 
# Compile boost with the following lines in the command prompt.
  
 
<pre>
 
<pre>
−
 
+
bootstrap
 +
b2 link=shared address-model=64
 +
b2 link=static address-model=64 runtime-link=static
 
</pre>
 
</pre>
  
−
Now add the following path to the compiled boost libraries to your environmental variable "PATH":
+
# Now add the following path to the compiled boost libraries to your environmental variable "Path":
  
 
<pre>
 
<pre>
−
 
+
C:\carat\libs\boost_1_63_0\stage\lib\
 
</pre>
 
</pre>
  
Line 64: Line 70:
 
Intel MKL is a equation solving library, that is strongly recommended to use.  
 
Intel MKL is a equation solving library, that is strongly recommended to use.  
  
−
This guide shows a simple Installation without any administrator rights.
+
# Install the Intel mkl package located at "\\DC01\F_Users\TEMP\software\intel_suite\MKL_2017_standalone\windows" with default settings.
−
(Advanced: To use all the features of the intel suite please refer to http://129.187.141.105/trac/wiki/IntelSuite12.1)
+
# Now add the following path to the compiled boost libraries to your environmental variable "Path":
  
−
# Copy the "license.lic" from smb://dc01/f_users/TEMP/software/intel_suite into ~/software/intel/ into into e.g. ~/software/intel/.
+
<pre>
−
# Copy the Intel Composer package "l_ccompxe_2013_sp1.2.144.tgz" from smb://dc01/f_users/TEMP/software/intel_suite/Intel_Comp14SP1 into e.g. ~/software/intel/.
+
C:\Program Files (x86)\IntelSWTools\compilers_and_libraries_2017\windows\redist\intel64\mkl\
−
# Unpack it and execute the "install_GUI.sh".
+
</pre>
−
# Select "Install as current user"
+
−
# Select "Chose alternative activation"
+
−
# Select "Use a license file"
+
−
# Browse to "~/software/intel/license.lic"
+
−
# Costumize installation
+
−
# Destination Folder: Browse to "~/software/intel/2013/
+
−
# Ignore warnings about missing Java and 32bit. To use MKL solver this is not needed.
+
−
# After installation you can delete "l_ccompxe_2013_sp1.2.144.tgz" and l_ccompxe_2013_sp1.2.144
+
  
 
== Compile Carat ==
 
== Compile Carat ==
Line 86: Line 84:
  
 
Navigate to the Carat++ source directory and make a copy of the "cmake_personal_input.template" to "cmake_personal_input.dat".
 
Navigate to the Carat++ source directory and make a copy of the "cmake_personal_input.template" to "cmake_personal_input.dat".
−
<pre>
+
Do not modify the "cmake_personal_input.template"
−
~/software/carat/src
+
−
cp cmake_personal_input.template cmake_personal_input.dat
+
−
</pre>
+
 
In this file you find the following part with commented lines where you have to set your user defined paths:
 
In this file you find the following part with commented lines where you have to set your user defined paths:
 
<pre>
 
<pre>
Line 113: Line 108:
  
 
set(CARAT_ROOT "~/software/carat")
 
set(CARAT_ROOT "~/software/carat")
−
set(LIB_BOOST_INCLUDE_DIR "~/software/carat/libs/boost_1_63_0")
+
set(LIB_BOOST_INCLUDE_DIR "C:/carat/libs/boost_1_63_0")
−
set(LIB_BOOST_DIR "~/software/carat/libs/boost_1_63_0/boost")
+
set(LIB_BOOST_DIR "C:/carat/libs/boost_1_63_0/boost")
−
set(LIB_MKL_DIR "~/software/intel/xe_2013/composer_xe_2013_sp1/mkl")
+
set(LIB_MKL_DIR "C:/Program Files (x86)/IntelSWTools/compilers_and_libraries_2017/mkl")
 
</pre>
 
</pre>
  
−
=== Set up the project ===
+
=== Create the project with CMake===
  
−
Navigate to the "build" directory. This is important so that all files are created here:
+
TODO
−
<pre>
+
−
~/software/carat/build
+
−
</pre>
+
−
Use ccmake to set up the project:
+
−
<pre>
+
−
ccmake ../src/
+
−
</pre>
+
  
−
Press "c" to configure the project. And set the follwing settings for a very basic installation:  
+
Set the following settings for a very basic installation:  
  
 
<pre>
 
<pre>
Line 139: Line 127:
 
  BUILD_STATIC_LIB                OFF                                                                                                                                                                       
 
  BUILD_STATIC_LIB                OFF                                                                                                                                                                       
 
  CFD_OPT                          OFF                                                                                                                                                                       
 
  CFD_OPT                          OFF                                                                                                                                                                       
−
  CMAKE_BUILD_TYPE                 Release                                                                                                                                                                 
+
  CMAKE_BUILD_TYPE                                                                                                                                                                                  
 
  CMAKE_INSTALL_PREFIX            /usr/local                                                                                                                                                               
 
  CMAKE_INSTALL_PREFIX            /usr/local                                                                                                                                                               
 
  ENABLE_CHOLMOD                  OFF                                                                                                                                                                       
 
  ENABLE_CHOLMOD                  OFF                                                                                                                                                                       
Line 150: Line 138:
 
  MODULE_REPORT                    ON                                                                                                                                                                       
 
  MODULE_REPORT                    ON                                                                                                                                                                       
 
  USE_32bit                        OFF                                                                                                                                                                       
 
  USE_32bit                        OFF                                                                                                                                                                       
−
  USE_BOOST_LOGGING                OFF                                                                                                                                                                      
+
  USE_BOOST_LOGGING                ON                                                                                                                                                                      
 
  USE_COSIMULATION                OFF                                                                                                                                                                       
 
  USE_COSIMULATION                OFF                                                                                                                                                                       
 
  USE_FLANN_64BIT                  OFF                                                                                                                                                                       
 
  USE_FLANN_64BIT                  OFF                                                                                                                                                                       
Line 161: Line 149:
 
</pre>
 
</pre>
  
−
Press "g" to generate.
+
Generate the project
 +
 
 +
=== Open the Carat++ project with Visual Studio 2015 ===
 +
 
 +
TODO open the .sln in the build directory
  
 
=== Compile ===
 
=== Compile ===
  
−
Still in the "build" directory:
 
−
<pre>
 
−
make -j 8
 
−
</pre>
 
  
−
Now you have a compiled version of Carat++ in your build directory.
 
−
In [[Users:HowToUseCarat#Step_2:_Run_Carat|Run Carat]] it is explained how to run Carat++.
 
  
 
== Benchmarks ==  
 
== Benchmarks ==  
  
 
After each build or at least before a git commit the benchmarks have to be tested.
 
After each build or at least before a git commit the benchmarks have to be tested.
−
In the "build" directory type:
+
 
−
<pre>
+
# RUN_TEST
−
make test
+
−
</pre>
+

Revision as of 14:20, 2 March 2017

This page shows how Carat++ can be compiled under a Windows environment.

  • Windows 10 64bit
  • Microsoft Visual Studio 2015
  • TODO git/svn
  • CMake XXX
  • Boost 1.63.0
  • MKL (Intel mkl 2017)


Contents

Windows Version

In this installation guide Windows 10 64bit is used.

Carat++ installation was tested also under the following Windows versions:

  1. TODO please add more if you tested it there

IDE

The IDE of choice is Micrsoft Visual Studio 2015. Install it with user defined settings and make shure to check the C++ components as they are not installed by default:

TODO Anna, bitte hierzu screenshots machen, hab ich falsch gemacht: In Visual Studio 2015 ist Visual C++ nicht standardmäßig installiert Achten Sie bei der Installation darauf, Benutzerdefiniert und anschließend die erforderlichen C++-Komponenten auszuwählen. Wenn Visual Studio bereits installiert ist, wählen Sie Datei | Neu | Projekt | C++, anschließend werden Sie aufgefordert, die erforderlichen Komponenten zu installieren.

Git

Git is used as version control system. It is needed to download the Carat++ source code.

TODO

Get the source code

TODO

Create directory for build and libraries

TODO

CMake

Install the latest CMake version


Boost

Get the boost library version 1.63.0 from https://boost.org. Download and unpack it. Copy the unpacked folder with the version number into the "carat/libs" directory.

In order to use the Boost logging, it needs to be compiled:

  1. Open the Windwos command prompt.
  2. Navigate to the "carat/libs/boost_1_63_0 directory.
  3. Compile boost with the following lines in the command prompt. 
bootstrap
b2 link=shared address-model=64
b2 link=static address-model=64 runtime-link=static
  1. Now add the following path to the compiled boost libraries to your environmental variable "Path": 
C:\carat\libs\boost_1_63_0\stage\lib\

MKL

Intel MKL is a equation solving library, that is strongly recommended to use.

  1. Install the Intel mkl package located at "\\DC01\F_Users\TEMP\software\intel_suite\MKL_2017_standalone\windows" with default settings.
  2. Now add the following path to the compiled boost libraries to your environmental variable "Path": 
C:\Program Files (x86)\IntelSWTools\compilers_and_libraries_2017\windows\redist\intel64\mkl\

Compile Carat

User Settings

First of all it is necessary to set some paths depending on where you stored the carat source and libs.

Navigate to the Carat++ source directory and make a copy of the "cmake_personal_input.template" to "cmake_personal_input.dat". Do not modify the "cmake_personal_input.template" In this file you find the following part with commented lines where you have to set your user defined paths: 

#==============================
# set directories paths
#==============================

# BASIC INSTALLATION

#set(CARAT_ROOT "C:/carat")
#set(LIB_BOOST_INCLUDE_DIR "C:/carat/libs/boost_1_55_0")
#set(LIB_BOOST_DIR "C:/carat/libs/boost_1_55_0/boost")
#set(LIB_MKL_DIR "C:/Program Files (x86)/Intel/Composer XE 2011 SP1/mkl")

With the paths used in this installation guide the block should look like (don't forget to remove the #): 

#==============================
# set directories paths
#==============================

# BASIC INSTALLATION

set(CARAT_ROOT "~/software/carat")
set(LIB_BOOST_INCLUDE_DIR "C:/carat/libs/boost_1_63_0")
set(LIB_BOOST_DIR "C:/carat/libs/boost_1_63_0/boost")
set(LIB_MKL_DIR "C:/Program Files (x86)/IntelSWTools/compilers_and_libraries_2017/mkl")

Create the project with CMake

TODO

Set the following settings for a very basic installation: 

 BUILD_EXECUTABLE                 ON                                                                                                                                                                       
 BUILD_NX_PLUG_IN                 OFF                                                                                                                                                                      
 BUILD_RHINO_PLUG_IN_SDK4         OFF                                                                                                                                                                      
 BUILD_RHINO_PLUG_IN_SDK5         OFF                                                                                                                                                                      
 BUILD_SHARED_LIB                 OFF                                                                                                                                                                      
 BUILD_STATIC_LIB                 OFF                                                                                                                                                                      
 CFD_OPT                          OFF                                                                                                                                                                      
 CMAKE_BUILD_TYPE                                                                                                                                                                                   
 CMAKE_INSTALL_PREFIX             /usr/local                                                                                                                                                               
 ENABLE_CHOLMOD                   OFF                                                                                                                                                                      
 ENABLE_PREC_SOLVER_LIB           OFF                                                                                                                                                                      
 EXTENSIVE_BENCHMARKS             OFF                                                                                                                                                                      
 MODULE_DESIGN                    ON                                                                                                                                                                       
 MODULE_FORM_AND_CUT              ON                                                                                                                                                                       
 MODULE_GUI                       OFF                                                                                                                                                                      
 MODULE_OPTIMIZATION              ON                                                                                                                                                                       
 MODULE_REPORT                    ON                                                                                                                                                                       
 USE_32bit                        OFF                                                                                                                                                                      
 USE_BOOST_LOGGING                ON                                                                                                                                                                      
 USE_COSIMULATION                 OFF                                                                                                                                                                      
 USE_FLANN_64BIT                  OFF                                                                                                                                                                      
 USE_INTEL_COMP                   OFF                                                                                                                                                                      
 USE_MKL                          ON                                                                                                                                                                      
 USE_MPP                          OFF                                                                                                                                                                      
 USE_OPENCASCADE                  OFF                                                                                                                                                                      
 USE_OPENMP                       OFF                                                                                                                                                                      
 USE_TRILINOS                     OFF

Generate the project

Open the Carat++ project with Visual Studio 2015

TODO open the .sln in the build directory

Compile

Benchmarks

After each build or at least before a git commit the benchmarks have to be tested.

  1. RUN_TEST




Whos here now:   Members 0   Guests 0   Bots & Crawlers 1
 
Retrieved from "http://carat.st.bv.tum.de/caratuserswiki/index.php/Users:HowToUseCarat/InstallationWindows"
Personal tools
Content for Users
Content for Developers