Guide to Installing and Getting Started

This page links to information to help you get started with your Salience installation. In particular, what's needed to start coding against the API on the various platforms and within the various development languages we support.

First, the obvious starting point: on which platform are you installing?


Steps for installing Salience on Linux platforms

For the purpose of this guide, we'll assume that the Salience distribution has been downloaded to /home/devuser/downloads and is being installed in /home/devuser/lexalytics. We'll also assume a 64-bit Linux environment.

Note: Salience 6.x supports any distribution of Linux with glibc 2.3.4+

1) Download the distribution

Download the current tar distribution and unpack it:

cd /home/devuser/downloads
tar -xjf salience-6.0.0.x-x64.tar.bz2
cp salience-6.0.0.x ../lexalytics

2) Provide the license

The Lexalytics license file can exist anywhere on your system, as it is provided to the Salience API via fully-qualified path. However, for the sake of simplicity, we'll copy it into the root of our installation:

cp license.v5 ../lexalytics/salience-6.0.0.x

Note: Salience 6.x uses the same license files as Salience 5.x

3) Set up environment variables

The environment variable lxainstall must be set to the root of your installation. There are other environment variables that can aid with support within various development environments (mainly Java). The following is recommended for your .bash_profile file.

emacs .bash_profile

Add the following:

lxainstall=/home/devuser/lexalytics/salience-5.0.5999
export lxainstall

LD_LIBRARY_PATH=$lxainstall/salience/lib
export LD_LIBRARY_PATH

JAVA_HOME=$HOME/jdk1.6.0_24
export JAVA_HOME

JAVA_OPTS="-Djava.library.path=$LD_LIBRARY_PATH"
export JAVA_OPTS

PATH=$JAVA_HOME/bin:$PATH:$HOME/bin:$lxainstall
export PATH

Refresh your environment:

source .bash_profile

4) Explore the Salience SDK

Now that you have Salience deployed to your system, you can focus on the examples provided for your development environment of choice and getting familiar with the Salience API for that development environment. Use the links below to learn more about getting started with development in the supported languages:

I'm developing in Java I'm developing in python


Steps for installing Salience on Windows platforms

For the purpose of this guide, we'll assume that the Salience distribution has been downloaded to C:\Users\devuser\Downloads and is being installed on a 64-bit Windows machine.

Note: Salience 6.x supports Windows Vista/7/8

1) Download and run the installation

Download the current Windows install executable and run it:

In Windows Explorer, open C:\Users\devuser\Downloads and double-click Salience-6.0.0.x-x64.exe
Click Next on the installation Welcome screen
Set the desired installation location and click Next on the installation Choose Install Location screen
NOTE: The installer is a 32bit executable, even in the case of the 64bit Windows distribution. It is recommended that you change the default install location to C:\Program Files\Lexalytics on this screen.
Click Install on the installation Choose Components screen
'Wait! I ran into a problem with the Windows runtime support needed!'
There are environments which do not contain the runtime support needed for Salience, in which case the installer will attempt to download the runtime support from Microsoft. If this automatic download fails, please see the instructions in the blog article Support Notes: Windows runtime prerequisites for the URLs to manually download and install the runtime support needed.

2) Provide the license

The Lexalytics license file can exist anywhere on your system for the purposes of working with the API, however the demonstration applications provided by the Windows installation expect the license file to exist in the root of the installation as license.v5:

Copy license file to C:\Program Files\Lexalytics and rename to license.v5

3) Explore the Salience SDK

Now that you have Salience deployed to your system, you can focus on the examples provided for your development environment of choice and getting familiar with the Salience API for that development environment. Use the links below to learn more about getting started with development in the supported languages:

I'm developing in .Net I'm developing in Java I'm developing in python