.. _preparation:

=============
 Preparation
=============

Installing |project|
====================

There are currently two ways to install the |version| version of
|project|:

* Binary downloads (only for :ref:`tools <tools>`)
* Debian packages
* From source

Binary Downloads of |project| Tools
-----------------------------------

#. Download the |main_binary| binary from the appropriate location:

   * `Linux i686 <https://ci.cor-lab.de/job/rosetta-tools-cl-trunk/label=ubuntu_lucid_32bit/>`_
   * `Linux x86_64 <https://ci.cor-lab.de/job/rosetta-tools-cl-trunk/label=ubuntu_lucid_64bit/>`_
   * `MacOS x86_64 <https://ci.cor-lab.de/job/rosetta-tools-cl-trunk/label=MAC_OS_lion_64bit/>`_
   * `Windows 7 i686 <https://ci.cor-lab.de/job/rosetta-tools-cl-trunk-windows/label=192.168.100.120>`_

#. After the download, the |main_binary| file has to be made
   executable in most cases. This can be done for example by executing

   .. code-block:: sh

      chmod +x rosetta

   in the download directory.

#. The various tools are provided as `symbolic links
   <http://en.wikipedia.org/wiki/Symbolic_link>`_ to the single
   |main_binary| binary. When invoked, it prints a list of these links
   and offers to create them:

   .. code-block:: sh

      $ ./rosetta
      [...]
      Create missing links now [yes/no]? y
      Creating symbolic link info -> rosseta
      [...]

   .. note::

      The links can also be created as follows:

      Non-interactively

        .. code-block:: sh

           $ ./rosetta create-links

      Manually

        .. code-block:: sh

           $ for alias in info bridge compiler ; do ln -s rosetta ${alias} ; done

From Source
-----------

Supported Lisp Implementations
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Currently, only recent versions (e.g. 1.0.55 or newer) of `SBCL`_ are
fully supported.

Required Infrastructure
~~~~~~~~~~~~~~~~~~~~~~~

* `ASDF`_ is used for compilation, loading and dependency management
* `Quicklisp`_ is used for installation of dependencies

External Dependencies
~~~~~~~~~~~~~~~~~~~~~

==================== ========================= ===============
System               Required                  Obtainable From
==================== ========================= ===============
alexandria           yes                       Quicklisp
split-sequence       yes                       Quicklisp
iterate              yes                       Quicklisp
metabang-bind        yes                       Quicklisp
bordeaux-threads     yes                       Quicklisp
closer-mop           yes                       Quicklisp
log5                 yes                       Quicklisp
puri                 yes                       Quicklisp
uuid                 yes                       Quicklisp
local-time           yes                       Quicklisp
cl-hooks             yes                       Quicklisp
cl-dynamic-classes   yes                       |repository_versioned|/cl/cl-dynamic-classes/
==================== ========================= ===============

Installation
~~~~~~~~~~~~

#. Download other required systems:

   * ``cl-hooks``

     .. code-block:: sh

        bzr branch lp:cl-hooks

#. The whole source tree of |project| can be obtained from the
   repository located at |repository_versioned|.

#. Load ``cl-rosetta`` with `Quicklisp`_ to pull in remaining dependencies

   .. code-block:: cl

      (ql:quickload :cl-rosetta)

Debian Packages
---------------

Debian packages for several versions of |ubuntu| are available from
the `CoR-Lab package repository
<http://packages.cor-lab.de/ubuntu/dists/>`_.

#. The following repository source line has to be added to
   ``/etc/apt/sources.list``::

     deb http://packages.cor-lab.de/ubuntu/ RELEASENAME testing

   where :samp:`RELEASENAME` is the appropriate Ubuntu release name.

#. After that, packages can be installed via

   .. code-block:: sh

      $ sudo apt-get install PACKAGENAMES

   where :samp:`{PACKAGENAMES}` is a subset of |package_names|.

.. warning::

   This installation method only works with |ubuntu|.

.. note::

   More information can be found `here
   <https://support.cor-lab.org/projects/ciserver/wiki/RepositoryUsage>`_.

.. _troubleshooting:

Troubleshooting
===============

No problems yet.