Home

#Geospace/Heliosphere Observation & Simulation Tool-kit (GHOSTkit)

GHOSTkit is a ParaView plugin library that provides data analysis and visualization tools for the Heliophysics community. This Wiki will provide the basic information needed to configure and build the toolkit to work with the official ParaView binary releases. Information will also be posted here on how to configure the development environment so that you can contribute to the project.

---

Getting the Code

If you have developer access to the repository, the best way to checkout out the code is with your SSH key. Simply use git to clone the repository as follows

git clone git@github.com:/ghost-kit/GHOST.git

This will clone the project to your local machine. If you DO NOT have a developer account on GHOSTkit, you can check out the code as follows:

git clone https://github.com/ghost-kit/GHOST.git

Retrieving the code in this manner will NOT allow you to push changes to the repository, but will allow you to fully compile the library.

Compiling the Code

Compiling on Yellowstone (Geyser)

The following steps are necessary to successfully compile the plugin on Yellowstone. After you clone the project: (These instructions assume BASH shell. If using another shell, modify environment declaration as needed)

# Modules needed
module load cmake/3.0.2
module load python/2.7.7
modlue load all-python-libs
module load gnu/4.6.4 -or- swap {current compiler} gnu/4.6.4
module unload ncarcompilers ncarbinlibs netcdf ncarenv

# Environment Variables needed
export CC=/glade/apps/opt/gnu/4.6.4/bin/gcc
export CXX=/glade/apps/opt/gnu/4.6.4/bin/g++
export FC=/glade/apps/opt/gnu/4.6.4/bin/gfortran

# For some reason, we don't always get the correct binaries if we don't specify the build in the path
export PATH={BUILD_DIRECOTRY}/install/bin:$PATH

# Configure and Build
mkdir build
cd build
cmake ../GHOST -DNUM_CORES={number of cores} -DENABLE_ghost=true -Dqt_DISABLE_WEBKIT=true  -DCMAKE_BUILD_TYPE=release
gmake 

If your number of cores is greater than the number of cores you requested in you GEYSER session, the build will fail with some very strange POE errors, so don't over-extend the number of build-threads!