cl-semantic

How to Install What You Need To Get Working (It's Not That Hard, Really)

To Hang Out With Us You Will Need

1) Download Protege 3.1.1 (build 216) from Stanford University (link)
2) Download the OWL-QL toolkit (link)
3) Read a little bit about SWRL.
4) Download a Common Lisp distribution (Allegro or SBCL are talked about on this page)
5) Follow the directions to either setup Allegro or setup SBCL to load the Lisp packages talked about below.
5) Obviously, you will also need to check-out cl-semantic.

You will also need to download the following Lisp packages:

1) Download Wilbur Semantic Web Toolkit for CLOS (link)
2) Download Cells 2.0, A dataflow extension to CLOS (link)
3) Download S-XML, a simple XML parser implemented in Common Lisp (link)
4) Download LTK, a Common Lisp binding for the Tk graphics toolkit (link)

NOTE: About commercial and crippled binaries:

No one is impressed with the state of commercial Lisp distributions regarding their desire to cripple their use for evaluation purposes. Both Franz's Allegro and LispWorks limit your heap size during development, which may cause problems if you are running or developing the full application which require large symbol processing functions to run. However, there are many open source Common Lisp implementations that are slower, but will work without restrictions (CLISP, SBCL). However, we still talk about Allegro since many research environments and universities have this product, and they have an extremely good distribution with very few restrictions for evaluation. We do not talk about LispWorks. We believe their restrictions such as closing the IDE after 5 hours of use, not allow loading of init scripts or the use of (require :asdf) in their listener for evaluation versions (which our project makes heavy use of to load various requirements for this project) are amazingly over the top. Our belief is that LispWorks is too restrictive to the Lisp community for development purposes, and we do not support using LispWorks. If you have LispWorks Professional, you may use these installation instructions and modify them to fit your environment. We do discuss using Emacs with SLIME for a good (but by no means perfect) editing and building environment.

NOTE: About using SBCL on Mac OSX (10.x):

You can use SBCL on Mac OSX from both the command line and visually, but you probably don't want to at this moment. SBCL throws a SIGSEGV at every stracktrace, and Apple's Crash Reporter looks for these events at the kernel level and opens a Crash Reporter process. When being used visually, SBCL will give you a dialogue box displaying this issue. However, when you run SBCL from the command line or even in the REPL in interactive mode (like you do in Emacs with SLIME), every compile will trigger an Apple Crash Reporter process. This means that after one hour of development you could have 30 or 40 crash reporters launched on your system without any visual indication. Since SBCL developers are aware of the problem, but have not patched the SBCL distribution, we do not recommend or support using SBCL in development on Mac OSX. You can still do it, but keep your Activity Viewer open.

How To Setup Your Environment Using Allegro

Download Franz Allegro Evaluation

You may download the evaluation version of Allegro here. If you are a student, we strongly recommend you purchase the $99 student version available here. Regardless of what path you choose, or if you have access to an Allegro version from your work or university, you will want to follow the installation steps available from Franz's website. We believe this documentation is pretty self-explanitory, so we will not re-hash it here. If you have any problems contact the cl-semantic's development group.

Create a Repository Site

The next thing you will want to do is to change in to the directory you have installed Allegro (or any other directory you choose) and create a registry directory. For our purposes, we will call this directory "registry".

Next, go download all of the dependencies we use for cl-semantic (including cl-semantic itself) and put the un-compressed directories in to your registry directory.

After you have moved all your dependencies (including cl-semantic) in to your registry directory, we are going to do something to make our lives easier and create links to the .asd file in each of the distributions to the main registry directory. This allows us to easily load and compile these dependencies without having to set our registry location each time.

Do this for each dependency listed above. After you have completed this, it's time to tell Allegro about this directory and it will instinctively compile all of this code for you and generate .fasl files for you so that the compiled code will load faster the next time you require it.

IMPORTANT NOTE ABOUT FASL FILES:

Please keep in mind that these compiles are not compatible across Lisp implementations, even though all distributions generate .fasl files and all distributions use Common Lisp as the standard. There are just too many differences between implementations for any cross distribution compatibility. This is important because it means you cannot take this registry and later move it in to your SBCL registry and expect it to run. Your implementation will be smart enough to ask you in the stack trace if you wish to recompile your .lisp files, but you will be prompted for each file in each registry. It is best to keep this directory, before compile, zipped and backed up so you can move this across your lisp distributions.

Include Your registry Directory And Add The Dependencies To Your Environment

It is best if you do the compilation of the resources for the first time in the REPL interactive environment since you can respond and react to any stack traces that may occur and decide the best course of action. After you have generated your fasl files, loading these requirements in your code again will be faster and re-compile (except cl-semantic which you will be developing) will not be necessary.

The first thing you need to do is tell your Lisp environment where you've made your registry.

You will get the response

Now, it's show time. The way Allegro wants you to include asdf resources is a little cryptic vs. SBCL, which hooks the asdf in to REQUIRE for you, but after you understand what's it's doing it makes a lot more sense to you.

For each dependency, call the package like this:

How To Load Your Dependencies Again Later

Since you're (not cross implementation remember) .fasl files are now created, Allegro will know to load those instead of compiling the .lisp files the next time around. Simply use the same convention as before, but this time the load time will be much faster. You will want to automate all these loads in your SLIME or init file in your home directory.

