The ProteinShader program is currently distributed as a zip file. If a computer already has Java 1.5 or higher, and the graphics card supports at least OpenGL 2.0, installation should involve nothing more than decompressing the zip file.
To make it platform independent, the ProteinShader program is written primarily in Java, and has been tested on computers using the Linux, Macinosh OS X, and Windows XP operating systems. Java 1.5 or later is required. One way to test what version of Java is installed is to open a terminal window (Terminal on Macintosh OS X / Linux or Command Prompt on Windows XP) and type "java -version" on the command line.
On Macintosh OS X, Java 1.5 is probably already installed, or can be obtained by using the built-in Macintosh Software Update tool to automatically download and install it. For Windows XP and Linux, Java 1.5 can be obtained from the Sun Microsystems web site. The Sun web site often refers to Java 1.5 as Java 2 Standard Edition 5.0. Similarly, Java 1.6, which has been out for a while now, is often referred to as Java 2 Standard Edition 6.0. For developers who wish to modify and recompile the source code, the Java SE Development Kit (JDK) 5.0 or higher is needed. For end-users who only want to run the program, the Java Runtime Environment (JRE) 5.0 or higher is all that is needed.
When the ProteinShader program first starts up, it will check that the graphics card supports OpenGL 2.0. If an earlier version of OpenGL is found, a dialog box will open up to inform the user of the version number problem, and the program will exit. OpenGL 2.0 was finalized on October 22, 2004, and is supported by most good quality graphics cards produced since then.
OpenGL 2.0 or later is required because ProteinShader includes several small programs, known as vertex and fragment shaders, that are written using the OpenGL Shading Language. These shaders perform the custom lighting calculations and texture mapping that allow illustrative rendering effects such as pen-and-ink style drawings. Full support for OpenGL Shading Language became standardized as of OpenGL 2.0.
Assuming that Java 1.5 (or higher) and OpenGL 2.0 (or higher) are already available, installing the ProteinShader program requires nothing more than decompressing the ProteinShader-XX.zip file (where XX is a version number). On most operating systems, simply double-clicking on a zip file will call on a decompression tool. Depending on the decompression tool, it may be necessary to select something like "Extract All" from a menu. If for some reason a zip decompression program is not found, the Java jar tool can be used to decompress a zip file. Open a Terminal window on Macintosh OS X or Linux (Command Prompt on Windows XP), cd into the directory the zip file is in, and type "jar -xf ProteinShader-XX.zip" on the command line.
The location of the decompressed
ProteinShader-XXdirectory should not matter, but the internal directory structure should not be changed. The ProteinShader program is a runnable JAR file, ProteinShader.jar, located in the
binsubdirectory. The compiled Java code in ProteinShader.jar knows the relative location of most of the subdirectories of the
textures) because it needs to access those directories at run time. Also, inside the
bindirectory where ProteinShader.jar is found there are several dynamic libraries ('.so' files for Linux, '.jnilib' files for Macintosh OS X, and '.dll' files for Windows XP) that need to remain at that location.