Installation¶
This page describes how to set install DoGPack. If you encounter any difficulties in the installation process, send e-mail to the discussion group.
Dependencies¶
Git¶
The DoGPack code is distributed using the file revisioning system known as Git. Git can be download for free from http://git-scm.com.
C++¶
The DoGPack code is written in C++. You will need to obtain a C++ compiler. A free C++ compiler is available via the GNU project.
Python¶
All plotting in DoGPack is done via Python scripts using Matplotlib. In order to use these plotting scripts, one needs Python 3, numpy, scipy, and matplotlib.
Python can be freely obtained from http://www.python.org.
Numpy can be freely obtained from http://numpy.scipy.org.
Scipy can be freely obtained from: https://scipy.org/.
Matplotlib can be freely obtained from http://matplotlib.sourceforge.net.
Note
The DoGPack developers recommend the Anaconda Python Distribution to obtain Python/Numpy/SciPy/Matplotlib libraries installed “out-of-the-box”. The Anaconda Python Distribution is freely available.
Download¶
Once all the dependencies have been resolved, the latest version of the DoGPack package can be pulled from the git repository via the following command:
$ git clone https://bitbucket.org/imsejae/dogpack
Setting up the environment¶
The next step is to set the environment variables. The easiest way to do this is to use a script provided in the util subdirectory that produces the appropriate environment variables for DoGPack. To run the script, go into your base directory you created above and run
$ python util/setenv.py
This script should produce two files that contain the shell script for setting
the above variables. By default these files are called setenv.bash and
setenv.csh. These can be used by running
$ source setenv.bash
or
$ source setenv.csh
depending on your shell (this can be checked by typing printenv SHELL at
your command line). The shell code in these files can be copied to your
.bashrc, .cshrc, or .profile file to be run automatically when you open a
terminal.
Testing the installation¶
Once the installation is completed, the next step is to make sure that the installation and setup were successful. Do this by entering a particular example and compiling the code by typing:
$ cd $DOGPACK/apps/1d/shallow_water/dam_break
$ make
Once compiled, execute the code by typing:
$ dog.exe
