Precompiled packages

ATM there are no precompiled packages for no Linux distribution available. Means you need to compile XC yourself. This is quite straight forward with the documentation provided.

Patience

Please have patience. It takes some time and you may encounter some problems. If you have any problem at installation process, feel free to add an issue at https://github.com/xcfem/xc/issues

Introduction

Installations steps

Make sure you have at least 6 GB of RAM (you'll need that to compile the sources).
install all needed depencies to be able to compile XC
make sure Python 3 is the default Python interpreter in your system.
get the source code
compile the source code
install the programm
verify the installation by running some verification tests

Scripts

Compiling XC is straight forward. We provide scripts which automate the tasks above. If you are familar with git, cmake and make, you can skip any further description in this file and directly head over to the scripts. They should do the job for you without any hasle. You will find further instructions in https://github.com/xcfem/xc/blob/master/install/install.scripts.linux.md

Detailed description

Install dependencies

You will need to install all packages needed for your distribution. The package installation scripts does install them for various Linux distributions. Your can run the script or copy the contents in a Linux shell.

Just do what ever fits best for you.

You can take a look to the program dependencies https://github.com/xcfem/xc/blob/master/install/dependencies_list.md "here".

Python 3

Make sure Python 3 is the default Python interpreter for your system. If your using a Debian like distribution you can set Python 3 as the default interpreter as follows:

sudo apt install python-is-python3

Get the source code

First make a directroy in your home directroy and go inside. Following the commands for all needed steps. foo is common used term. You normally see your username and the name of the computer you sit at. After this you will see the directory your are in. Check this before you copy a command. If you would like to copy more than one line at once you may open the XC install script xc_code_install.sh and copy the commands from there.

foo@bar:/somewhere$
foo@bar:/somewhere$  cd ~
foo@bar:~$
foo@bar:~$  mkdir build_xc
foo@bar:~$  cd build_xc
foo@bar:~/build_xc$

It is time to get the source code now. Git will clone the source code of xc in the current directory

foo@bar:~/build_xc$ git clone https://github.com/xcfem/xc/ xc

Build and install XC

Building and installing XC works the same way as any other program that uses cmake:

foo@bar:~/build_xc$
foo@bar:~/build_xc$  mkdir build-xc
foo@bar:~/build_xc$  cd build-xc
foo@bar:~/build_xc/build-xc$
foo@bar:~/build_xc/build-xc$  cmake ../xc/src
foo@bar:~/build_xc/build-xc$  make -j 4  # Assuming you have enough RAM. See comments below. 
foo@bar:~/build_xc/build-xc$  sudo make install
foo@bar:~/build_xc/build-xc$  cd ../..
foo@bar:~/build_xc$

Compile using multiple processors (make -j n)

If you don't have more than 6 GB of RAM use one processor only: type make or make -j 1.
If you have more than 16 GB of RAM and 4 processors or more you can use: make -j 4
If you have 32 GB or more you can try using 10 processors or more at the same time.

XC needs to install some Python modules:

foo@bar:~/build_xc$
foo@bar:~/build_xc$  cd xc/python_modules
foo@bar:~/build_xc/xc/python_modules$
foo@bar:~/build_xc/xc/python_modules$  sudo sh local_install.sh
foo@bar:~/build_xc/xc/python_modules$  cd ../..
foo@bar:~/build_xc$

If you had no error message XC should be installed on your machine now. It is time ot test if everything works as aspected.

Run verification tests

xc

foo@bar:~/build_xc$
foo@bar:~/build_xc$  cd xc/verif
foo@bar:~/build_xc/xc/verif$
foo@bar:~/build_xc/xc/verif$  sh run_verif.sh
foo@bar:~/build_xc/xc/verif$  cd ../..
foo@bar:~/build_xc$