How to reach us

Development

Purpose: Here, it will be explained how to set those environment variables which are needed for running examples presented in the tutorials. Furthermore, some general information is given about the scripts that are used in exciting tutorials.

0. Did you already download exciting?

Copy the file containing the current release of exciting in the directory where you would like to have it. Here, we assume that the source code of exciting is unpacked inside /home/tutorials. If you choose a different location, replace /home/tutorials consistently throughout this tutorial with an appropriate path (from now on the symbol $ will indicate the shell prompt).

$ mkdir /home/tutorials
$ cd /home/tutorials

Copy the file containing the current release of exciting in /home/tutorials and unpack it using the command

$ tar xvf exciting.carbon.tar.gz

By executing this command, a subdirectory called exciting is created. This directory contains all files which make up the exciting software package. Now, you are ready for setting environment variables.

Furthermore, one can define the following optional environment variable

EXCITINGRUNDIR = Scratch directory used for running calculation by some exciting scripts. Example of definition: /home/tmpdir . If this variable is not defined, a running directory called xc-rundir will be created inside the directory where the scripts are executed.

TIMEFORMAT = Output format for writing on the screen the running elapsed time, used in some script.

The setting of these variables can be done in a bash shell. In order to do this, edit the ~/.bashrc file in your $HOME directory (or create the file if it does not exist yet). Then, append the following lines to the ~/.bashrc file.

Please note again: Explicit paths given above (such as /home/tutorials/exciting and /home/tmpdir) are only valid as examples which can be changed by the user to the appropriate ones. In order to activate changes, any time you modify the ~/.bashrc file, you have to start a new shell or source ~/.bashrc.

$ source ~/.bashrc

If you have already used previous versions ofexciting: You have probably some environmental variables defined inside your ~/.bashrc file. In this case, you must delete the old definitions before setting the new ones. In order to apply correctly the new settings you have to log out your account and enter it again.

Remark on the species files directory inexciting: It is not possible to define the directory containing the species files by linking directly to the exciting-code site.

2. Tutorial scripts

All the scripts used in the exciting tutorials can be found in the directory $EXCITINGROOT/tools.