%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%     To install Raster3D       %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

The installation process for Raster3D uses a single set of Makefiles 
shared by all platforms.
User configurable options are contained in two files:
   	Makefile.template	select or deselect TIFF support, etc

1) Make sure the development version of any necessary support libraries are
   installed.  This primarily means libgd, which is used to produce png and jpeg
   files. If you want to build in support for direct tiff output then you also
   need libtiff.

2) inspect Makefile.template to make sure that it is appropriate for your site,
   and possibly edit the file to enable or disable the following options:

	-jpeg	enabled by default (JPEG output)
	-png	enabled by default (PNG output)
   	-tiff	enabled by default (TIFF output)
	-sgi	disabled by default (SGI libimage output)
	GUNZIP	enabled by default (auto-decompression of input files)

3) Configure the Makefiles for your operating system.
	make help	gives a list of supported OS options
	make OS		(OS is your operating system name) configures things

4) Build the programs
	make all

5) Install the package
	make install

6) Add R3D_LIB to your system-wide initialization of environmental
   variables, or instruct users to insert one of the following into their
   login shell initialization. If you change the installation location
   to something other than /usr/local/share/Raster3D then you need to
   modify the examples below accordingly:

	csh/tcsh:	setenv R3D_LIB /usr/local/share/Raster3D/materials

	sh/ksh/bash:	R3D_LIB=/usr/local/share/Raster3D/materials
			export R3D_LIB

   These commands are provided in files Raster3D.csh and Raster3D.sh
   Depending on your system configuration, it may be sufficient to simply
   copy these two files into directory /etc/profile.d

7) [Optional] You may want to teach ImageMagick how to use the Raster3D
   rendering program as a delegate.  You can do this by adding lines at
   the end of the ImageMagick configuration file.  It probably has a
   name similar to this:
	/usr/lib64/ImageMagick-6.5.0/config/delegates.xml

# Versions 5.x and 6.x of ImageMagick uses XML for the delegate file
# Use Raster3D rendering program as a delegate for files ending in .r3d
   <delegate decode="r3d" command='"render" < "%i" > "%o"' />


8) Go to the examples subdirectory and try running the example scripts
   to verify installation.

A sample installation on a DEC Alpha might go:
	vi Makefile.template           # check options and installation directories
	make linux                     # configure
	make all                       # build the programs
	make install                   # install them
	cd examples                    # run the demo/verification scripts
	./example1.script
	./example2.script
	./example3.script
	... and so on ...

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%       Known Problems          %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

=== OSX ===

I don't know how to make a self-installing package, so I provide a
tarball that contains the source and executables.  It also contains
a shared library for libgd, which seems not easily found for OSX.

Basically you need to
 - copy the executables from ./bin to somewhere in your normal $PATH 
 - copy ./lib/libgd.2.dylib to somewhere in your normal $DYLD_LIBRARY_PATH
 - similarly copy or link in place to the html documentation 
 - set the environmental variable $R3D_LIB to point to the 
   ./materials directory


=== OS/2 (old advice, but maybe still relevant) ===

Uwe Baumert reports the following:

>> I'm pleased to say that I was also able to compile your Raster3D package
>> under OS/2 (Linux will follow). I used f2c 19970211. I had to modify some
>> code (I got wrong iocontrols etc.).  
[EAM - He means the CARRIAGECONTROL option in the normal3d.f OPEN statements;
just delete these two lines from the source code].
>> I compiled against the libtiff-library (version 4.2). I used the one that
>> was included in the NETPBM-Port of Peter Meerwald (pmeerw@cosy.sbg.ac.at)
>> and is available from
>>    ftp://ftp.leo.org/pub/comp/os/os2/leo/graphics/netpbm*.zip. 


=== Windows (old advice, but maybe still relevant) ===

Suhaib Siddiqi has kindly provided a pre-built set of Raster3D executables
for version 2.6c, which is available from the Raster3D web site.

If you want to build Raster3D from source under Windows, I can't help you.
But here is a recipe that Suhaib provided earlier for builing with the
cygwin environment. (I gather that he used a different procedure 
altogether when building 2.6c but I do not know any details).

>>  I have successfully compiled Raster3D 2.4g on Windows NT/95/98.  It is a
>>  direct port of your source code without any modifications or deletions.
>>  
>>  1) Go to http://sourceware.cygnus.com/cygwin
>>  2) Download G77 and ObjectC in addition to Cygwin-B20
>>  3) Unmount C drive (umount -a /) and remonut as binary (mount -b c: /).  It
>>  is very important.
>>  4) Install Cygwin-b20 in C:\usr, instead of default directories.
>>  5) Download Cygwin-B20
>>  6) Download Jpeg, PNG and TIFF libraries from ftp.uu.net
>>  7) Compile Jpeg,PNG and TIFF with Cygwin-B20 and install
>>  8) Install all the jpeg and tiff libraries in /usr/local
>>  9) download Raster3D source code and etxract using tar utility supplied with
>>     Cygwin-b20. Download Raster3D_xxx.gz (rather than .Z) as
>>     Cygwin-B20 only handles gzip compression.
>>  (Note: Don't use WinZip or any other Windows programs to extract archive of 
>>  Raster3D and JPEG etc libraries otherwise you will get parse errors during 
>>  compilation). 
>>  
>>  Please let your users know that they will also need to download compiled
>>  binaries of Image Formate Libraries from http://www.sgi.com - Go to OpenGL
>>  web pages and look for OpenGL Optimizer Version 1.1 download site.  You will
>>  find Image Formate Libraries for Windows there.  I used these libraries
>>  together with libjepg.a and libtiff.a for linking.  They produced better
>>  results - that is images were of better quality.
>>  
>>  To use Raster3D from /usr/H-i586-cygwin32/bin copy cygwin1.dll to Raster3D
>>  directory and include Raster3D to your Windows enviroment.  That is it.
>>  
