==============================================================================

                                    E V I T A
                  Efficient Visualization of Terascale Datasets

                            Version 0.16, 16-jul-2016

                       Copyright (C) 2000-2016  Team Evita

------------------------------------------------------------------------------


==============================================================================

  Contents:
    - Availability
    - Installation
    - Copyright and License Information

==============================================================================


AVAILABILITY:

  For updated versions of Evita, go to:

    http://evita.sourceforge.net

  or contact:

    Dr. James E. Fowler, Mississippi State University
    fowler@ece.msstate.edu


==============================================================================


INSTALLATION:

  Installation Notes:

    The Evita System should compile on any UNIX machine; Microsoft Windows
    is not supported.  You must have the following to install Evita:
      - QccPack (http://qccpack.sourceforge.net)
          Version 0.61 or later, must be compiled with pthread support
      - VTK (http://www.kitware.com)
          Version 6.2 or later
      - FLTK (http://www.fltk.org)
          Version 1.3.3 or later
      - OpenGL or Mesa (http://www.ssec.wisc.edu/~brianp/Mesa.html)
          Mesa Version 11.1 or later
      - Compiler - to compile Evita, you will need a standards compliant
          C++ compiler. The recommended compiler is The Gnu Compiler
          Collection (gcc), version 5.3.1

  Installation Steps:
          
    - Untar the Evita distribution to a directory in which building
      is to be performed.  The directory /usr/local/src/Evita is
      suggested, but use whatever location you want. In the following,
      the variable $EVITA_SRC represents this directory
    - Change the current directory to $EVITA_SRC and untar the EvitaData
      distribution; this will create a subdirectory called "Data" in
      $EVITA_SRC.
    - With the current directory set to $EVITA_SRC, create the Makefile
      by copying Makefile.<osname> to Makefile, where <osname> is the name
      of your operating system (currently only "linux" is supported). For
      example, type: "cp Makefile.linux Makefile"
    - Edit the Makefile :
        - Set EVITA, EVITA_BIN, EVITA_LIB, EVITA_INCLUDE, and EVITA_DATA to
            the desired final installation location of the Evita executables,
            the Evita library (libEvita.a), the Evita header files, and the
            Evita data, respectively.
        - Set the QCCPACK defines as needed to point to the QccPack
            header files and library.
        - Set the VTK defines as needed to point to the VTK header files and
            libraries
        - Set the FLTK defines as needed to point to the FLTK header files and
            libraries
        - Set the GL defines to point to the OpenGL or Mesa library
        - Set the X defines appropriately (no change usually needed here)
        - Define CC, CXX, CFLAGS, CXXFLAGS, LFLAGS, AR, and RANLIB as
            needed for your desired ANSI C and standards-compliant
            C++ compilers and associated flags. 
    - Type "make".
    - When you're happy that things compiled OK, type "make install" to
        put the Evita library, header files, executables, and data
        into their final installation locations.


==============================================================================

DEMO:

  Introduction:
    In the Data subdirectory, there is the file pacific.ds which is a
    3-component 2D dataset containing velocity, energy, and density values
    for a number of swirling regions in the Pacific Ocean as sampled on an
    implicit, rectangular grid.

    The following assumes that the $EVITA_BIN directory (see above) is
    in your path, and you have defined the environment variable $EVITA_DATA
    appropriately.

  Feature Detection and Segmentation:
    To detect swirl features in the pacific dataset, do the following:

      dsdetect -swirl -area $EVITA_DATA/pacific.ds pacific.sm

    The output file is pacific.sm, the segmentation map which identifies
    detected swirls in the dataset as ROIs. These swirls are ranked in order
    of decreasing area. Also possible: -maximum (rank by maximum significance
    value), -strength (rank by sum of significance value), -average_strength
    (rank by average significance value over area).

  Encoding:
    To encode (compress) the pacific.ds data file, use the evita_encoder
    program:

      evita_encoder

    Follow the directions in the GUI to enter the filenames for the dataset,
    the segmentation map, the bit rate, and the priority-schedule and
    bitstream output filenames.

    Encoding with evita_encoder can also be done via the command line,
    bypassing the GUI. To do so, do the following:

      evita_encoder 24.0 pacific.ds pacific.sm \
        pacific.ps pacific.bit

    where pacific.bit is the output bitstream (compressed data file),
    pacific.ps is the output priority schedule (indicating the order in
    which each bitplane of each componentn of each ROI occurs in the
    compressed bitstream), pacific.sm is the significance map, and pacific.ds
    is the dataset. The dataset is coded to a bit rate of
    24.0 bits/sample in this case. In this case, all components are 
    encoded. Use the -c option to select the components; e.g.,

      evita_encoder -c 0,1,2 24.0 $EVITA_DATA/pacific.ds pacific.sm \
        pacific.ps pacific.bit

  The Evita Server:
    Start the Evita server:
    
      evitad
    
    The server awaits connection by the Evita client, ready to deliver a
    bitstream when a connection is established by the client.

  The Evita Client:
    In an xterm window, on the same machine as the evita server, or on
    a different machine, start the Evita client:
   
      evita
    
    The GUI will allow you to connect to the Evita server, select a
    bitstream, and launch a VTK visualization session of a selected
    component of the bitstream. You can select an ROI during the
    visualization system by double-clicking on it. You will see the
    selected ROI be progressively reconstructed to a high degree of detail,
    and then all the other ROIs (including the background) will be refined.
    By default, the visualization refinement order is that in which the
    bitstream was produced by evita_encoder which is, in turn, dependent
    on the order the ROIs were ranked in the generation of the segmentation
    map by dsdetect.

    You can have the Evita client dump the images rendered to the
    VTK window to a sequence of PGM image files named, for example,
    pacific.000.pgm, pacific.001.pgm, pacific.002.pgm, etc., by
    specifying the output-image filename as pacific.%03d.pgm (the "%03d"
    can be any standard printf(3) style format conversion specification).
    You can use xv to display any single image, or animate (part of
    ImageMagick) to display the whole sequence (i.e.,
    "animate pacific.*.pgm").
         

==============================================================================


COPYRIGHT AND LICENSE INFORMATION:

  EVITA: Efficient Visualization of Terascale Datasets
  Copyright (C) 2000-2016  Team Evita
   
  The programs and library herein are free software; you can redistribute
  them and/or modify them under the terms of the GNU General Public License
  or the GNU Library General Public License as published by the Free
  Software Foundation, as appropriate; either version 2 of these Licenses,
  or (at your option) any later version.

  The library and all programs herein are distributed in the hope that
  they will be useful, but WITHOUT ANY WARRANTY; without even the implied
  warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
  the full text of the appropriate license for more details.

  You should have received a copy of the GNU General Public License
  and the GNU Library General Public License along with these programs and
  library; if not, write to the Free Software Foundation, Inc.,
  675 Mass Ave, Cambridge, MA 02139, USA.


==============================================================================
