Ribbons Source Code
Installation
A basic familiarity with UNIX and system administration is assumed.
Everything has been set up for the C-shell.
It is assumed you have all the source code directories, either from
over the net or from tape.
Compilation
The program is shipped in executable-only form.
If you have signed a license and paid the small fee for ``full support'',
you can get the source code.
(See Ribbons License .)
You must first set the 'CCC' environment variable for the C++ compiler,
depending on the type of machine.
setenv CCC CC (for SGI UNIX)
setenv CCC cxx (for DEC UNIX)
If you have a DEC machine: You must go to the ~/src directory,
and move the file 'Makefile.dec' to 'Makefile'. Some SGI-specific
graphics won't be available, in particular the data preparation GUI
made with SGI's `rapidapp' toolkit.
For a complete recompilation,
scripts exist to clean up, to compile everything, and finally
to move the executables to where they belong.
These steps must be done in the ``$RIBBONS_HOME/install'' directory:
Make.clobber
Make.compile
Make.install
``Make.clobber'' may complain if a file to be removed is not there.
This script should take a matter of seconds. It may complain if
no files are found --- ignore these messages.
``Make.compile'' takes several minutes, depending on the machine.
There should be no warning messages.
``Make.install'' takes only a few seconds.
Now fresh, locally compiled versions should exist in
the ``$RIBBONS_HOME/bin'' directory.
Make.clean
``Make.clean'' may be run to remove all *.o object files
to free up disk space. This takes only a few seconds.
Program organization
The default distribution consists of the main ``$RIBBONS_HOME''
directory and the following subdirectories:
- analysis
Structure analysis tools.
- bin
Executable versions of the programs (some are simply
shell scripts; most are links to executable commands).
- data
Assorted example data.
All files referred to in the manual are found here.
- gallery
Artistic images (optional) in *.rgb format.
- help
The hypertext help screens and *.gif images.
- images
Artistic images (optional) in *.gif format.
- misc
Assorted trivia.
- rgb
Sample images (optional) in *.rgb format from example data.
The source code distribution consists of Makefiles, C++ ( *.C )
source code (and some FORTRAN), and *.h include files
in the following subdirectories:
- analysrc
Source code for structure analysis tools.
- facets
Density map surface faceting programs.
- fithx
Helix fitting program suite source code.
- gutils
Assorted graphics utilities
- install
The Make.* shell scripts to install and compile all programs.
- ms
Molecular surface source code (old version).
- msp
Molecular Surface Package conversion utilities.
- nutils
Newer utilities that use OOP library.
- oop
First-pass OOP code for the 'ribbons++' project
- ps
PostScript utilities source code.
- src
Main ribbons graphics program.
- utils
Most data preparation utility programs and libraries for ribbons .
Changing things
If you have a source code license, dig right in.
I'd be happy to advise and might even help.
Theory
See references.
Disclaimer
If architects built buildings the way programmers write programs,
the first woodpecker that came along would destroy civilization.
UNIX fortune
Ribbons User Manual / UAB-CMC / carson@cmc.uab.edu