Windows Install

= How to compile Kratos: Windows =

In this section we are going to go through the process of compiling a basic version of Kratos Multiphysics under Windows environments. Specifically, we explain how to compile Kratos in:

• Windows 7
• Windows 10

We do not recommend, but is also valid for:

• Windows 8
• Windows 8.1

A basic knowledge of Windows is assumed ( execute commands in cmd, create directories, etc...)

'''If you are not familiar with the following concepts listed below, please take five minutes read the windows basic section''' (TODO).

'''Tested and working configurations:'''

-Visual Studio 2015 Community with Python 3.4 and Boost 1.59.

== Visual Studio ==

Visual studio is the only compiler officially supported to build Kratos under Windows. Since the adoption of C++11 we support versions 2015 onwards. The complete list of known working versions is presented here (other variants like 'Professional ' also work):

• [https://imagine.microsoft.com/en-us/Catalog/Product/101 '''VisualStudio 2015 Community''']

Please notice that:

• If you want OpenMP support you must download a '''Community''' or '''Professional''' variant. '''Express variant do not have support for OpenMP'''

• Since Visual Studio is a multi-language IDE, some distributions come without C++ compiler. Please, make sure that you can create a C++ project before continue, in case C++ packages were missing you will be prompt to download them.

• '''Avoid installing the Update 3 of Visual Studio 2015 Community''', it cannot compile Kratos. '''You must use Update 2''' If you have already updated it, you should uninstall Visual Studio and reinstall it without the updates. Uninstalling just the update through Control Panel (through the Updates manager) does not work.

• When installing VisualStudio 2015 Community, it is advisable to '''download the ISO file''' (vs2015.com_enu.iso) instead of the web installer (vs_community.exe) so as to prevent update 3 from being installed.

Note that using update 1 is also posible but not recommended since due tu a bug with #pragma atomic you will have to replace some parts of the code or the compiler will crash.

== Git ==

• Objectives: ** Install git ** Get Kratos Multiphysics source code

The first thing you will need is the Kratos Multiphysics source code. To download the code you will have to use a git manager. You can install a git manager from the link below. There are may other git clients that you can use.

• [https://www.sourcetreeapp.com/ Git Client]

Once a git client is installed you can clone the code from this url:

https://github.com/KratosMultiphysics/Kratos

Once this is done, you should have a "Kratos" directory containing Kratos soruces

== CMake ==

• Objectives: ** Install CMake

Cmake is the tool used to compile kratos. You can obtain it from its official webpage.

• [http://cmake.org/download/ CMake]

Once installing, please do not forget to mark the option: '''"Add CMake to the system PATH for all users"'''

Please notice that if you want to use python 3.4 or higher, you will need CMake 3.0.2 or higher.

== Python ==

• Objectives: ** Install Python3

You will need any version of python in your computer in order to compile Kratos. We strongly recommend Python 3, at least 3.3.4 or higher. you can download python from its official webpage:

• [http://www.python.org/downloads/ Python]

Please, take special care to download a installer that suits your desired architecture x86 for 32 bits compilations and x86_64 for 64 bits compilations. Otherwise it won't work.

== BLAS and LAPACK ==

• Objectives: ** Get LIBBLAS and LIBLAPACK

Blas and Lapack are needed for many solvers, specially those present in the ExternalSolvers Application, that you will likely need to compile. You can get these libraries from:

'''For 32 bits''' http://icl.cs.utk.edu/lapack-for-windows/lapack/

Under the section: '''"Prebuilt libraries for Microsoft Visual Studio Projects"'''. Please download both dll and lib files for your architecture.

'''For 64 bits''' http://web.cimne.upc.edu/users/maceli/data/libs.7z

Please notice that temporally we recommend to use an older version of the libs for 64 bits.

Additionally, you will need some extra dependencies for these libs. The easiest way to fulfil them is to install a proper version of MinGW in your system (32 or 64). Any distribution should work, you can find one here:

http://sourceforge.net/projects/mingw-w64/

'''Warning:''' After launching the installer, several options must be selected. Choose version 6.4.0. Please take special care to select the correct architecture during this installation (32 bits is called 'x86', 64 bits is called 'x64').

== Boost ==

• Objectives: ** Compile boost libraries

The next step will consist in compile Boost. Kratos Multiphysics needs Boost libraries to support some of its functions. You can use any version from '''version 1.54''' onward, please note that '''versions 1.60, 1.63 and 1.64 are not supported''' due to a bug with python wrappers. It's very important to add the correct path to the boost library in the configure.bat, see more below. You can download boost from its official website:

• [http://www.boost.org/users/download/ Boost]

'''Warning:''' choose the version of boost that fits your version of Visual Studio (no all of them are the same!) For Visual studio 2015: msvc-14.0, for Visual studio 2013: msvc-12.0, Visual studio 2012: msvc-11.0, Visual studio 2010: msvc-10.0.

Extract boost, navigate to the directory and execute this command:

bootstrap

Some additional files will be generated.

By default, boost will try to link with python 2.7. '''It is important to manually specify that we want to use python 3 by adding your downloaded python version. For example, if you have python 3.3.4 you should add “using python : 3.3 : /usr ;”''' to the file project-config.jam:

'''For 32 bits:''' using python : 3.3 : C:\Python33\python ;

'''For 64 bits:''' using python : 3.3 : C:\Python33\python : : : 64 ;

After modifying it you will have to compile the required boost libraries using the command below. Notice that this will only compile “serialization” and “python” libraries. If you need further libraries, you will need to explicitly tell boost to compile them.

You will need to know which version of MSVC you are using. This version depends on the visual studio that you install in your system. In the list below you will find the correct version of MSVC for every version of visual studio and its usage in the command ( in red ):

Visual studio 2015: --toolset=msvc-14.0

'''For 32 bits:''' b2 --toolset=msvc-14.0 --build-type=complete architecture=x86 stage --with-python --with-serialization variant=release link=shared,static

'''For 64 bits:''' b2 --toolset=msvc-14.0 --build-type=complete architecture=x86 address-model=64 stage --with-python --with-serialization variant=release link=shared,static

If you intend to debug please remove the '''variant=release''' option.

'''Ej: For Debug (x64)''' b2 --toolset=msvc-14.0 --build-type=complete architecture=x86 address-model=64 stage --with-python --with-serialization link=shared,static

'''Warning:''' If you use boost 1.65 or greater and python3 please add this line to your configure:

-DBOOST_PYTHON_SUFFIX="3" ^

== Compiling Kratos ==

=== Customize configure.bat ===

• Objectives: ** Prepare Kratos configuration file

In the Kratos root folder ("'''C:\kratos\cmake_build'''") copy the '''example_configure.bat.do_not_touch''' to '''configure.bat'''. This file controls where Kratos is going to search for the libraries, which applications are going to be installed and how the visual studio solution is going to be generated, among other things.

==== Set the Generator ====

The first thing you need to do is to tell CMake that you intend to build a VisualStudio project. This is done automatically by CMake, but is highly recommended to add it yourself. To do it add "-G" option followed by your target. For example, if you are using VisualStudio 2015:

'''For 32 bits:''' cmake -G "Visual Studio 14 2015" ^

'''For 64 bits:''' cmake -G "Visual Studio 14 2015 Win64" ^

You can find more info and a list of available generators here:

https://cmake.org/cmake/help/v3.5/manual/cmake-generators.7.html

'''Warning:''' If you already configured for 32 bits and compiled, '''remove''' all the files in the folder cmake_build except the .bat file used for configuration. Not removing them can lead to strange errors during compilation.

==== Set Libraries ====

Once the generator is correctly set, you have to make sure that the paths to all libraries are correctly set. Please make sure that you configure.bat file has the following lines with the correct path:

-DBOOST_ROOT="example/boost_1_59_0/" ^ -DBLAS_LIBRARIES="example/libblas.lib" ^ -DLAPACK_LIBRARIES="example/liblapack.lib" ^

It is possible that if you have multiple python versions in your system CMake detects the wrong one ( typically, the one with the highest version ) to avoid that, please set it manually. For instance, for Python 3.3:

-DPYTHON_INCLUDE_PATH="C:\Python33\include" -DPYTHON_LIBRARY="C:\Python33\libs\python33.lib"

==== Enable/Disable Setting ====

Now, you can enable and disable the applications you may want to compile or not. For instance:

-DSTRUCTURAL_APPLICATION=ON/OFF ^

We recommend you to enable:

-DINSTALL_EMBEDDED_PYTHON=ON ^

==== Example ====

Here we present a full example using these assumptions:

• You want a x64 build

• You use VisualStudio 2015

• You have boost in "C:\boost_1_59_0"

• You have blas and lapack in "C:\external_libraries"

• You have Python33 in "C:\Python33"

• You downloaded Kratos in "C:\Kratos"

  del CMakeCache.txt

  cmake -G "Visual Studio 14 2015 Win64" ^ -DCMAKE_BUILD_TYPE=Release ^ -DCMAKE_CXX_FLAGS=" -D_SCL_SECURE_NO_WARNINGS " ^ -DBOOST_ROOT="C:\boost_1_59_0" ^ -DPYTHON_LIBRARY="C:\Python33\libs\python33.lib" ^ -DPYTHON_INCLUDE_PATH="C:\Python33\include" ^ -DLAPACK_LIBRARIES="C:\external_libraries\liblapack.lib" ^ -DBLAS_LIBRARIES="C:\external_libraries\libblas.lib" ^ -DMESHING_APPLICATION=ON ^ -DEXTERNAL_SOLVERS_APPLICATION=ON ^ -DPFEM_APPLICATION=ON ^ -DSTRUCTURAL_APPLICATION=ON ^ -DCONVECTION_DIFFUSION_APPLICATION=ON ^ -DFLUID_DYNAMICS_APPLICATION=ON ^ -DALE_APPLICATION=ON ^ -DFSI_APPLICATION=ON ^ -DDEM_APPLICATION=OFF ^ -DSWIMMING_DEM_APPLICATION=OFF ^ -DINSTALL_PYTHON_FILES=ON ^ -DINSTALL_EMBEDDED_PYTHON=ON ^ -DEXCLUDE_ITSOL=ON ^ -DSOLID_MECHANICS_APPLICATION=ON ^ ..

'''Warning:''' All these options must be written in the same line, the symbol '^' tells the cmake to read the following line as if it was the same. If you add new options, like the ones in red, do not forget to put this symbol at the end of every line and do not write spaces after this symbol.

=== Running configure.bat ===

• Objectives: ** Configure Kratos

Once the modifications of the file are done, it needs to be executed. You can do that by executing the command:

configure

In a cmd. Please check the output to ensure that all the paths and libraries are the correct ones. If the configuration has been successful you will se a '''Configuration Done''' near the end.

=== Compiling Kratos ===

• Objectives: ** Compile and Install Kratos

Once the configuration script has finished without errors a '''"KratosMultiphysics.sln"''' will be generated in the cmake_build directory. Double click this file and the visual studio project will open. Please, make sure that the project is set to "Release" and "Win32" or "x64" and change it if is not. Finally, in order to compile Kratos, right click the "INSTALL" project and select the option "BUILD"

== Post Compilation ==

• Objectives: ** Finish last details ** Copying necessary files

Once the compilation process has finished, you will find are your files in the selected installation directory. You should see a directory "libs" inside. To finish the process, please copy the following files to the "libs" directory:

• libblas.dll
• liblapack.dll

Also, please copy all .dll files located in your boost directory, for example:

• C:\boost_1_59_0\stage\lib

Finally, copy all the .dll located in your MinGW binary dir. For example:

• C:\MinGW\bin

= Test and Usage =

• Objectives: ** Test that Kratos Works ** Get familiar with the execution process

Once Kratos is compiled and correctly install all its left is to execute some cases. In this section we will descrive how you can make a simple example to test that kratos works, and the general way to run problems: directly from the command line or using GiD.

== Test the compilation ==

To to test the compilation, you can prepare a simple script (for example "test_kratos.py") that contains this line:

from KratosMultiphysics import *

Then you can execute this script as explained in the next section.

== Executing an script from the command line ==

The most easy way to execute a KratosMultiphysics script from the command line is to prepare a ".bat" file. A ".bat" file is just a series of commands that are executed together and will make the process simpler. This file should contain only two lines. First the path for the kratos executable and libs folders, and the second, the actual command. For instace:

• Your Downloaded Kratos in "C:\Kratos"

• Your script is called "test_kratos.py"

  set PATH=C:\Kratos;C:\Kratos\libs;%PATH% "C:\Kratos\runkratos" test_kratos.py

We strongly recommend you to run kratos scripts with the "runkratos" binary inside your Kratos installation folder, because it gives the correct values to the environment variables.

runkratos test.py Or more exactly, you can go to the folder where your case is (input files and main python script) and type: path_to_kratos/runkratos test.py

You can also run them directly using the python you have installed in your system (provided that the system knows where python is and the environment variables have the correct values assigned, PYTHONPATH, LD_LIBRARY_PATH and PATH).

python test.py python3 test.py python35 test.py

If everything is correct you will see this message:

| / |
' / | ` | __| _ \ _| . \ | ( | | ( |_ \ |__| _,|__|_/ ____/ Multi-Physics 3.3.XXXXX

== Using Kratos With GiD ==

TODO

= Common problems =

== warning C4273: 'round' : inconsistent dll linkage ==

You have a conflicting declaration of round. This could happen for example if you have multiple versions of Visual Studio in your computer. Please add "-DHAVE_ROUND" to the configure cxxflags entry:

-DCMAKE_CXX_FLAGS=" -D_SCL_SECURE_NO_WARNINGS -DHAVE_ROUND"