Installation
Shade comes with both a Visual Studio 2005 solution as well as a makefile for use on Linux. As of this time there is no XCode project available for Mac OS X, but the included makefile will work for Mac users.
Before Shade can be compiled the following libraries must be installed.
- Boost (ver 1.34 for standalone applications, ver 1.35 for distributed applications)
- GLEW (ver 1.3 or later)
- DevIL (ver 1.6 or later)
- GLFW (ver 2.6 or later)
- An MPI 1.0 compliant implementation (for distributed applications)
Installing On Windows
Download each of the dependency libraries. Either compile the individual libraries, using their respective instructions, or get the Windows binary. Each library should have instructions on installing the library for Windows. The general rules though for where the files should be placed are as follows.
- Header Files (.h, .hpp) - (VC Root)/Include/
- Static Library (.lib) - (VC Root)/Lib
- Dynamicly Linked Library (.dll) - %SystemRoot%/system32
After all the libraries are installed open up the included Visual Studio Solution. Set the type of build and compile the Solution. Then verify that the included examples run properly.
Installing on Linux
Download each of the dependency libraries. Either compile the individual libraries, using their respective instructions, or get the binary for your distribution. Each library should have instructions on installing the library for linux. If you have permission to write to /usr/local the libraries should be able to put themselves in there for use. If that is not the case then just create a directory structure in your home directory mirroring that of usr/local and install the libraries manually. If you are having problems finding the .so files look for a hidden directory containing the library files, and copy the contents of the directory.
- Header Files (.h, .hpp) - /usr/local/Include/
- Shared Object (.so) - /usr/local/Lib
Next depending on where you put the libraries you may need to modify the makefiles. Within the OpenGL, SceneGraph, and Application the makelib.lnx file needs to be modified. Modify the INCPATH to include where you placed the header files for the libraries. Within the ExamplesCpp/makeapp.lnx modify the LIBPATH to include where you placed the shared object files for the libraries.
The makefile contains two flags that need to be set
- CONFIG=____ - To create a debug build set the flag as Debug, otherwise set the flag as Release. (You may want to add MPI to the end of an MPI enabled build)
- MPI=_____ - To create a distributed build of Shade set the flag to Enabled otherwise set the flag to Disabled (This assumes all the MPI libraries are installed)
Note
Typically an MPI enabled build of Shade should be compiled as a Release build. A Debug build of Shade with MPI will notify through the console what messages are being sent and what messages are being recieved. This will drastically slow down your application, but is good for tracking down bugs in an MPI application that works correctly when built as a stand alone application.As an example to create a release build of Shade without MPI the following command needs to be issued in Shade's root directory
make CONFIG=Release MPI=Disabled
Installing on Mac OS X
At this time no xcode files are available in the download. Follow the directions for the Linux Installation.