How To Automatically Setup Your Dependencies and Environment In Your Home Directory

It will take exactly one time for you to get bored of loading all your dependencies and setting up your environment every time you launch Allegro. Luckly, both Allegro and SBCL (see below) have the ability to setup your environment from a file in your home directory. To do this, simply create a file in your home directory called ".clinit.cl" and add your requirements and your asdf dependencies in there. An example file is below.

Dive In To the Code

After you've done all of the loading, you can simply start using cl-semantic (and then start developing it with us) by switching to the cl-semantic package

Remember to be careful in the package, this is where we are developing the language model so some things just might not work like you expect.

That's it! Now poke around and break things!

(written by Brandon Werner) - Please email with corrections! (back to top)

How To Setup Your Environment Using SBCL

Download SBCL

You may download SBCL for your particular platform here. Most platforms and architectures are supported. If you have any problems contact the cl-semantic's development group. Installation diirections can be found here.

Create a Repository Site

The next thing you will want to do is to change in to the directory you have installed SBCL in (or any other directory you choose) and create a registry directory. For our purposes, we will call this directory "registry".

Next, go download all of the dependencies we use for cl-semantic (including cl-semantic itself) and put the un-compressed directories in to your registry directory.

After you have moved all your dependencies (including cl-semantic) in to your registry directory, we are going to do something to make our lives easier and create links to the .asd file in each of the distributions to the main registry directory. This allows us to easily load and compile these dependencies without having to set our registry location each time.

Do this for each dependency listed above. After you have completed this, it's time to tell SBCL about this directory and it will instinctively compile all of this code for you and generate .fasl files for you so that the compiled code will load faster the next time you require it.

IMPORTANT NOTE ABOUT FASL FILES:

Please keep in mind that these compiles are not compatible across Lisp implementations, even though all distributions generate .fasl files and all distributions use Common Lisp as the standard. There are just too many differences between implementations for any cross distribution compatibility. This is important because it means you cannot take this registry and later move it in to your Allegro registry and expect it to run. Your implementation will be smart enough to ask you in the stack trace if you wish to recompile your .lisp files, but you will be prompted for each file in each registry. It is best to keep this directory, before compile, zipped and backed up so you can move this across your lisp distributions.

Include Your registry Directory And Add The Dependencies To Your Environment

It is best if you do the compilation of the resources for the first time in the REPL interactive environment since you can respond and react to any stack traces that may occur and decide the best course of action. After you have generated your fasl files, loading these requirements in your code again will be faster and re-compile (except cl-semantic which you will be developing) will not be necessary.

The first thing you need to do is tell your Lisp environment where you've made your registry.

You will get the response

Now, it's show time. The way SBCL wants you to include asdf resources is a lot easier vs. Allegro, because SBCLhooks the asdf in to REQUIRE for you.

For each dependency, call the package like this:

NOTE: ABOUT SBCL & CELLS 2.0 DEPENDENCY

We've had reports of compiling cells 2.0 with SBCL having problems. If this happens, check either the cells site or this site for more information on how to work around it. You can just skip it, depending on what part of the cl-semantic project you are working on.

How To Load Your Dependencies Again Later

Since you're (not cross implementation remember) .fasl files are now created, Allegro will know to load those instead of compiling the .lisp files the next time around. Simply use the same convention as before, but this time the load time will be much faster. You will want to automate all these loads in your SLIME or init file in your home directory.

How To Automatically Setup Your Dependencies and Environment In Your Home Directory

It will take exactly one time for you to get bored of loading all your dependencies and setting up your environment every time you launch SBCL. Luckly, both Allegro and SBCL (see above) have the ability to setup your environment from a file in your home directory. To do this, simply create a file in your home directory called ".sbclrc" and add your requirements and your asdf dependencies in there. An example file is below.

NOTE: How To Make Your SBCL Look Like Allegro's REPL

A lot of people love Allegro's REPL environment, and after SBCL 0.9.9.1.1, you can easily make your REPL environment in SBCL look like Allegro. Just add the following lines somewhere in your ".sblrc" file discussed above.

Dive In To the Code

After you've done all of the loading, you can simply start using cl-semantic (and then start developing it with us) by switching to the cl-semantic package

Remember to be careful in the package, this is where we are developing the language model so some things just might not work like you expect.

That's it! Now poke around and break things!

(written by Brandon Werner) - Please email with corrections! (back to top)

How To Use Slime/Emacs As Your Editor

TODO: Write this

How To Check Out The Project

Project Members

Project members will want to make their lives easier by enabling automatic authentication to the common-lisp.net server using ssh keys and using Emacs built-in CVS ability. This is required because it will make everyone more productive and code management much easier. If you are a project member and don't know how to create keys and add them to rhe common-lisp.net server environment, just email the managers and let them know.

Non-Project Members and The Morbidly Curious

If you are looking for a release of cl-semantic, try the release page for an easiy to load version. If you want to see the code and the development environment, just use the command below.

CVS Access

You can browse our CVS repositories as the project progresses. You may also send an email to Brandon Werner to request to join the project and help us out.

Back to Common-lisp.net.