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.

MATLAB

The DoGPack distribution includes several MATLAB scripts that can be used to visualize the results. If you wish to run these scripts you will need a valid MATLAB license.

Warning

MATLAB is not an open-source software package. For open-source plotting in DoGPack see Python.

Python

Alongside the MATLAB plotting scripts, the DoGPack distribution also includes Python plotting scripts that invoke matplotlib. This provides an open-source alternative to MATLAB. In addition to basic Python, the plotting routines need numpy and matplotlib.

Note

The DoGPack developers recommend the Enthought Python Distribution to obtain a modern Python with several important scientific computing libraries installed “out-of-the-box”. The Enthought Python Distribution is freely available for academic use.

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.

Warning

If using MATLAB for plotting, you may need to manually set the path in MATLAB using the MATLAB command window. The correct path is shown in the setenv.bash and setenv.csh files.

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

Table Of Contents

Previous topic

Overview

Next topic

Tutorial (1d example)

This Page