

                           CASSANDRA 2.0 
              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://artenum.libresource.net/projects/cassandra

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


2) Quick installation and start

Unpack the archive pack, as follow on Unix systems:

       tar xvf Cassandra.tgz 
    or 
       unzip Cassandra.zip 

This must create a Cassandra root directory. Go into the Cassandra root 
directory and launch the run.jar file, as follow:

    Under Unix/linx: java -jar run.jar
    Under Mac OS-X and Windows, run.jar is auto-executable. 

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 (JVM): 
        Cassandra requires a JVM 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:

       tar xvf Cassandra.tgz 
    or 
       unzip Cassandra.zip 

    A complete tree will be deployed as follow:

    Cassandra_ROOT	           => Casssandra base directory
         + data/                   => Sample VTK data directory
             + test.vtk            => Sample VTK file
         + script/                 => Sample Python script directory
             + exemple.py          => Sample Python script
         + plugin/                 => Plugin directory
             + CuttingPlane.jar    => A Cassandra plugin
             + ...
         + ThirdPart/
             + vtk/
                 + vtk-(win/linux/osx)/  => VTK base directory
             + jython-2.1
                 + jython.jar
                 + ...
             + artenum/
                 + cassandra
                    + ArtenumPipeLineManager.jar
                 + dedalegraph
                    + DedaleGraph.jar
                 + jyconsole
                    + JyConsole.jar
         + Cassandra.jar           => The Cassandra application
         + run.sh                  => Script to launch Cassandra on Linux
         + run.bat                 => Script to launch Cassandra on Windows
         + run.py                  => Script to launch Cassandra with python/jython
         + run.jar                 => Script to launch Cassandra on any system

    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 (VTK/vtk-win or VTK/vtk-linux or 
          VTK/vtk-osx)
        - Some Python scripts
        - Some VTK sample data


4) Execution

To launch Cassandra, execute the run.jar file, as follow:

        Under Unix/linx: java -jar run.jar
        Under Mac OS-X and Windows, run.jar is auto-executable. 

    The run.py script can be launched in the same manner with a jython 
interpreter.  

         jython run.py

    In case of problem, please edit this script, check all path and if needed 
correct them. run.jar is generated from run.py using jythonc. 


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.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

