IDyOM Project

h1. Installing IDyOM Installation

h2. Prerequisites

h3. Common Lisp

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


* "Quicklisp":http://www.quicklisp.org/beta/ is a library manager for Common Lisp. Just download "<code>quicklisp.lisp</code>":http://beta.quicklisp.org/quicklisp.lisp
* An SQL database. I would recommend "SQLite":http://www.sqlite.org/

Many people find "Emacs":http://www.gnu.org/software/emacs/ with "Slime":http://common-lisp.net/project/slime/ useful for Common Lisp development. Package management systems

h3. Common Lisp Libraries

* Common Lisp libraries:
** &quot;UFFI&quot;:http://uffi.bi.com
** &quot;CLSQL&quot;:http://clsql.b9.com
** &quot;CL-PPCRE&quot;:http://www.weitz.de/cl-ppcre/
** &quot;PS-Graph&quot;:http://www.cliki.net/psgraph
** &quot;Midi&quot;:http://www.cliki.net/midi

These can simplify the installation of these prerequisites, e.g. "Fink":http://www.finkproject.org/ or "Macports":http://www.macports.org/ for OS X. be obtained using asdf-install, e.g.:

&lt;pre&gt;
(require &#x27;asdf-install)
(asdf-install:install &quot;clsql&quot;)
&lt;/pre&gt;

h3. An SQL database

I would recommend &quot;SQLite&quot;:http://www.sqlite.org/

See the "CLSQL Manual":http://clsql.b9.com/manual/ for further information on other which database systems you can use and how to access them from Common Lisp. If you prefer not to use Quicklisp, you will need to install the following Lisp libraries: "UFFI":http://uffi.bi.com, "CLSQL":http://clsql.b9.com, "CL-PPCRE":http://www.weitz.de/cl-ppcre/, "PS-Graph":http://www.cliki.net/psgraph, "Midi":http://www.cliki.net/midi

h2. Install Quicklisp Installation

To install Quicklisp to a directory <code>DIR</code>, you need to load "<code>quicklisp.lisp</code>":http://beta.quicklisp.org/quicklisp.lisp in Lisp:

<pre>
(load "quicklisp.lisp")
(quicklisp-quickstart:install :path "DIR/quicklisp/")
(ql:add-to-init-file)
</pre>

h2. h3. Download IDyOM

Download the following zip files and unpack them into <code>DIR/quicklisp/local-projects/</code> software

* "MIPS":https://code.soundsoftware.ac.uk/hg/mips/archive/tip.zip
* "AMuSE":https://code.soundsoftware.ac.uk/hg/amuse/archive/tip.zip
* "amuse-viewpoints":https://code.soundsoftware.ac.uk/hg/amuse-viewpoints/archive/tip.zip
* "mtp-admin":https://code.soundsoftware.ac.uk/hg/mtp-admin/archive/tip.zip
* "ppm-star":https://code.soundsoftware.ac.uk/hg/ppm-star/archive/tip.zip
* "idyom":https://code.soundsoftware.ac.uk/hg/idyom/archive/tip.zip

h2. Load IDyOM

You can now use Quicklisp h3. Let lisp know where to load IDyOM, and install find the external Lisp libraries it depends on: software

Each subdirectory in the code contains one or more system definition files with a &lt;code&gt;.asd&lt;/code&gt; extension. The location of these files needs to be registered as follows:

<pre>
(require :asdf) ; Load asdf.
(push &quot;/full/path/to/system/file&quot; asdf:*central-registry*) ; Tell asdf where each system is registered.
(ql:quickload "idyom")
</pre>
The first time IDyOM is loaded, an error "There is no class named AMUSE-SEGMENTATION:GROUND-TRUTH-SEGMENTER"

You may bring up want to add these lines to your &lt;code&gt;.sbclrc&lt;/code&gt; configuration file so that they are automatically loaded.

An easy way to achieve the debugger. Press 2 [ACCEPT] above is to symlink each &lt;code&gt;.asd&lt;/code&gt; file to a single directory and the push this directory to &lt;code&gt;asdf:*central-registry*&lt;/code&gt; as shown above.

h3. Automated installation should complete.

h2. Create a database

IDyOM There is now installed, but you will need a database in order to use it. To create an SQLite database in directory <code>DIR</code>: software available for managing library installation for common lisp:

<pre> * &quot;Quicklisp&quot;:http://www.quicklisp.org/
(clsql:connect '("DIR/example.db") :if-exists :old :database-type :sqlite3) * &quot;CLBuild&quot;:http://common-lisp.net/project/clbuild/
(mtp-admin:initialise-database)
</pre> * &quot;CLBuild2&quot;:http://gitorious.org/clbuild2

which may also be used to install the dependencies listed above. WARNING: your mileage may vary using these tools.

h3. Running the code

&lt;pre&gt;(asdf:oos &#x27;asdf:load-op &#x27;idyom)&lt;/pre&gt;

should load the code. You may now proceed to the [[tutorial]].