Installation

From DoSPT
Jump to: navigation, search

Note: All installation instructions apply to Linux environments only. Support is not currently provided nor planned for any other platform. This doesn't mean you cannot run DoSPT on another operating system. If you manage to install and successfully run DoSPT on Windows, Mac or anything else, you can contact the development team to make your instructions available on this website.

Prerequisites

To install DoSPT, first make sure you have access to both a Fortran compiler and a C++ compiler. We recommend gfortran and g++, which are free and have been tested to work reliably with DoSPT. DoSPT also relies on Fast Fourier Transform and Voronoi tessellation functionality provided by FFTPACK and Voro++, respectively. For the user's convenience these packages are shipped with every DoSPT distribution and compiled/built as part of a regular DoSPT installation (so you don't have to worry about installing these packages separately).

Download and untar the code

Download the most recent version of the code (which might not be the one in the example below!) into a directory of your choice and untar it. In this page we will assume the user wants to install DoSPT in a directory called "dospt" under their home directory:

mkdir -p $HOME/dospt/
cd $HOME/dospt/
wget http://dospt.org/downloads/DoSPT-0.1.tar.gz
tar -xvf DoSPT-0.1.tar.gz

You can now remove the tar file:

rm DoSPT-0.1.tar.gz

Build the code

To compile everything and build the DoSPT executable simply cd into the directory where the untarred files are located and execute "build.sh":

cd $HOME/dospt/DoSPT-0.1
./build.sh

This will by default compile dfftpack, Voro++ and DoSPT, and build the DoSPT executable under the "bin/" directory. You can edit "build.sh" to change default options, such as compiler flags or target directories.

Add the installation directory to your path

To be able to use DoSPT system-wide, you'll need to add the "bin/" directory to you path, or create a symbolic link which will point to the installation directory and will be located in another directory which is already in your path. The most simple solution is probably to just do:

echo "PATH=\$HOME/dospt/DoSPT-0.1/bin:\$PATH" >> ~/.bashrc
source ~/.bashrc

After this, you can execute DoSPT just by typing "DoSPT" in a terminal.