..
..                             Vortex Link
..
..    This software and documentation are Copyright 2010 to 2018 ADLINK
..    Technology Limited, its affiliated companies and licensors. All rights
..    reserved.
..
..    Licensed under the ADLINK Software License Agreement Rev 2.7 2nd October
..    2014 (the "License"); you may not use this file except in compliance with
..    the License.
..    You may obtain a copy of the License at:
..                        docs/LICENSE.html
..
..    See the License for the specific language governing permissions and
..    limitations under the License.
..

.. _`Requirements`:

############
Requirements
############

*********************
Software dependencies
*********************

Required before installation
============================

The following software must be installed on your host system before installing
Vortex Link:

+ **A Java Runtime Kit (JRE) v6 minimum**
    | (ensure that the ``java`` executable is in your ``PATH``).


Other noteworthy dependencies
=============================

Vortex Link use the following open source libraries, which for convenience are
bundled in the installation zip file (you don’t need to install them separately).

+ **Netty** (http://netty.io/) : for DDSI protocol implementation over UDP and TCP.
+ **Trove4j** (http://trove4j.sourceforge.net) : high performance Java collections.
+ **Apache Commons** (http://commons.apache.org/) : various utility classes.
+ **SLF4J** (http://www.slf4j.org/) : a unified logging API.
+ **Logback** (http://logback.qos.ch/) : a logging back-end for SLF4J.


Environment
===========
These environment variables must be set:

+ ``PATH`` (must include the JDK ``bin`` directory)
+ any environment variable required to check your license (see :ref:`Licensing Vortex Link`)