Downloading the Core API Suite

Source code

The source code for the Core API Suite is available in the CycCoreAPI project on GitHub.

Requirements

  • JDK 1.7 or greater to build; code can be run on Java 6.
  • Apache Maven, version 3.2 or higher. If you are new to Maven, you may wish to view the quick start.

The following Cyc server releases are supported:

For information about acquiring a supported Cyc server, see the Cyc download page.

Downloading

Apache Maven

The Core Client requires the Core API spec to be present on the classpath. To use them in a Maven project, add the following dependencies to your pom.xml:

<dependency>
  <!-- Core API specification -->
  <groupId>com.cyc</groupId>
  <artifactId>cyc-core-api</artifactId>
  <version>1.0.0-rc5</version>
</dependency>
<dependency>
  <!-- Reference implementation for the Core API -->
  <groupId>com.cyc</groupId>
  <artifactId>cyc-core-client-impl</artifactId>
  <version>1.0.0-rc5</version>
  <scope>runtime</scope>
</dependency>

The Core APIs use SLF4J for logging, so you may also wish to specify a logging implementation. E.g., for Log4J:

<dependency>
  <groupId>org.slf4j</groupId>
  <artifactId>slf4j-log4j12</artifactId>
  <version>1.7.12</version>
</dependency>
<dependency>
  <groupId>log4j</groupId>
  <artifactId>log4j</artifactId>
  <version>1.2.17</version>
</dependency>

Standalone Bundle

If you’re not using Apache Maven, or can’t allow Maven to retrieve dependencies from the Internet, you may download this release in a standalone bundle containing:

  • A compiled cyc-core-suite-1.0.0-rc5-jar-with-dependencies.jar
  • A CoreAPITests project containing the source code for all of the unit tests from the Core API Suite, and the dependencies necessary to run them. This project may be run in Maven or as a native Eclipse project.
  • The CycCoreAPI source code (requires Maven to compile)
  • The core-api-use-cases source code (requires Maven to compile)

The bundle is available from the releases page as a tar or zip file:

  • cyc-core-suite-standalone-1.0.0-rc5.tar.gz
  • cyc-core-suite-standalone-1.0.0-rc5.zip

Building the Sources

To build this project from source, see CycCoreAPI on GitHub and following the instructions in the README.

Example Usage

Once you have the Core API Suite, you may wish to download the Cyc API Examples repository and explore the sample code in the core-api-use-cases project. Or, view online code samples on this site.

Acquiring Cyc

For information about acquiring a supported Cyc server, see the Cyc download page.