IDyOM Project

h1. Installing and Loading IDyOM

{{>toc}}

h2. Summary

* Download "Steel Bank Common Lisp [SBCL]":http://www.sbcl.org/platform-table.html and "install":http://www.sbcl.org/getting.html

* Install Emacs ("see here for MacOS":http://emacsformacosx.com/)

* Install "Quicklisp":http://www.quicklisp.org/beta/, a library manager for Common Lisp: download "<code>quicklisp.lisp</code>":http://beta.quicklisp.org/quicklisp.lisp and follow the instructions "here":http://www.quicklisp.org/beta/

* (Optional) Install an SQL database - I recommend  "SQLite":http://www.sqlite.org/ which is already installed on most recent flavours of MacOS and Linux. See the "CLSQL Manual":http://clsql.b9.com/manual/ for information on other database systems you can use and how to access them from Common Lisp.

* Install and setup the IDyOM code itself

The following is a description of each of these steps tested on MacOS 10.7.5 and Ubuntu 14.04 (GNU/Linux 3.13.0-24-generic x86_64).

h2. Install SBCL

# download SBCL for MacOS X (the AMD64 version) here:

http://www.sbcl.org/platform-table.html

# on MacOS make sure you have the Xcode developer tools installed from the DVD that came with your Mac (required for GNU make)

# install SBCL by following the instructions here:

http://www.sbcl.org/getting.html

(Basically: unpack the downloaded tar.bz2 file, open a terminal window, 

change directory ('cd') into the unpacked directory and type 'sudo sh 

install.sh').

h2. Install Quicklisp

First download  "<code>quicklisp.lisp</code>":http://beta.quicklisp.org/quicklisp.lisp to a directory <code>DIR_A</code>. Then start SBCL by typing <code>sbcl</code> in a terminal window and install Quicklisp to another directory of your choice <code>DIR_B</code>:

<pre>

(load "/DIR_A/quicklisp.lisp")

(quicklisp-quickstart:install :path "/DIR_B/quicklisp/")

(ql:add-to-init-file)

(ql:quickload "quicklisp-slime-helper")

</pre>

Use the full pathnames for both directories (when run in the terminal, SBCL doesn't interpret shell substitutions like ~ for the home directory).

Remember to follow the instructions given by each of these commands (in particular the final command includes some lines of code to put in the emacs configuration file - usually called <code>.emacs</code> in your home directory). 

See the "Quicklisp website":http://beta.quicklisp.org/ for documentation about other features of Quicklisp.

h2. Download IDyOM

Download the IDyOM software, and unzip it into <code>DIR_B/quicklisp/local-projects/</code>

* "idyom":https://code.soundsoftware.ac.uk/hg/idyom/archive/tip.zip

*Removing previous installations*: *If* you have any previous installations of these libraries, you would do well to remove them, especially if they are in folders such as '~/.local' which are automatically scanned by asdf/quicklisp. You may also want to clear the corresponding entries from <code>asdf:*central-registry*</code> in your .sbclrc file, should any exist.

h2. Set <code>*idyom-root*</code>

IDyOM requires the global variable <code>*idyom-root*</code> be set to a suitable working directory, where it stores models, cross-validation settings, cached results etc. By default, this is a directory called 'idyom' in your home directory. Alternatively, you can customise the location by setting the variable <code>*idyom-root*</code> to point to the desired directory by including the following in your <code>.sbclrc</code> file, located in your home directory (you must restart SBCL for this to take effect):

<pre>

(defvar *idyom-root* "/FULL/PATH/TO/WORKING/DIR/")

</pre>

However you configure this, you must ensure that the directory exists (create it if it doesn't) and you will also need to create three directories below <code>*idyom-root*</code> for IDyOM to use: <code>*idyom-root*/data/cache/</code>, <code>data/models/</code> and <code>data/resampling/</code>.

h2. Install IDyOM

You can now use Quicklisp to install IDyOM:

<pre>

(ql:quickload "idyom")

</pre>

This will also install the third-party Lisp libraries IDyOM depends on.  

(If you get an error which brings up the debugger, press 2 [ACCEPT] and the installation should complete.)

h2. Create a database

IDyOM is now installed, but you will need a database in order to use it.  For example, to create an SQLite database called 'example.db' in directory <code>DIR</code>:

<pre>

(clsql:connect '("DIR/example.db") :if-exists :old :database-type :sqlite3)

</pre>

Alternatively, to connect to an existing local MySQL database:

<pre>

(clsql:connect '("localhost" "example-database" "username" "password") :if-exists :old :database-type :mysql)

</pre>

See the "CLSQL documentation":http://clsql.b9.com/manual/ for more on "connect":http://clsql.b9.com/manual/connect.html and "supported databases":http://clsql.b9.com/manual/prerequisites.html#idp8251808.

Finally, for a new database: 

<pre>

(mtp-admin:initialise-database)

</pre>

h3. Problems loading foreign libraries

Depending on how your system is configured, <code>clsql:connect</code> may give a "Couldn't load foreign libraries" error.  In this case, you

need to "tell CLSQL where it can find these libraries":http://clsql.b9.com/manual/appendix.html#foreignlibs, e.g.

<pre>

(clsql:push-library-path "/usr/local/mysql/lib/")

</pre>

The exact path will depend on your system.  Note that, for some database installations these libraries may not have been installed, and you should consult the database documentation.

h1. Starting IDyOM

Having [[Installation|installed IDyOM]], you can load the system by running Common Lisp and using <code>quickload</code>:

<pre>

(ql:quickload "idyom")

</pre>

You then need to reconnect to your database.  For example, if you have an SQLite database located at DIR/example.db then:

<pre>

(clsql:connect '("DIR/example.db") :if-exists :old :database-type :sqlite3)

</pre>

h2. Create a startup script [optional]

Every time you start IDyOM, you will need to connect to the database.  You may find it easier to combine all the startup commands and put them in the SBCL configuration file <code>.sbclrc</code> in your home directory. Here is my complete <code>.sbclrc</code> file:

<pre>

;;; The following lines added by ql:add-to-init-file:

#-quicklisp

(let ((quicklisp-init (merge-pathnames "quicklisp/setup.lisp"

                                       (user-homedir-pathname))))

  (when (probe-file quicklisp-init)

    (load quicklisp-init)))

;;; Load CLSQL by default

(ql:quickload "clsql")

;;; IDyOM

(defun start-idyom () 

  (defvar *idyom-root* "/Users/marcusp/idyom/")

  (ql:quickload "idyom")

  (clsql:connect '("/Users/marcusp/idyom/db/database-cents.sqlite") :if-exists :old :database-type :sqlite3))

</pre>

You will need to change the path and filenames. Then after starting Emacs and SBCL, you can just run <code>(start-idyom)</code> to load IDyOM and connect to the database.