You are a guest. Restricted access. Read more.
SCaVis manual

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Previous revision
man:general:installation [2013/04/14 21:26]
man:general:installation [2014/10/11 06:20] (current)
admin [General comment]
Line 1: Line 1:
 +====== Installation ======
 +{{indexmenu_n>​1}}
 +
 +{{indexmenu>​man:​install |js#​scavis}}
 +{{keywords>​installation}}
 +
 +First, make sure that the JAVA virtual machine is installed. ​
 +Simply click on [[http://​java.com/​en/​download/​installed.jsp|this link]] ​ to check the JAVA version. For Linux/Mac, one can also check the  JAVA by typing in the terminal:
 +
 +<​code>​
 +java -version
 +</​code> ​
 +
 +You will see:
 +
 +<​code>​
 +java version "​1.7.0_05"​
 +Java(TM) SE Runtime Environment (build 1.7.0_05-b06)
 +Java HotSpot(TM) Server VM (build 23.1-b03, mixed mode)
 +</​code>​
 +or a similar message. ​
 +
 +You can install Java using this link [[http://​java.com/​en/​download/​index.jsp|Java install page]].
 +You can install JAVA JDK (for developers) from the [[http://​www.oracle.com/​technetwork/​java/​javase/​downloads/​index.html|Oracle JAVA download page]]. The JDK JAVA version allows to compile JAVA code using ``javac''​ compiler. ​ Linux/Mac users usually have JAVA installed by default.
 +
 +
 +====== SCaVis Installation ======
 +{{keywords>​installation}}
 +{{tag>​installation}}
 +
 +
 +Get the most recent **scavis-VERSION.zip** file from the [[http://​jwork.org/​scavis/​download_page|SCaVis Download Web page]], where "​VERSION"​ is the current version.
 +
 +<note important>​SCaVis 1.0 and above requires Java version 1.7.X. You can use Java 1.6.x to run 
 +[[http://​jwork.org/​jhepwork/​|jHepWork]] version 3.4 (and below)</​note>​
 +
 +**For Linux/​Mac:​**
 +
 +Get the recent a stable release as: 
 +<code bash>
 +wget -O scavis.zip http://​sourceforge.net/​projects/​scavis/​files/​latest/​download
 +unzip scavis.zip
 +./​scavis.sh ​    # run ScaVis IDE
 +</​code>​
 +
 +One can also use a devolomenent (unstable) version as:
 +<code bash>
 +wget -O scavis.zip http://​jwork.org/​scavis/​download/​current.php
 +unzip scavis.zip
 +./​scavis.sh ​    # run ScaVis IDE
 +</​code>​
 +
 +**For Windows:**
 +
 +Download and unzip the **scavis-[VERSION].zip** file, where [VERSION] is a version number. ​
 +This creates the  directory **scavis-[VERSION]**. Go to this directory, and
 +the subdirectory "​scavis",​ and click the file **scavis.bat**.
 +This executable Windows file will launch the SCaVis. Alternatively,​ click the file **scavis.jar**. ​
 +
 +
 +====== Generic installation using jPort menu ======
 +
 +Instead of unzipping the ScaVis files, consider using the [[http://​jwork.org/​jport/​|jPort portable desktop menu]].
 +This method works for all platforms (Windows, Linux and Mac), and you can carry ScaVis on a USB flash drive.
 +In addition, you can install other jWork.ORG applications.
 +
 +
 +====== Additional information ​  ​======
 +
 +SCaVis always put its installation files inside the "​scavis"​ directory. It never modifies your  Windows system files nor change the Windows settings. This means that removal of SCaVis is very simple - just remove the directory "​scavis"​!
 +
 +For Mac, Linux and UNIX, one can put the file "​scavis.sh"​ to the 
 +<​code>​
 +$HOME/​bin ​
 +</​code>​
 +directory, so one can start SCaVis from any directory. In this case, one should set the variable "​JEHEP_HOME"​ (defined inside the script "​scavis.sh"​) to the directory path where the file "​jehep.jar"​ is located.
 +
 +The full members have access to the professional edition of SCaVis-Pro. This version periodically receives bug-fix updates **scavis-[VERSION]pro.zip** (note "​pro"​ string).
 +
 +====== General comment======
 +
 +First time when you run "​scavis.sh"​ (Linux/​Unix/​Mac) or "​scavis.bat"​ (Windows), you will see the messages such as:
 +
 +<​code>​
 +*sys-package-mgr*:​ processing new jar, '​jhplot.jar'​
 +*sys-package-mgr*:​ processing new jar, '​jminhep.jar'​
 +etc., etc.,
 +</​code>​
 +
 +This is normal: you should wait until Jython finishes caching Java jar libraries (it creates the directory "​jython/​cachedir"​ with the description of all classes located in jar files defined in the CLASSPATH variable.). Next time when you execute the start-up script, SCaVis IDE starts very fast.
 +
 +====== Quick check of examples ======
 +
 +You can run all SCaVis examples using the menu **[Tools]-[Examples]**. This brings up a window with free examples. Select any file and click **[Run]** (from this dialog, not from the IDE toolbar). Look at [[http://​youtu.be/​RmhrQdUvtzY | the YouTube ScaVis clip]] which shows SCaVis Online examples.  ​
 +
 +You can also use free examples using **[Online examples]**. You can run and view only free examples (marked with the red letter F).
 +If you run SCaVis-Pro, you can view and run all examples.
 +
 +
 +
 +
 +====== Activation of SCaVis-Pro ======
 +
 +If you have a [[http://​jwork.org/​scavis/​members/​selock| full membership]],​ you can activate SCaVis-Pro as
 +this: download and run the free SCaVis version. Then, go to the SCaVis toolbar and select ​ **[Help]→[Activate]**. You need to enter  your  username (not password!) that was requested by you  for  [[http://​jwork.org/​scavis/​members/​selock| full membership]]. ​
 +
 +SCaVis-Pro can be used for a commercial purpose, plus it has full access to built-in examples **[Tools]→[Online examples]**, ​
 +[[http://​jwork.org/​scavis/​wikidoc/​doku.php|SCaVis manual]], [[http://​jwork.org/​scavis/​api/​|full Java API]],
 +[[http://​jwork.org/​scavis/​examples/​|online examples]],​source code etc.
 +
 +In a few situations, the activation may fail (when, for example, you do not have correct network settings).
 +Then request the password by sending email to scavis [at] jwork.org
 +
 +====== Updating SCaVis ​ ======
 +
 +Simply remove the directory "​scavis"​ (if you did not create your files inside the directory "​scavis"​!).
 +Then unzip the zip file with a new version. SCaVis periodically checks that you are running the most updated version.
 +
 +If you are using SCaVis-Pro (professional) version, you should receive updates of separate jar
 +libraries on a regular bases and thus there is no need to reinstall the entire program. ​
 +This helps keep all of the numerical libraries on your computer up-to-date.
 +
 +<note important>​To make sure that your computer use the latest SCaVis libraries, check **[Help]-[Update]**</​note>​
 +
 +====== Uninstalling ​ SCaVis ​ ======
 +
 +To uninstall SCaVis is simple: just remove the directory "​scavis"​ with your installation (for windows/​linux/​mac).
 +SCaVis never leaves any files in your system directory or changes Windows register.
 +
 +
 +====== Libraries for Eclipse and NetBeans ======
 +
 +You can download single-jar file which does not contain IDE. This jar files can be used for
 +import to Eclipse or NetBeans IDE (both good to work with Python or Java). ​ These jar files
 +are available for SCaVis full members as described here [[netbeans]]. You can also
 +download a minimalistic jar file (~10MB) which can be deployed for applets.
 +
 +====== CBook package ======
 +
 +
 +If you are working with a C++ program ​
 +and you will need to visualize data using Java or Jython,
 +then you will need the [[http://​jwork.org/​scavis/​cbook/​|CBook C++ package]]
 +This package allows you to fill histograms and vectors
 +in a C++ code, and write them in a "​pbu"​ file which
 +contains ​ zipped ​ data records based on
 +the Google'​s Protocol Buffers format.
 +One can read such files using the jhplot.io.PFile class
 +of SCaVis.
 +In addition, one can write structural data using a C++ code
 +and read them back using SCaVis (class EFile).
 + 
 +
 +
 +====== Installation for multiple users ======
 +
 +The description discussed above concerns a single-use installation.
 +It may be convenient to install SCaVis in a central location (for example on a shared
 +directory on NFS) so all users will be able to run run the program.
 +Below is a step-by step instruction describing how to do this.
 +
 +<ifauth !@member>​
 +<note important>​
 +This advanced section is available for the full members. Click the link for the
 +[[http://​jwork.org/​scavis/​members/​selock| full membership]] here. 
 +</​note>​
 +</​ifauth>​
 +<ifauth @member,​@admin,​@editor>​
 +
 +  * Unzip the package in some location
 +  * For the Linux platform, create a bash shell file, say with the name "​jh",​ which will look as:
 + 
 +<code bash>
 +#!/bin/bash
 +# set here home directory where the jehep.jar file is located ​
 +JEHEP_HOME=$HOME/​work/​workspace/​scavis/​jehep
 +##################​ do not edit ###############################​
 +JAVA_HEAP_SIZE=128
 +CLASSPATH=$JEHEP_HOME"/​jehep.jar":​$CLASSPATH
 +# set jython home
 +export JYTHON_HOME=$JEHEP_HOME"/​lib/​jython"​
 +# Add in your .jar files first
 +for i in $JEHEP_HOME/​lib/​*.jar
 +do
 +      CLASSPATH=$CLASSPATH:"​$i"​
 +done
 +# Add in your .jar files first
 +for i in $JEHEP_HOME/​lib/​*/​*.jar
 +do
 +      CLASSPATH=$CLASSPATH:"​$i"​
 +done
 +# convert the unix path to windows
 +if [ "​$OSTYPE"​ = "​cygwin32"​ ] || [ "​$OSTYPE"​ = "​cygwin"​ ] ; then
 +   ​CLASSPATH=`cygpath --path --windows "​$CLASSPATH"​`
 +fi
 +EXT_DIR=$JEHEP_HOME/​lib/​freehep:​$JEHEP_HOME/​lib/​system:​$JEHEP_HOME/​lib/​user:​$JEHEP_HOME/​lib/​update
 +if [ -z $JAVA_HOME ]; then
 +        java -mx${JAVA_HEAP_SIZE}m -cp $CLASSPATH -Dpython.home=${JYTHON_HOME} -Djava.ext.dirs=${EXT_DIR} -Djehep.home=$JEHEP_HOME jehep.ui.mainGUI ​ $1 &
 +else
 +        $JAVA_HOME/​bin/​java -mx${JAVA_HEAP_SIZE}m -cp $CLASSPATH -Dpython.home=${JYTHON_HOME} -Djava.ext.dirs=${EXT_DIR} -Djehep.home=$JEHEP_HOME jehep.ui.mainGUI $1 &
 +fi
 +
 +</​code>​
 +
 +
 +Change in this file the variable "​JEHEP_HOME"​ which points to the directory with located file "​jehep.jar"​.
 +
 +  * Unordered List ItemCopy this file into some where the  variable PATH can find it. Assume you put this file to "​share/​bin/​jh"​. In this case point to this executable ​ in the files "​.bashrc" ​ and (or) "​.bash_profile"​ which are usually located in users home directory. Put these lines into these files:
 +
 +<code bash>
 +export JHINSTALL=/​share/​bin/​jh
 +export PATH=$JHNSTALL/​bin:​$PATH
 +</​code>​
 +You are done. Now any user can run the program by executing "​jh"​ command.
 +
 +</​ifauth>​
 +
 +
 +
 +
 +[[man:​start|<<​ back]]
  
CC Attribution-Share Alike 3.0 Unported
Powered by PHP Driven by DokuWiki Recent changes RSS feed Valid CSS Valid XHTML 1.0 Valid HTML5