VisKo - Visualization Knowlegde Files

                     VisKo Installation Instructions
                     ===============================

Prerequisites
-------------

   - apache ant (http://ant.apache.org/bindownload.cgi)
   - apache tomcat v6.0.* or v7.0.* (http://tomcat.apache.org/)
   - java jdk v6 or v7 (http://www.oracle.com/technetwork/java/javase/downloads/index.html)
   - privilege to modify files under $tomcat/*
   - privilege to startup and shutdown tomcat


Installation procedure
----------------------

STEP 1: Download visko-src.zip from http://sourceforge.net/projects/visko/files/visko-src.zip/download and unzip 
   it in a local folder (${myfolder}).

STEP 2: Open a command line environment in your computer and test that you can issue java and ant commands. 

   From the command line, type 'javac -version' and Java should show the version of your java compiler. From the 
   command line of a folder that does not have a file named build.xml, type the command 'ant' and ant should say 
   'Buildfile: build.xml does not exist!'.

STEP 3: Navigate to directory ${myfolder}/visko-build

STEP 4: Customize property file server.properties in visko-build according to your preferences
   and system settings.  The critical properties to set are server-url and server-base-path, which should point
   to your local tomcat home folder.

   For folder names in property files, use forward slashes regardless of whether your operating system follows 
   unix or windows conventions. Use backslashes to identify spaces in propery names (e.g., in folder names with 
   spaces). 

STEP 5: From the command line, type 'ant'

   This command executes the build.xml script in visko-build responsible for installing a collection of basic 
   visko modules and a visko server. The installation of a visko server includes the deployment of a visko web 
   application named visko-web to your tomcat.

STEP 6: Launch tomcat and browse '${yourdomain}/visko-web'
   Launch tomcat by running $TOMCAT_HOME/bin/startup.sh or $TOMCAT_HOME/bin/startup.bat on a linux or windows 
   machine, respectively.

   In a default tomcat installation, ${yourdomain} is typically 'localhost:8080'. You should be able to access 
   your local visko application by browsing http://${yourdomain}/visko-web (e.g., http://localhost:8080/visko-web)



Testing Installation
--------------------

If you can see the visko query form at http://${yourdomain}/visko-web, that means that your visko application was
properly deployed.

Cookies MUST be enabled on your browser in order for visko-web to work properly.

If the class instances at http://${yourdomain}/visko-web/knowledge-base.jsp are not all 0 (zero), that means that
your visko server has a knowlegde base and that the server should be able to execute visualization queries.

Typical installation errors are reported during the execution of the ant script in STEP 5. A successful execution
of the ant script in STEP5 is often a sign that the visko installation was also successfully completed.



Using your Visko Server
-----------------------

Follow the instructions and example available at http://openvisko.org/ql/

You will also find many examples of visko queries at http://iw.cs.utep.edu/visko-web/query.jsp that you can 
actually run using the visko query interface at http://iw.cs.utep.edu/visko-web/ 




More detailed instructions for installing VisKo will be available soon.

          Enjoy VisKo!
          Openvisko.org team.