ResearchCyc

Formalized Common Knowledge

           
 

Home

Projects

FAQ

Documentation

Releases

 

Installation Instructions

NOTE:

  • As of January 2009, only Java-based releases of ResearchCyc software will be available.

System Requirements:

  • 2GB of RAM (the more, the better; the faster, the better)
  • ~6GB of swap space
  • A 64-bit OS
  • Java is required for creating the .redbin file
  • Java 1.5/64bit-only (latest release of Java 1.6 is preferred)

Download and Installation

Downloading the Software

You may download the Cyc software from either a command shell or via your Web browser:

In a command shell, type:

$ ftp ftp.cyc.com
User: 
Password: 
ftp> bin
ftp> cd ResearchCyc/java
ftp> ls  (to see the contents of this directory)
ftp> get filename.tgz 
  (where filename is the newest tgz file in this directory)
ftp> bye

OR In a Web browser:
  • Go to ftp://ftp.cyc.com/ResearchCyc/java/.
  • Click on the newest tgz file in this directory.
  • Enter your USERNAME and PASSWORD when they are requested" and hit OK.
  • Download and save the tgz file using your Web browser's file download facility.

Unpacking the Software

  • Copy the tar (.tgz) file to the directory in which you want to install ResearchCyc, cd to that directory, then type:
    $ tar -xvzf filename.tgz
    
  • OR use a compression utility such as 7-zip, gzip, winzip, ...

    A directory named 'cyc-SYS-KB' will be created, where SYS is the current Cyc system number and KB is the current KB number. (We will refer to this as the "Cyc root directory" in the instructions below.) This directory will contain a number of subdirectories as well as additional licensing information.

    Entering Your License Key

    You will need to enter your license key, which is unique to your site. The same license key may be used on multiple installations within your organization.

    • Go to the init subdirectory under the Cyc root directory.
    • Edit the jrtl-release-init.lisp file.
    • In the line that reads
      (csetq *master-license-key* "000-000-000-000-000")))
      
      replace the zeros with the license key you were sent when you obtained your ResearchCyc license.
    • Save this updated file.

    Running Cyc

    To run Cyc:
    • Go to the Cyc root directory.
    • From this directory, run the shell script appropriate to your environment, one of:
      • bin/run-cyc.sh
      • bin/run-cyc.bat
      • bin/run-cyc-32bit.bat

    After Cyc starts up, it will reach the CYC(1): prompt. You can then use the following URL in a browser to access Cyc on the machine cyc is running:

      http://localhost:3602/cgi-bin/cyccgi/cg?cb-start

    or on a remote machine, with Cyc running on, e.g., myserver.mydomain.edu:

        http://myserver.mydomain.edu:3602/cgi-bin/cyccgi/cg?cb-start

    • Cyc assumes a trusted environment, so you're responsible for running it from a machine where only authorized users will be able to link to it.

    • Use the login name 'CycAdministrator' to login. Then you can create new user accounts by creating new instances of #$HumanCyclist.


    If you have questions, send email to rcyc@cyc.com.

    Last Update: January 21, 2009