Difference between revisions of "Installation"
Miguel Caro (talk | contribs) (Created page with "''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 canno...") |
Miguel Caro (talk | contribs) |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 3: | Line 3: | ||
=== Prerequisites === | === 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 [http://www.netlib.org/fftpack/ FFTPACK] and [http://math.lbl.gov/voro++/ Voro++], respectively. For the user's convenience these packages are shipped with every DoSPT distribution and compiled/built as part a regular DoSPT installation (so you don't have to worry about installing these packages separately). | + | 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 [http://www.netlib.org/fftpack/ FFTPACK] and [http://math.lbl.gov/voro++/ 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 and untar the code === | ||
| Line 11: | Line 11: | ||
mkdir -p $HOME/dospt/ | mkdir -p $HOME/dospt/ | ||
cd $HOME/dospt/ | cd $HOME/dospt/ | ||
| − | wget <nowiki>http://dospt.org/downloads/DoSPT-0. | + | wget <nowiki>http://dospt.org/downloads/DoSPT-0.2.2.tar.gz</nowiki> |
| − | tar -xvf DoSPT-0. | + | tar -xvf DoSPT-0.2.2.tar.gz |
You can now remove the tar file: | You can now remove the tar file: | ||
| − | rm DoSPT-0. | + | rm DoSPT-0.2.2.tar.gz |
=== Build the code === | === Build the code === | ||
| Line 22: | Line 22: | ||
To compile everything and build the DoSPT executable simply cd into the directory where the untarred files are located and execute "build.sh": | 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. | + | cd $HOME/dospt/DoSPT-0.2.2 |
./build.sh | ./build.sh | ||
| Line 31: | Line 31: | ||
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: | 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. | + | echo "PATH=\$HOME/dospt/DoSPT-0.2.2/bin:\$PATH" >> ~/.bashrc |
source ~/.bashrc | source ~/.bashrc | ||
After this, you can execute DoSPT just by typing "DoSPT" in a terminal. | After this, you can execute DoSPT just by typing "DoSPT" in a terminal. | ||
Latest revision as of 09:25, 17 February 2020
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.
Contents
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.2.2.tar.gz tar -xvf DoSPT-0.2.2.tar.gz
You can now remove the tar file:
rm DoSPT-0.2.2.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.2.2 ./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.2.2/bin:\$PATH" >> ~/.bashrc source ~/.bashrc
After this, you can execute DoSPT just by typing "DoSPT" in a terminal.
