Installation » History » Version 38
Marcus Pearce, 2013-07-15 03:21 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 | 27 | Marcus Pearce | |
14 | 7 | Jeremy Gow | h2. Install Quicklisp |
15 | 1 | Marcus Pearce | |
16 | 22 | Jeremy Gow | First download "<code>quicklisp.lisp</code>":http://beta.quicklisp.org/quicklisp.lisp to a directory <code>DIR_A</code>. You can then install Quicklisp to another directory of your choice <code>DIR_B</code>: |
17 | 1 | Marcus Pearce | |
18 | 1 | Marcus Pearce | <pre> |
19 | 22 | Jeremy Gow | (load "/DIR_A/quicklisp.lisp") |
20 | 22 | Jeremy Gow | (quicklisp-quickstart:install :path "/DIR_B/quicklisp/") |
21 | 1 | Marcus Pearce | (ql:add-to-init-file) |
22 | 1 | Marcus Pearce | </pre> |
23 | 22 | Jeremy Gow | |
24 | 26 | Marcus Pearce | Use the full pathnames for both directories (Lisp doesn't interpret shell substitutions like ~ for the home directory). |
25 | 1 | Marcus Pearce | |
26 | 32 | Marcus Pearce | See the "Quicklisp website":http://beta.quicklisp.org/ for documentation about other features of Quicklisp. |
27 | 32 | Marcus Pearce | |
28 | 7 | Jeremy Gow | h2. Download IDyOM |
29 | 1 | Marcus Pearce | |
30 | 9 | Jeremy Gow | Download the following Lisp libraries, and unzip them into <code>DIR/quicklisp/local-projects/</code> |
31 | 1 | Marcus Pearce | |
32 | 36 | Marcus Pearce | * "idyom":https://code.soundsoftware.ac.uk/hg/idyom/archive/tip.zip |
33 | 9 | Jeremy Gow | |
34 | 34 | Marcus Pearce | *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. |
35 | 34 | Marcus Pearce | |
36 | 12 | Jeremy Gow | h2. Set <code>*idyom-root*</code> |
37 | 1 | Marcus Pearce | |
38 | 28 | Marcus Pearce | 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): |
39 | 21 | Jeremy Gow | |
40 | 1 | Marcus Pearce | <pre> |
41 | 29 | Marcus Pearce | (defvar *idyom-root* "/FULL/PATH/TO/WORKING/DIR/") |
42 | 1 | Marcus Pearce | </pre> |
43 | 28 | Marcus Pearce | |
44 | 10 | Jeremy Gow | 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>. |
45 | 16 | Jeremy Gow | |
46 | 1 | Marcus Pearce | h2. Install IDyOM |
47 | 7 | Jeremy Gow | |
48 | 9 | Jeremy Gow | You can now use Quicklisp to install IDyOM: |
49 | 31 | Marcus Pearce | |
50 | 5 | Marcus Pearce | <pre> |
51 | 7 | Jeremy Gow | (ql:quickload "idyom") |
52 | 1 | Marcus Pearce | </pre> |
53 | 31 | Marcus Pearce | |
54 | 31 | Marcus Pearce | This will also install the third-party Lisp libraries IDyOM depends on. |
55 | 31 | Marcus Pearce | |
56 | 31 | Marcus Pearce | (If you get an error which brings up the debugger, press 2 [ACCEPT] and the installation should complete.) |
57 | 1 | Marcus Pearce | |
58 | 7 | Jeremy Gow | h2. Create a database |
59 | 1 | Marcus Pearce | |
60 | 30 | Marcus Pearce | 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>: |
61 | 5 | Marcus Pearce | |
62 | 1 | Marcus Pearce | <pre> |
63 | 1 | Marcus Pearce | (clsql:connect '("DIR/example.db") :if-exists :old :database-type :sqlite3) |
64 | 8 | Jeremy Gow | </pre> |
65 | 8 | Jeremy Gow | Alternatively, to connect to an existing local MySQL database: |
66 | 8 | Jeremy Gow | <pre> |
67 | 8 | Jeremy Gow | (clsql:connect '("localhost" "example-database" "username" "password") :if-exists :old :database-type :mysql) |
68 | 8 | Jeremy Gow | </pre> |
69 | 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. |
70 | 8 | Jeremy Gow | |
71 | 8 | Jeremy Gow | Finally, for a new database: |
72 | 8 | Jeremy Gow | <pre> |
73 | 7 | Jeremy Gow | (mtp-admin:initialise-database) |
74 | 7 | Jeremy Gow | </pre> |
75 | 1 | Marcus Pearce | |
76 | 8 | Jeremy Gow | |
77 | 8 | Jeremy Gow | h3. Problems loading foreign libraries |
78 | 8 | Jeremy Gow | |
79 | 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 |
80 | 8 | Jeremy Gow | need to "tell CLSQL where it can find these libraries":http://clsql.b9.com/manual/appendix.html#foreignlibs, e.g. |
81 | 8 | Jeremy Gow | <pre> |
82 | 8 | Jeremy Gow | (clsql:push-library-path "/usr/local/mysql/lib/") |
83 | 8 | Jeremy Gow | </pre> |
84 | 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. |