Installation » History » Version 82

Marcus Pearce, 2016-04-18 11:42 AM

1 47 Marcus Pearce
h1. Installing IDyOM and its prerequisites
2 1 Marcus Pearce
3 46 Marcus Pearce
{{>toc}}
4 1 Marcus Pearce
5 46 Marcus Pearce
h2. Summary
6 1 Marcus Pearce
7 50 Marcus Pearce
# Download "Steel Bank Common Lisp [SBCL]":http://www.sbcl.org/platform-table.html and "install it":http://www.sbcl.org/getting.html
8 61 Marcus Pearce
# Install Emacs ("available here for MacOS":http://emacsformacosx.com/)
9 61 Marcus Pearce
# 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/#installation)
10 50 Marcus Pearce
# (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.
11 50 Marcus Pearce
# Install and setup the IDyOM code itself
12 1 Marcus Pearce
13 60 Marcus Pearce
The following is a detailed 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). It has been successfully installed on Windows following the same basic steps but I don't have a Windows machine to test the detailed instructions.
14 46 Marcus Pearce
15 51 Marcus Pearce
h2. 1. Install SBCL
16 46 Marcus Pearce
17 66 Marcus Pearce
# download SBCL for your OS and processor (e.g., for MacOS 10, choose the AMD64 version) here: http://www.sbcl.org/platform-table.html
18 46 Marcus Pearce
# on MacOS make sure you have the Xcode developer tools installed from the DVD that came with your Mac (required for GNU make)
19 49 Marcus Pearce
# 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 (<code>cd</code>) into the unpacked directory and type <code>sudo sh install.sh</code>).
20 1 Marcus Pearce
21 51 Marcus Pearce
h2. 2. Download and install Emacs
22 47 Marcus Pearce
23 47 Marcus Pearce
MacOS: Universal binaries available here: http://emacsformacosx.com/
24 47 Marcus Pearce
Linux: <code>sudo apt-get install emacs</code>
25 47 Marcus Pearce
26 51 Marcus Pearce
h2. 3. Install Quicklisp
27 47 Marcus Pearce
28 65 Marcus Pearce
*NB:* the full, original instructions are here http://www.quicklisp.org/beta/#installation. The following is my summary.
29 65 Marcus Pearce
30 47 Marcus Pearce
# make a new folder in your home directory called 'quicklisp'
31 47 Marcus Pearce
# download the file http://beta.quicklisp.org/quicklisp.lisp and put it into the new folder
32 47 Marcus Pearce
# open a terminal window and type 'sbcl' to start sbcl
33 47 Marcus Pearce
# type each of the following lines followed by enter, changing the path to match the location of your quicklisp folder:
34 1 Marcus Pearce
<pre>
35 1 Marcus Pearce
(load "/Users/marcusp/quicklisp/quicklisp.lisp")
36 47 Marcus Pearce
(quicklisp-quickstart:install :path "/Users/marcusp/quicklisp/")
37 47 Marcus Pearce
(ql:add-to-init-file)
38 47 Marcus Pearce
(ql:quickload "quicklisp-slime-helper")
39 49 Marcus Pearce
</pre>
40 77 Marcus Pearce
# Remember to follow the instructions given by each of these commands. *In particular*, the final command prints some lines of code to copy and paste into the emacs configuration file called <code>.emacs</code> in your home directory. You must create this file and it is best to use Emacs as other text editors (e.g., TextEdit on MacOS) automatically insert non-ascii characters such as 'smart quotes' which won't work (see [[Troubleshooting]]). Also remember to replace "sbcl" with the full path to the SBCL program (e.g., "/usr/local/bin/sbcl" by default on MacOS and Linux). 
41 64 Marcus Pearce
<pre>
42 64 Marcus Pearce
To use, add this to your ~/.emacs:
43 64 Marcus Pearce
44 64 Marcus Pearce
  (load (expand-file-name "~/quicklisp/slime-helper.el"))
