Annot3D Downloads and Installation

Also visit the Annot3D Home Page for more information about Annot3D.

To successfully install ANNOT3D, be sure to complete all of the instructions for "Downloads" and "Getting Started".

Downloads

  1. Get Annot3D Files
  2. Download and Install Tcl
  3. Download and Install VTK

Getting Started

  1. Set Environment Variables
  2. Running Examples
  3. Mailing List

Optional Features

  1. Get Annot3D Example Data (optional)
  2. Install Tclhttpd Web Server (optional)

Support

  1. Questions/Problems
Downloads

STEP 1 - Get Annot3D Files

The Annot3D folder contains all of the files in the outlined File Structure on the documentation page. With this software, all of the annotation demos, functions, and data sets are available. You have two options for getting the Annot3D files:

1) Download the software as as a tarball (Unix) or zip file (Windows). This is the recommended option.
2) Checkout a copy of the files from the cvs repository. This is only an option if your are a developer for Annot3D and you have access to the cvs repository.

Download the software

Windows Unix

Checkout a copy from CVS

Note: If you are unfamiliar with CVS, please take a look at the intro to CVS before checking out a working copy.

The way that you check out files from a cvs repository is different depending on whether you are working on a machine that is on the same filesystem as the cvs repository or not. If you are on the same filesystem, you are working locally. If not, you are working remotely. In the case of Annot3D, the cvs repository is stored on the SCI filesystem.

If you're working on Windows, you'll need to run the commands below in a cygwin terminal or log into a Unix machine and run them from a Unix terminal. If you choose to use cygwin, you'll need to make sure cvs and ssh are installed. To check to see if cvs and ssh are installed in cygwin, open a cygwin shell and type the following:

> cvs

If you get a "command not found" message, you need to install cvs. Do the same to see if you have ssh installed. If cvs and ssh aren't installed, download cvs and openssh for cygiwin from the cygwin home page.

Here are the instructions for local and remote checkout of the Annot3D cvs repository:


Locally (from a machine on the SCI filesystem): Remotely (from machine not on SCI filesystem):
If you have problems with CVS, send mail to
simpson@cs.utah.edu.

STEP 2 - Download and Install Tcl

Tcl can be downloaded from the VTK home page. Tcl is a java based programing language.

Get the software

Windows Unix

STEP 3 - Download and Install VTK

Vtk can be downloaded from the VTK home page. Vtk contains a collection of tcl scripts used for volume rendering and annotating.

Get the software

Windows Unix
Getting Started

STEP 1 - Set Environment Variables

In order for Annot3D and VTK to run properly, you need to set Environment Variables to specify where the directories were installed on your computer.

Set the Variables

Windows

VTK_DATA_ROOT = C:\Program Files\vtk42 and ANNOT_ROOT = C:\~\Annot3D

Note: If you are using a version of Windows other than WindowsXP, you will need to set the environment variables using forward slashes ( / ) instead of backslashes ( \ ) and "PROGRA~1" instead of "Program Files". Your variables will look something like this: VTK_DATA_ROOT = C:/PROGRA~1/vtk42 and ANNOT_ROOT = C:/~/Annot3D
Unix

STEP 2 - Running Examples


Using example.tcl files

Windows Unix

STEP 3 - Mailing List

Mailing list members will be notified when updates to the Annot3D software are made available.

Subscribe to the Annot3D mailing list

To Subscribe To Send Mail To Unsubscribe
Optional Features

STEP 1 - Get Annot3D Example Data (optional)

The Annot3D Example Data files are used to run the examples in /Annot3D/demos/. For information on which data set is used by each demo, see the Annot3D documentation page.

Download the Example Data

Windows

Click on the link to download each data set:

Unix

Click on the link to download each data set:


STEP 2 - Install Tclhttpd Web Server (optional)

The Tclhttpd web server that is included with the Annot3D software allows Annot3D to act as a web server that gets XML data from a client (such as a web browser), renders it, and returns an image to the client. If you wish to run Annot3D locally and are not interested in running it as a web server, you can skip this step.

Install the Tcl Web Server

Windows

You shouldn't need to do anything to install the web server. However, you'll need to install the tcllib in order to run the web server.

Unix
Support

Questions/Problems

Send mail to:



Last modified: Wed Jan 7 14:59:08 MST 2004 by Janna Balling