This page gives some hints about the organisation of the package in directories and files.

Main directory files

AUTHORS

lists persons that contributed to the project

CMakeLists.txt

control file for CMake build system

CMakeLists.txt.user

(not part of the distribution) generated by Qt Creator if you're using it

HACKING

guidelines for editing files; 80 columns max is not enforced in actual code

LICENSE

Same text as in License page

marks.bzr

Helper for converting from Bazaar to Git (guess)

marks.git

Helper for converting from Bazaar to Git (guess)

opencog.spec

spec file for RPM package opencog

README.md

A high level overview of the project, various information

Vagrantfile

Control file for Vagrant. This is virtualization thechnology that runs on top of existing programs, allowing an easy set-up of the development environment.

doc directory

Documentation for various components is kept here.

examples directory

Example code using opencog.

include directory

(hack) has only one sub-directory (win32) with one file: getopt.h

lib directory

A number of cmake support files and other components (better name, anyone?).

opencog directory

Main source directory.

atomspace

has the sources for atomspace library and a tester program (atomspace_async target); a separate target is provided for opencog_atom_types; see its page

benchmark

this is tool developed by Joel Pitt, in order to assess the impact of changes to the AtomSpace API; it produces a single target - atomspace_bm

comboreduct

has comboreduct library and a host of executables in comboreduct/main; see its page

cycl-import (stub)

has a readme with infos about Lillybot - a prototype opencyc-chatbot

cython

Python bindings for OpenCog

dynamics

all mindagents involved with the dynamic evolution of the OpenCog system (only attention for now)

embodiment

Embodiment is a system of components for OpenCog that are designed to control an avatar.

guile

contains an implementation of the Scheme shell for the OpenCog server. Scheme is a dialect of Lisp; the shell allows scheme code to manipulate the contents of an OpenCog AtomSpace. The shell is implemented in guile.

haskell

Haskell bindings for OpenCog

implication (stub)

The goal of the ideas in this directory is to provide a more "human-friendly" way to write ImplicationLinks for many common usage scenarios.

learning

code that relate to learning; contains moses, pleasure

nlp

all code related to natural language processing code

persist

persistent storage; completed in various degrees for sql, xml, hypertable

python

a series of Python scripts to be used with the Gephi Graph Streaming Plugin

query

Query Processing/Pattern Matching - contains code that implements a subgraph isomorphism algorithm, and then uses this algorithm to support several functions, including query processing and a first-order-logic forward chainer

reasoning various reasoning and inference systems currently implemented in OpenCog. Currently this is only PLN, but in future this might include NARS and others.

scm

This repository contains assorted routines, written in scheme, for manipulating OpenCog atoms and systems, in various general ways

server

The CogServer provides a simple network shell server interface to the various functions in the opencog system.

shell

Basic shell interface and shells for scheme and Python

spacetime

space & time related code and atoms.

spatial

This module contains several tools for creating and managing a simplified representation of a given environment. MapTools is a tool that allows to "see" what the agent is perceiving in real time

util

Various code relevant to entire project; see its page

visualization

Graphics and Visualization Tools including gtk-visualizer, adapter for tulip, dotty, ubigraph

viterbi

This directory contains code pertaining to an experimental Viterbi parser for the Link Grammar dictionary.

web

The ocweb module implements a HTTP server that provides both a web GUI for navigating the AtomSpace and a REST API

scripts directory

Support scripts for various tasks.

tests directory

Source code for tests.

vagrant-configs directory

Contains a single file: vagrant-vm-setup.sh. It is run inside Vagrant virtual machine on the first run to install prerequisites and build the package.