Advanced Rendering Toolkit
Installation

How you get ART to run on your system.

Contents

Supported Platforms

Currently the following platforms are supported: On the following platforms, ART has been tried out, and seemed to work. Due to lack of resources it is not possible to check each new release on these platforms. It is possible that ART can be used on other platforms using gcc, but it has not been tested yet, and other configurations have not yet been defined for the AMS package. It also probably works with gcc 2.6.3 or gcc 2.5.8, but again we cannot test and maintain these configurations.

Prerequisites

There are a number of prerequisites for installing ART: Probably you also want to see the images you generate, so you should also have some image viewer application available (e.g. xview on X machines).

Fetch the corresponding packages from the net, install them, then proceed. In the following description we will use the command gnumake to refer to GNU make 3.75. Of course it may have any other convenient name (e.g. gmake).

Installing the Advanced Makefile System (AMS)

If you are using one of the gcc configurations (i.e. all but the NeXTSTEP 3.3/cc and the Mac OS X Server 1.0/cc configuration), you also need the AMS package.

Unpack the AMS archive (AMS.zip) [note that the package contains UNIX-specific soft-links, therefore unpacking under WINDOWS and copying the files makes the package unuseable] and set the following environment variables:

In sh, bash, and zsh, you use export VARIABLE=value, in csh, or tcsh use setenv VARIABLE value; you should put this in your shell startup file: .profile for sh, .zshenv for zsh, .bashrc for bash, .login for csh/tcsh.

For more information on AMS see $AMS_DIR/README.

Installing ART

All Platforms:

Unpack the ART archive, ART.zip. Again this archive contains UNIX-specific soft-links and unpacking under WINDOWS will make the package unuseable. You have to directly unpack it on your UNIX system.

Set the following environment variables:

Again you should put this in your shell startup file.

All AMS Platforms:

OPTIONAL: If you also obtained the file ART-Scenes.zip you should cd to $(ART_DIR)/Apps/artist and unzip the file there. This should result in a directory $(ART_DIR)/Apps/artist/scene with various subdirectories containing additional scenes.

Cd to $ART_DIR and make ART using the following command:

    gnumake --silent -f Makefile.ams AMS_MAKEFILE_NAME=Makefile.ams
You might want to make an alias for this command by putting: 
    alias ams='gnumake -s -f Makefile.ams AMS_MAKEFILE_NAME=Makefile.ams'
into your shell startup file. In sh, bash, and zsh, you can use the alias command as shown above, in csh or tcsh use a blank (' ') instead of the equal sign ('='). Afterwards you will be able to use just ams instead of the long winded sequence.

If you get a compilation error in ArfTIFF.m, you need to either remove TIFF LOGLUV support, or remove TIFF support alltogether.

Mac OS X Server 1.0:

Cd to $ART_DIR and switch ART to using Apple's ProjectBuilder makefiles: 
    bin/art-makefiles-get-rhapsody5
Now you have to set up the environment for ProjectBuilder. In order to do that you have to create a ~/.OpenStep/environment file with the following contents: 
    {
        "SHELL" = "/bin/sh";
        "ART_DIR" = "<your $ART_DIR>";
        "ART_CONFIG" ="rhapsody5";
        "ART_TYPE" = "<your colourtype (see $AMS_TYPE above)>";
    }
After creating this file you have to log out and back in again, so that the Workspace passes these variables to ProjectBuilder.

Then you can open $ART_DIR/Libs/PB.project and build all ART libraries. Afterwards open $ART_DIR/Apps/artist/src/PB.project and build the artistapplication (the ART command line renderer).

NextStep 3.3:

Cd to $ART_DIR and switch ART to using NeXT's ProjectBuilder makefiles: 
    bin/art-makefiles-get-nextstep3
Then open $ART_DIR/PB.project, and build the complete ART libraries.

All Platforms:

Normally no warnings or errors should occur during this build, and after the completion, you can start using ART. See Using the Renderer for more information.

Removing TIFF SGI LOGLUV support

If you have an older version of the TIFF library, the SGI LOGLUV format will not be supported. When you compile ART with such an old TIFF library, the following error will result: 
ArfTIFF.m: In function `arftifftype':
ArfTIFF.m:150: `PHOTOMETRIC_LOGLUV' undeclared (first use this function)
ArfTIFF.m:150: (Each undeclared identifier is reported only once
ArfTIFF.m:150: for each function it appears in.)
ArfTIFF.m: In function `_i_ArfTIFF__open':
ArfTIFF.m:204: `TIFFTAG_STONITS' undeclared (first use this function)
ArfTIFF.m:286: `TIFFTAG_SGILOGDATAFMT' undeclared (first use this function)
ArfTIFF.m:286: `SGILOGDATAFMT_FLOAT' undeclared (first use this function)
ArfTIFF.m: In function `_i_ArfTIFF__open_':
ArfTIFF.m:579: `PHOTOMETRIC_LOGLUV' undeclared (first use this function)
ArfTIFF.m:582: `COMPRESSION_SGILOG' undeclared (first use this function)
ArfTIFF.m:611: `TIFFTAG_SGILOGDATAFMT' undeclared (first use this function)
ArfTIFF.m:611: `SGILOGDATAFMT_FLOAT' undeclared (first use this function)
You can remove the support for this special TIFF format by removing the comment from the following line: 
    #define _ART_WITHOUT_TIFFLOGLUV_
in $ART_DIR/Libs/Image/ArfTiff.h.

Removing TIFF library support

If you do not have the tiff library available, you have to remove the Tiff library support. First remove the comment from the following line 
    #define _ART_WITHOUT_TIFFLIB_
in $ART_DIR/Libs/Image/ArfTiff.h. Then remove the line 
   -ltiff \
from $ART_DIR/Makefile.globals before recompiling the code (if you are using AMS).

If you are using the NeXT's ProjectBuilder, you have to remove the tiff entry in the section Files/Libraries in the projects $ART_DIR/Apps/artist/src/PB.project and $ART_DIR/Apps/tonmeap/src/PB.project

In this case it will not be possibe to create tiff files!

Recompiling single libraries

To recompile one of the ART libraries using AMS you can change into the corresponding source directory ($ART_DIR/Libs/<library>/, where <library> is one of the ART libaries), and then start gnumake: 
    ams
To recompile the artist program with the newly built library, change to $ART_DIR/Apps/artist/src, then 
   ams
If you are using NeXTSTEP and NeXT's c-compiler, open $ART_DIR as folder (Cmd-Shift-O in Workspace). Then you will have the projects of all ART libraries available on the shelf of the new file viewer. Double-click and build any single library.

Creating a backup containing all sources

In order to backup all your sources into a single zip archive, you can use the archive or package facility of AMS. To use these features, you first need to set up the following environment variables in your shell startup file: 
    export ART_ARCHIVE_DIR=<the directory where you want your archive>
    export ART_PACKAGE_DIR=<the directory where you want your package>
If you have set up these variables you can use: 
    ams archive
or 
    ams package
to create an archive or a package. The difference between these two features is, that only one package is left in the package directory, whereas the last 4 archives will be maintained in the archive directory. Usually the archive feature is used for normal backup, and the package feature is used for creating a new ART distribution. You can selectively exclude files from either of these two backups by setting the corresponding variables in $ART_DIR/Makefile.ams.

Customizing your environment

If you have zip installed you can switch on an AMS feature, that backups your sources on each call to gnumake. To do this remove the the line containing BACKUP_DIR in $ART_DIR/Makefile.globals.

ART / Documentation / Installation

This page is maintained by Alexander Wilkie. It was last updated on October 6, 2000.
If you have any comments, please send a message to wilkie@cg.tuwien.ac.at.