IDyOM Project

h1. Installation

h2. Prerequisites

h3. Common Lisp

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

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

h3. Common Lisp Libraries

* Common 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

These can be obtained using asdf-install, e.g.:

<pre>
(require 'asdf-install)
(asdf-install:install "clsql")
</pre>

h3. A SQL database

I would recommend "SQLite":http://www.sqlite.org/

See the "CLSQL Manual":http://clsql.b9.com/manual/ for further information on which database systems you can use and how to access them from Common Lisp.

h2. Installation

h3. Download the software Manual

* "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/amuse/idyom/archive/tip.zip

h3. Let lisp know where to find the software

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

<pre>
(require :asdf) ; Load asdf.
(push "/full/path/to/system/file" asdf:*central-registry*) ; Tell asdf where each system is registered.
</pre>

You may want to add these lines to your <code>.sbclrc</code> configuration file.

An easy way to achieve the above is to symlink each <code>.asd</code> file to a single directory and add that to <code>asdf:*central-registry*</code>.

h3. Automated

Alternatively there is software available for managing library installation for common lisp:

* "Quicklisp":http://www.quicklisp.org/
* "CLBuild":http://common-lisp.net/project/clbuild/
* "CLBuild2":http://gitorious.org/clbuild2

These may also be used to install the dependencies listed above. WARNING: your mileage may vary.

h3. Running the code

<pre>(asdf:oos 'asdf:load-op 'idyom)</pre>

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