###############################################################
OMCSNet v1.3.1 Knowledge Browser and Commonsense Inference API for Python/Java
###############################################################
#
# Author: Hugo Liu <hugo@media.mit.edu> and Push Singh <push@media.mit.edu>
# Project Page: <http://web.media.mit.edu/~hugo/omcsnet>
# 
# Copyright (c) 2002-2003 by Hugo Liu, Push Singh, MIT Media Lab
# MontyTagger and MontyLingua Copyright (c) 2002-2003 by Hugo Liu, MIT Media Lab
#
# Use is granted under the GNU General Public License (GPL):
# <http://www.gnu.org/licenses/gpl.html>
#
# #####################
# OMCSNet's Python API 
# #####################
#   1) is accessible via OMCSNetAPI
#   2) for more gritty access, try OMCSNetTools and OMCSNetFast
#   3) to run the knowledge browser, type "python OMCSNetBrowser.py" from the command line
#   4) OMCSNET_DATA.* files are optimized versions of OMCSNet knowledge
#      - if you have an updated "predicates.txt" or "semanticnet.txt" file
#        then delete OMCSNET_DATA.* and run OMCSNetBrowser
#        you will be prompted to regenerate the data files (takes 1-2 hours)
#   5) to access the part-of-speech tagger, MontyTagger, use MontyTagger.py
#
# #####################
# OMCSNet's Java API
# #####################
# 
#   1) JAVA-based API
#        - callable as follows (see Example.java):
#           a) put the omcsnet.jar on the classpath
#           b) import the omcsnet.JOMCSNetAPI in your java code
#           c) call any of the following functions:
#             public String find_analogous_nodes(String nodename)
#             public String find_analogous_nodes_simple(String nodename)
#             public String find_paths_from_a_to_b(String node1name, String node2name)
#             public String get_context(String comma_delimited_nodelist)
#             public String get_context_simple(String comma_delimited_nodelist)
#             public String get_edges_by_origin_nodename(String nodename)
#             public String get_edges_by_origin_nodename_simple(String nodename)
#             public String get_edges_by_destination_nodename(String nodename)
#             public String get_edges_by_destination_nodename_simple(String nodename)
#           (for more details, visit the python source code for JOMCSNetAPI and OMCSNetAPI
#   2) JAVA-based knowledge browser
#       - type "run.bat" from the command line
#
#   3) MontyTagger, a part-of-speech tagger is also included
#       - to call from command line, type "java -cp omcsnet.jar omcsnet.MontyTagger"
#       - to call from code, the following functions work:
#            public String tag(String untagged_text)
#            public String tag_tokenized(String tokenized_text)
# 
# ######################
# OMCSNet Browser Documentation
# ######################
#
# The OMCSNet Browser allows for the following functionality
#  1) Lookup a concept - type a concept into the "lookup" field and press enter
#      - Tip: concepts in omcsnet are lemmatised, so try looking up 
#             verbs using the root form, and nouns using singular form
#  2) Finding the context around a concept(s) - type a concept name into
#     the "lookup" field and click "context".
#      - Tip: to find the context intersection of multiple concepts, try typing
#             multiple concepts in, separated by a comma.
#  3) Finding analogous concepts - type a concept name into the "lookup" field
#     and click "analogous" to find analogous/related concepts via structure mapping
#  4) Find paths between concepts - type the starting concept into the "lookup" field
#     and the ending concept into the "find path" field and press enter in this field
#
#  JAVA-based knowledge browser and API have only been tested under windows
#
# ###################
#  VERSION HISTORY:
# ###################
#
#   Bugfixed version 1.3.1 (25 Nov 2003)
#     - datafiles can now sit in the current working directory (".")
#       or in the path of either of the "PATH" environment variable
#     - fixed bug which prevented correct functioning of two concurrent instances of OMCSNet
#     - compatibility with MontyLingua resolved (must use MontyLingua version 1.3.1 or higher)
# 
#   New in Version 1.2 (11 Aug 2003)
#     - lisp-style predicates.txt input added
#     - java API released
#   
#   New in Version 1.0 (9 May 2003)
#     - MontyTagger added to OMCSNet Toolkit
#     - first public release
# 
#   New in Version 0.2 (10 Aug 2002)
#     - OMCSNet high-level python API released
#     - version developed for MAS.964 class final projects
#
#   New in Version 0.1 (29 Mar 2002)
#     - Commonsense Robust Inference System (CRIS), a component of 
#       CS ARIA by hugo@media, is renamed to OMCSNet