Installation Instructions

Please see Hardware and Software Requirements before installing the ResearchCyc software.

NOTE: Starting with release 9b, it is necessary to run a setup routine as part of the installation process that prompts for a license key. If you have not received a license key, please send email to rcyc@cyc.com.

System Requirements:

Java is required for creating the .redbin file

Selecting the Appropriate Software Version

To access ResearchCyc (a.k.a. "RCyc") releases, download and extract the appropriate version for your platform. Installation bundles come in two types and four flavors.

Types

The two types are:

Full Installations (incl additional programs, SDKs, etc)
Minimal Installations (the bare minimum to run RCyc)

Types can be distinguished by their names (# =[0-9]):

Full Installations:
- researchcyc-#.#-*
- rcyc-#.#rc##-*
Minimal Installations:

rcyc-*

Because of the maintenance-release flavor that minimal installations have, they are more frequently released than full installations are. Typically, minimal installations will be more up-to-date in terms of KB contents and bug-fixes.

Flavors

> The four flavors are:

Linux-only installations
Microsoft Win32-only installations
Java 1.5 [or higher] 64bit-only installations
multi-flavor installations

Flavors can be distinguished by the directory location:

linux => Linux-only
win32 => Win32-only
java => Java 1.5/64bit-only
shared => multi-flavor

Notice that not every release need contain all flavors.

Linux Download and Installation

At a command line:

$ ftp ftp.cyc.com
User: 
Password: 
ftp> bin
ftp> cd ResearchCyc
ftp> get filename.tgz 
ftp> bye

Copy the tar (.tgz) file to the directory in which you want to install RCyc, cd to that directory, then type:
```
$ tar -xvzf filename.tgz
```

A directory named 'researchcyc-1.0' will be created, which will contain 6 directories: api, client, server, documentation, licenses, and scripts. It also contains a README.txt file that has instructions that may be more accurate than these. You need to first run a setup script that prompts you for the license key. After that, you will be able to run cyc. First, type the following two commands:

$ cd scripts/license
$ ./make-cyc-license-key.sh

NOTE: Java is needed to run the setup script.

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

If this process completes successfully, a file named 'cyc-license-key.redbin' will be created in the scripts/license directory as well as the server/cyc/run/repository directory. You will not need to do anything with this file.

You only need to run setup once per installation. Subsequently, you can just run cyc as directed below.

Now you can move to the 'scripts' directory to run RCyc.

$ cd ..
$ ./run-cyc.sh

This script which runs the Cyc executable using the default settings. The first invocation will build a 'world' file for your machine that will make subsequent invocations much faster. This process takes 15-45 minutes.

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.

Windows Download and Installation

At a command line:

$ ftp ftp.cyc.com
User: 
Password: 
ftp> bin
ftp> cd ResearchCyc
ftp> get filename.zip 
ftp> bye

Copy the zip file to the directory in which you want to install RCyc, cd to that directory, and run the zip file to extract the contents to that directory.

Follow the instructions in the README file to activate your copy of Cyc using your license key and to create a Cyc world image file.
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.

Click here for information about older releases.

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

Last Update: May 3, 2006