45 75 Marcus Pearce
  ;; Replace "sbcl" with the path to the SBCL program
46 64 Marcus Pearce
  (setq inferior-lisp-program "sbcl")
47 64 Marcus Pearce
</pre>
48 47 Marcus Pearce
# open (or restart) Emacs, press Alt-x and type slime - you should now be running SBCL from within Emacs
49 1 Marcus Pearce
50 52 Marcus Pearce
h2. 4. Install an SQL database
51 1 Marcus Pearce
52 52 Marcus Pearce
MacOS: No action required, Sqlite is already installed (unless you prefer a different database system, see below).
53 57 Marcus Pearce
Linux: <code>sudo apt-get install sqlite</code>
54 52 Marcus Pearce
55 52 Marcus Pearce
h2. 5. Install IDyOM
56 52 Marcus Pearce
57 79 Marcus Pearce
# download the latest release of the IDyOM code from the "downloads page":https://code.soundsoftware.ac.uk/projects/idyom-project/files 
58 47 Marcus Pearce
# unzip the zip file into the folder 'local-projects' within the 'quicklisp' folder (e.g., '/Users/marcusp/quicklisp/local-projects/')
59 82 Marcus Pearce
# *(Only required for releases prior to v1.1. In later versions, these directories are created the first time they are accessed when the code is run.)* create a folder in your home directory called 'idyom'. Within that folder make two further folders, one called 'db', the other called 'data'. Within the 'data' folder make three further folders called 'cache', 'models' and 'resampling'.
60 1 Marcus Pearce
# using Emacs or another text editor open the file called '.sbclrc' in your home directory and add the following lines to the end of the file (the file should already have some lisp code in it), changing the paths to match the location of the 'idyom' folder you created in step 3:
61 47 Marcus Pearce
<pre>
62 47 Marcus Pearce
;;; Load CLSQL by default
63 47 Marcus Pearce
(ql:quickload "clsql")
64 1 Marcus Pearce
65 47 Marcus Pearce
;;; IDyOM
66 47 Marcus Pearce
(defun start-idyom ()
67 47 Marcus Pearce
   (defvar *idyom-root* "/Users/marcusp/idyom/")
68 47 Marcus Pearce
   (ql:quickload "idyom")
69 63 Marcus Pearce
   (clsql:connect '("/Users/marcusp/idyom/db/database.sqlite") :if-exists :old :database-type :sqlite3))
70 47 Marcus Pearce
</pre>
71 81 Marcus Pearce
# Restart Emacs, run Slime again (<code>Alt-x slime</code>) and type <code>(start-idyom)</code> at the prompt, <code>CL-USER></code>, to load IDyOM. The first time you run this, it will also download all the required third-party lisp libraries. See the "Troubleshooting page":https://code.soundsoftware.ac.uk/projects/idyom-project/wiki/Troubleshooting#Problems-loading-foreign-database-libraries if you have a problem connecting to the database.
72 47 Marcus Pearce
# The first time you run IDyOM, you must initialise the database by issuing the following command at the prompt (<code>CL-USER></code>):
73 8 Jeremy Gow
<pre>
74 80 Marcus Pearce
(idyom-db:initialise-database)
75 8 Jeremy Gow
</pre>
76 47 Marcus Pearce
NB: if you run this command later it will delete all the contents of your database, so only run it once.
77 8 Jeremy Gow
78 47 Marcus Pearce
h1. Starting IDyOM
79 1 Marcus Pearce
80 47 Marcus Pearce
Having installed IDyOM as described above, you can start it by:
81 47 Marcus Pearce
82 50 Marcus Pearce
# launching Emacs
83 44 Marcus Pearce
# typing <code>Alt-x slime</code>
84 47 Marcus Pearce
# entering <code>(start-idyom)</code> at the Lisp prompt, <code>CL-USER></code>