Installation » History » Version 16

Jeremy Gow, 2013-04-04 12:28 PM

1 7 Jeremy Gow
h1. Installing IDyOM
2 1 Marcus Pearce
3 1 Marcus Pearce
h2. Prerequisites
4 1 Marcus Pearce
5 2 Marcus Pearce
* "Steel Bank Common Lisp [SBCL]":http://www.sbcl.org/platform-table.html
6 7 Jeremy Gow
* "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
7 7 Jeremy Gow
* An SQL database.  I would recommend  "SQLite":http://www.sqlite.org/ 
8 1 Marcus Pearce
9 7 Jeremy Gow
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 can simplify the installation of these prerequisites, e.g. "Fink":http://www.finkproject.org/ or "Macports":http://www.macports.org/ for OS X.
10 2 Marcus Pearce
11 7 Jeremy Gow
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.  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
12 1 Marcus Pearce
13 7 Jeremy Gow
h2. Install Quicklisp
14 1 Marcus Pearce
15 7 Jeremy Gow
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:
16 1 Marcus Pearce
17 1 Marcus Pearce
<pre>
18 7 Jeremy Gow
(load "quicklisp.lisp")
19 7 Jeremy Gow
(quicklisp-quickstart:install :path "DIR/quicklisp/")
20 7 Jeremy Gow
(ql:add-to-init-file)
21 1 Marcus Pearce
</pre>
22 1 Marcus Pearce
23 7 Jeremy Gow
h2. Download IDyOM
24 1 Marcus Pearce
25 9 Jeremy Gow
Download the following Lisp libraries, and unzip them into <code>DIR/quicklisp/local-projects/</code>
26 2 Marcus Pearce
* "MIPS":https://code.soundsoftware.ac.uk/hg/mips/archive/tip.zip
27 1 Marcus Pearce
* "AMuSE":https://code.soundsoftware.ac.uk/hg/amuse/archive/tip.zip
28 2 Marcus Pearce
* "amuse-viewpoints":https://code.soundsoftware.ac.uk/hg/amuse-viewpoints/archive/tip.zip
29 1 Marcus Pearce
* "mtp-admin":https://code.soundsoftware.ac.uk/hg/mtp-admin/archive/tip.zip
30 1 Marcus Pearce
* "ppm-star":https://code.soundsoftware.ac.uk/hg/ppm-star/archive/tip.zip
31 1 Marcus Pearce
* "idyom":https://code.soundsoftware.ac.uk/hg/idyom/archive/tip.zip
32 1 Marcus Pearce
33 9 Jeremy Gow
The <code>local-projects</code> directory should now contain six subdirectories, one for each library.
34 9 Jeremy Gow
35 12 Jeremy Gow
h2. Set <code>*idyom-root*</code>
36 1 Marcus Pearce
37 14 Jeremy Gow
IDyOM requires the global variable <code>*idyom-root*</code> be set to a suitable working directory, where it can cache results etc.  One way to do this is to include the following in your the <code>.sbclrc</code> file, located in your home directory, and then restart SBCL:
38 1 Marcus Pearce
39 12 Jeremy Gow
<pre>
40 14 Jeremy Gow
(setq *idyom-root* "PATH/TO/WORKING/DIR/")
41 12 Jeremy Gow
</pre>
42 10 Jeremy Gow
43 16 Jeremy Gow
IDyOM will use this directory to store caches (<code>*idyom-root*/data/cache/</code>), models  (<code>data/cache/</code>) and resampling sets  (<code>data/resampling/</code>).
44 16 Jeremy Gow
45 1 Marcus Pearce
h2. Install IDyOM
46 7 Jeremy Gow
47 9 Jeremy Gow
You can now use Quicklisp to install IDyOM:
48 5 Marcus Pearce
<pre>
49 7 Jeremy Gow
(ql:quickload "idyom")
50 5 Marcus Pearce
</pre>
51 9 Jeremy Gow
This will also install the third-party Lisp libraries IDyOM depends on.  The first time it loads, you may get an error which brings up the debugger.  Press 2 [ACCEPT] and the installation should complete.
52 1 Marcus Pearce
53 7 Jeremy Gow
h2. Create a database
54 1 Marcus Pearce
55 7 Jeremy Gow
IDyOM is now installed, but you will need a database in order to use it.  To create an SQLite database in directory <code>DIR</code>:
56 5 Marcus Pearce
57 1 Marcus Pearce
<pre>
58 1 Marcus Pearce
(clsql:connect '("DIR/example.db") :if-exists :old :database-type :sqlite3)
59 8 Jeremy Gow
</pre>
60 8 Jeremy Gow
Alternatively, to connect to an existing local MySQL database:
61 8 Jeremy Gow
<pre>
62 8 Jeremy Gow
(clsql:connect '("localhost" "example-database" "username" "password") :if-exists :old :database-type :mysql)
63 8 Jeremy Gow
</pre>
64 8 Jeremy Gow
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.
65 8 Jeremy Gow
66 8 Jeremy Gow
Finally, for a new database: 
67 8 Jeremy Gow
<pre>
68 7 Jeremy Gow
(mtp-admin:initialise-database)
69 7 Jeremy Gow
</pre>
70 1 Marcus Pearce
71 1 Marcus Pearce
You may now proceed to the [[tutorial]].
72 8 Jeremy Gow
73 8 Jeremy Gow
h3. Problems loading foreign libraries
74 8 Jeremy Gow
75 8 Jeremy Gow
Depending on how your system is configured, <code>clsql:connect</code> may give a "Couldn't load foreign libraries" error.  In this case, you
76 8 Jeremy Gow
need to "tell CLSQL where it can find these libraries":http://clsql.b9.com/manual/appendix.html#foreignlibs, e.g.
77 8 Jeremy Gow
<pre>
78 8 Jeremy Gow
(clsql:push-library-path "/usr/local/mysql/lib/")
79 8 Jeremy Gow
</pre>
80 9 Jeremy Gow
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.
81 10 Jeremy Gow
82 10 Jeremy Gow
83 1 Marcus Pearce
h2. Create a startup script [optional]
84 1 Marcus Pearce
85 11 Jeremy Gow
Every time you start IDyOM, you will need to connect to the database.  You may find it easier to combine all the startup commands in a single script, e.g.
86 11 Jeremy Gow
87 11 Jeremy Gow
<pre>
88 11 Jeremy Gow
(ql:quickload "idyom")
89 11 Jeremy Gow
(clsql:push-library-path "/usr/local/mysql/lib/")
90 15 Jeremy Gow
(defun connect-example ()
91 11 Jeremy Gow
  (clsql:connect '("DIR/example.db") :if-exists :old :database-type :sqlite3))
92 11 Jeremy Gow
</pre>