Installation


  Windows Icon   Windows Installation

These notes apply to SalsaJ 2.2, which is distributed as a Windows installer. To install SalsaJ, simply download the Windows .exe file, launch it and follow the instructions.

About the Installer : The SalsaJ Windows installer is created using NSIS 2.46 installer generator.


Requirements
SalsaJ requires Windows 95 or later. It runs on a machine with 64MB but it runs better with 256MB or more, particularly when working with large images and/or stacks.

Memory
Use the Edit/Options/Memory command to make more than the default 128MB available to SalsaJ. Note that setting the "Maximum Memory" value to more than about 75% of real RAM may result in poor perfomance due to virtual memory "thrashing". The maximum amount of memory that can be allocated is about 1.7 GB.

Upgrading
To upgrade to the latest version of SalsaJ, replace the salsaj.jar file in the SalsaJ folder with a newer one or just uninstall your current version and install a newer one.

Change language
To change the language of SalsaJ, simply go to the "Plugins-Choose Language" menu and choose your language. SalsaJ will close. As you reopen it, SalsaJ will be in your chosen language.

Adding a JAR File
Some plugins require adding a JAR file to SalsaJ. In SalsaJ, this is done by copying the JAR file into the plugins folder or an immediate subfolder of the plugins folder, then restarting SalsaJ. To compile a plugin that uses a JAR file, copy the JAR file to the Java extensions folder, SalsaJ\jre\lib\ext. 


  OSX Icon   MAC/OS X Installation
 
* From version 2.1 on the following procedure applies :
 
    1. download the Mac.img file ;
    2. install "Java SE 6" ;
    3. modify your "Java Preferences" (from the application menu) so that "Java SE 6" is the first in the list of java available versions to be used ;
    4. start SalsaJ clicking on the "SalsaJ2.jar"icon.
 
* For versions older than SalsaJ 2 :
 
To install and run SalsaJ, download the Mac .tar.gz file, extract the SalsaJ directory, change to the SalsaJ directory, and execute the 'salsaJ' script.
 
Here is an example:    
    tar -zxvf salsaJ_VO1-Mac.tgz    
    cd SalsaJ    
    ./salsaJ
 
This installation does not include Sun's Java Runtime Environment 1.5.
 
Memory
To make more than 512MB of memory available to SalsaJ, edit the 'SalsaJ' script. For example, changing the script to

    ./jre/bin/java -Xmx256m -jar salsaj.jar

makes 256MB available to SalsaJ.

Upgrades
To upgrade to the latest version of  SalsaJ, replace the salsaj.jar JAR file in the SalsaJ directory by the new one. In alternative, simply install the new version.

Linux Icon   Linux x86 Installation

 To install and run SalsaJ, download the Linux .tar.gz file, extract the SalsaJ directory, change to the SalsaJ directory, and execute the 'salsaJ' script (after having made it executable).

Here is an example:

    tar -zxvf salsaJ_"version".tar.gz
    cd SalsaJ_"version"
    chmod 755 salsaj"version"
    ./salsaj"version"

Memory
To make more than 512MB of memory available to SalsaJ, edit the 'SalsaJ' script. For example, changing the script to

    ./jre/bin/java -Xmx256m -jar salsaj.jar

makes 256MB available to SalsaJ.

Upgrades
To upgrade to the latest version of  SalsaJ, replace the salsaj.jar JAR file in the SalsaJ directory by the new one. In alternative, simply install the new version.

Sharing SalsaJ and the JRE

You can specify the location of the plugins directory from the command line using the -D option to set the "plugins.dir" property. This allows SalsaJ to be in a common location (e.g., /usr/local/SalsaJ) and run from the users home directory using a shell script. This example script runs SalsaJ from /usr/local/SalsaJ using a plugins directory at /home/euhou/SalsaJ/plugins:
    cd /usr/local/SalsaJ
    ./jre/bin/java -Xmx512m -jar salsaj.jar -Dplugins.dir=/home/euhou

This example uses the Java 1.5 SDK to run SalsaJ from /usr/local/SalsaJ with the plugin directory also located in /usr/local/SalsaJ:

    /usr/java/jdk1.5/bin/java -Dplugins.dir=/usr/local/ImageJ -Xmx512m
    -jar /usr/local/SalsaJ/salsaj.jar:/usr/java/jdk1.5/lib/tools.jar

Compiling Plugins
The Plugins/Compile and Run command uses the javac compile contained in tools.jar. The Java 1.5  runtime included with the Linux distribution of SalsaJ includes tools.jar in ImageJ/jre/lib/ext. Users of the Java SDK will need to add tools.jar to the command line. Here is an example:

    java -Xmx512m -jar salsaj.jar:\usr\local\jdk1.5\lib\tools.jar