Users:HowToUseCarat/InstallationWindows

Revision as of 07:29, 3 March 2017 (view source) Arming (Talk | contribs) (→User Settings) ← Older edit		Revision as of 07:39, 3 March 2017 (view source) Arming (Talk | contribs) (→Create the project with CMake) Newer edit →
Line 119:		Line 119:
	=== Create the project with CMake===		=== Create the project with CMake===
−	TODO	+	TODO add pictures (already created)
−	Set the following settings for a very basic installation:	+	# Open CMake
−		+	# Set the carat source path: "C:/carat/src"
−	<pre>	+	# Set the carat build directory: "C:/carat/build" (create this folder if it does not exist)
−	BUILD_EXECUTABLE                ON	+	# Click "Configure"
−	BUILD_NX_PLUG_IN                OFF	+	# Select Visual Studio 2015
−	BUILD_RHINO_PLUG_IN_SDK4        OFF	+	# Check the desired Flags (for the basic setup you can use the default values as you see in the sreenshot below)
−	BUILD_RHINO_PLUG_IN_SDK5        OFF	+	# Click "Generate
−	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	+
−	</pre>	+
−		+
−	Generate the project	+
	=== Open the Carat++ project with Visual Studio 2015 ===		=== Open the Carat++ project with Visual Studio 2015 ===

---

Revision as of 07:39, 3 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 1 Windows Version 2 IDE 3 Git 4 Get the source code 5 Create directory for build and libraries 6 CMake 7 Boost 8 MKL 9 Compile Carat 9.1 User Settings 9.2 Create the project with CMake 9.3 Open the Carat++ project with Visual Studio 2015 9.4 Compile 10 Benchmarks

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 the "cmake_personal_input.dat" file you find the following part with commented lines where you have to set your user defined paths:

#==============================
# set directory 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/windows/mkl")

Make sure to use a "/" as a separator in the paths.

Create the project with CMake

TODO add pictures (already created)

1. Open CMake
2. Set the carat source path: "C:/carat/src"
3. Set the carat build directory: "C:/carat/build" (create this folder if it does not exist)
4. Click "Configure"
5. Select Visual Studio 2015
6. Check the desired Flags (for the basic setup you can use the default values as you see in the sreenshot below)
7. Click "Generate

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