Difference between revisions of "orch:Installation Guide"

Revision as of 18:39, 29 June 2020

Retrieve ORCh with Git

The installation location should follow a given format. As the path to the orch folder must follow:

./workdir/orch$

The orch repository should be positioned in a workdir folder. So create the workdir folder in which you clone the orch repository from the gitlab:

/home/user/workdir$ git clone git@gitlab.coria-cfd.fr:orch/orch.git

Pre installation for Cantera 2.4

The 2.4 version of Cantera , downloaded with ORCh at workdir/orch/Cantera, needs :

• C++ Boost librairies (Version 1.68, the newer don't work with Cantera) to run properly.
• SCONS compiler

SCONS

https://sourceforge.net/projects/scons/files/scons/3.0.3/scons-3.0.3.tar.gz/download

cd scons-3.0.3
python setup.py install

BOOST LIBRARIES

https://www.boost.org/users/history/version_1_68_0.html

cd boost_1_68_0 
sh bootstrap.sh
./b2  install --libdir=yourPath/boost_1_68_0/lib   --includedir=<yourPath/boost_1_68_0/include

... patience ... the boost installation can be long

software used by Cantera 2.4

If you don't already have Cantera 2.4 on your computer, you will need to get several external softwares (fmt, Eigen, googletest and sundials), located in orch/Cantera/ext/ :

You can either download the ext.tar file and extract it in orch/Cantera/ext/ :

File:Ext.tar.gz

Or directly download each software (could take some time ..)

• fmt

$ git clone https://github.com/fmtlib/fmt.git
$ sudo mkdir /usr/local/include/fmt
$ sudo cp fmt/fmt/format.* /usr/local/include/fmt/

• Google test

get https://github.com/google/googletest/archive/release-1.8.0.tar.gz

tar xf release-1.8.0.tar.gz
cd googletest-release-1.8.0
cmake -DBUILD_SHARED_LIBS=ON .
make

then cp -r * ~/orch/Cantera/ext/googltest ...

• eigen

visit https://eigen.tuxfamily.org/index.php?title=Main_Page
Download the 3.2.10 tar
tar -xvf 3.2.10.tar
cp file into orch/Cantera/ext

• Sundials version 3.1

MPI librairies will be also needed for Stochastic configurations.

Installation procedure

Installation

The following steps must be completed before you can use ORCh:

• Compile Cantera :

In the directory workdir/orch/Cantera, modify the paths in the file "cantera.conf" with the appropriate one.
build with SCONS : "scons build"
If the build fail, for any reason, use "scons clean" before doing again the previous step.

• Add to your .bashrc file:

export BOOSTPATH="/yourPath/boost_1_68_0"

export GTCOMB_CT_HOME=/home/yourloggin/orch/Cantera
export GTCOMB_CT_HOSTTYPE=$GTCOMB_CT_HOME/lib
export GTCOMB_CT_DATA=$GTCOMB_CT_HOME/data

• All the openmpi and gcc-compiler libraries must be available on your machine, typically you need something like below in your .bashrc file (some may already be there no need to duplicate):

source /opt/intel/composerxe/bin/compilervars.sh intel64
export INTEL_HOME="/opt/intel/composerxe"
export INTEL_INC="$INTEL_HOME/include"
export INTEL_LIB="$INTEL_HOME/lib"
export INTEL_BIN="$INTEL_HOME/bin"
export INTEL_MAN="$INTEL_HOME/man"
export PATH="$INTEL_BIN:$PATH"
export LIBRARY_PATH="$INTEL_LIB:$LIBRARY_PATH"
export LD_LIBRARY_PATH="$INTEL_LIB:$LD_LIBRARY_PATH"
export MANPATH="$INTEL_MAN:$MANPATH"

export MPI_HOME="/local/openmpi/intel-14.0.2/1.8.1"
export MPI_INC="$MPI_HOME/include"
export MPI_LIB="$MPI_HOME/lib"
export MPI_BIN="$MPI_HOME/bin"
export MPI_MAN="$MPI_HOME/share/man"
export PATH="$MPI_BIN:$PATH"
export LIBRARY_PATH="$MPI_LIB:$LIBRARY_PATH"
export LD_LIBRARY_PATH="$MPI_LIB:$LD_LIBRARY_PATH"
export MANPATH="$MPI_MAN:$MANPATH"

export HDF5_HOME="/local/hdf5/intel-14.0.2/1.8.12"
export HDF5_INC="$HDF5_HOME/include"
export HDF5_BIN="$HDF5_HOME/bin"
export HDF5_LIB="$HDF5_HOME/lib"
export PATH="$HDF5_BIN:$PATH"
export LIBRARY_PATH="$HDF5_LIB:$LIBRARY_PATH"
export LD_LIBRARY_PATH="$HDF5_LIB:$LD_LIBRARY_PATH"

export PAPI_HOME="/local/papi/intel-14.0.2/5.3.0"
export LANG=C
export LC_ALL=C
export CPLUS_INCLUDE_PATH=$CPLUS_INCLUDE_PATH:/usr/include/x86_64-linux-gnu/c++/4.8

• Check that the compilation of the ORCh package runs fine by testing one of the several test cases in orch/Tests/

 make clean 
 make 
 ./mainProgram