

                             CASSANDRA  
              VTK/Java based 3D Scientific Data Viewer
                  (c) Artenum, Paris, France, 2005
                  http://www.artenum.com/cassandra



Initial authors: 
    Sebastien Jourdain (Artenum), contact: sebastien.Jourdain@artenum.com
    Julien Forest (Artenum), contact: j.forest@artenum.com


1) Introduction / Purpose

    Cassandra is a modular and advanced 3D scientific data viewer.
Cassandra is written in Java and based on the Visualisation Tool Kit, 
VTK. 

Like in OpenDX, Cassandra includes a graphical visualisation pipeline 
editor based on the DedalEgraph library.

Data processing are performed through an extensive set of dynamical and
independent plug-ins. An advanced Python/Jython console, JyConsole, 
complete the system and allows the direct manipulation of all objects 
used in the system, independently of their initial language (C++/Java/
Python). JyConsole includes an object oriented completion. 

Thanks to this modular approach, Cassandra is highly adaptable and
extensible to specific and tailored data processing and should simplify 
the learning curve of the VTK library by non-specialists. 

For more information, please see:
 
         http://www.artenum.com/cassandra 
     or 
         contact@artenum.com

Plug-ins, scripts and additional modules are available at:
       
         http://dev.artenum.com/projects/cassandra

DedalyEgraph and JConsole are projects initiated and developed by Artenum
(see http://www.artenum.com/products/).


2) Installation and start

- Download the generic Cassandra2.1 package on the Cassandra web site:

  => http://dev.artenum.com/projects/cassandra/downloadPage 
  => Cassandra2.1.zip

- Unpack the archive pack:

  => unzip Cassandra2.1.zip 

- Download the proper VTK native library 

  => vtk42-native-linux.tgz  
 or
  => vtk42-native-win.zip

- Unpack the archive in the ThirdPart directory of Cassandra depending on your system.
  (If you want to build a multi-platform application you can put both.)

  => CASSANDRA_ROOT/Content/ThirdPart/vtk42-native-linux/*.so
 or 
  => CASSANDRA_ROOT/Content/ThirdPart/vtk42-native-win/*.dll

- Edit the run.sh or the run.bat to set the proper path for java. 
  This must be a JRE and not the JDK (Every JDK has a JRE inside them) 
 or 
- Copy the content of your jre directory inside the JRE directory 
  of Cassandra in order to build a standalone application. 
  (CASSANDRA_ROOT/Content/jre/linux or .../win)

- Start Cassandra by calling the script "run". To do so, go into 
  the Cassandra root directory and launch the run.sh or the run.bat 
  file, as follow:

    Under Unix/linx: ./run.sh
    Under Windows: run.bat or double click on it.

In case of problem see section 3.


3) Installation

    3.1) Prerequis

    Hardware:
        The absolute hardware requirements are strongly dependent on the
    total volume of data to process. The minimal requirements are:
	- PC AMD/Intel, 1.8GHz, 256Mb RAM, 40Mb HD
	- Apple Mac, G4 1.2GHz, 256Mb RAM, 40Mb HD

    A 3D accelerated video card is strongly recommended.

    System:
        Cassandra is multi-platform and has been successfully tested on the
    following systems:
        - Windows NT/2000/XP
        - UNIX/Linux
        - Mac OS-X Panther (in experimental mode)

    Third part and additional components:
    - Visualisation Tool Kit (VTK): 
        The data processing is based on the VTK library developed by
    Kitware (http://public.kitware.com/VTK/). VTK is a native library 
    and its binary version depends on the used platform.

    - Java Virtual Machine (JRE): 
        Cassandra requires a JRE 1.4.XX and higher.

    - Jython interpreter: 
	The Python/Jython console includes the Jython 2.1 package 
    (http://www.jython.org).

    A binary packages and needed external libraries are already 
    included in the "Cassandra full pack".


    3.2) Installation

       Normally no specific installation is required. You must just unpack
    the archive pack, as follow on Unix systems:

       unzip Cassandra2.1.zip 

    A complete tree will be deployed as follow:

    Cassandra_ROOT	                => Casssandra base directory
         + run.sh                       => Script to launch Cassandra on Linux
         + run.bat                      => Script to launch Cassandra on Windows
         + Data/                        => Sample VTK data directory
             + test.vtk                 => Sample VTK file
         + Script/                      => Sample Python script directory
             + init.py                  => Sample Python script
             + run.py
         + Content/                     => Application content
             + config.properties        => Configuration file for execution
             + plugin/                  => Plugin directory
                + CuttingPlane.jar      => A Cassandra plugin
                + ...
             + jre/                     => The embeded jre
                + linux/                => JRE for Linux
                + windows/              => JRE for Windows
             + ThirdPart/
                + vtk4.2/
                   + vtk.jar            => VTK common Java wrapping Lib
                + vtk42-native-linux/   => VTK native Library for Linux
                + vtk42-native-win/     => VTK native Library for windows
             + jython-2.1
                 + jython.jar
                 + ...
             + artenum/
                 + cassandra
                    + ArtenumPipeLineManager.jar
                 + dedalegraph
                    + DedaleGraph.jar
                 + jyconsole
                    + JyConsole.jar


    3.3) Cassandra Components

    Cassandra is composed of several components such as:
        - The main application (Cassandra.jar)
        - The plugins (plugin/CuttingPlane.jar, plugin/IsoLevel.jar...)
        - The VTK native Library 
        - Some Python scripts
        - Some VTK sample data


4) Execution

To launch Cassandra, execute the run.sh or run.bat file, as follow:

    Under Unix/linx: ./run.sh
    Under Windows: run.bat or double click on it.


5) Trouble shooting 

Some slow down has been noticed on Windows when frequent switch 
between the 3D view and the Swing components.


6) Change log 

- Cassandra 2.1
    - An update of JyConsole
    - An update of the pipeline manager
    - Bounding box

- Cassandra 2.0
    - A VTK Pipeline Editor
    - Cutting Plane plugin
    - Generic cutter plugin (plane/sphere/cylinder)
    - IsoLevel plugin (Single and Multi level)
    - Threshold plugin
    - Probing line

7) Intellectual properties and licensing

    All right reserved Artenum, Paris, France, 2005.


8) Contact

    E-mail: cassandra@artenum.com

    Mail: Artenum SARL
          101-103, Bd Mac Donald
          75019 PARIS, FRANCE

    Phone: +33(0)1 44 89 45 15
    Fax:   +33(0)1 44 89 45 17

