Okapi-Pack

Centre For Interactive Systems Research
City University
London EC1V 0BH


Appendix I: "okapi" Configuration Files.

<OKAPI_ROOT>/.okapi_rc

    Any variable ending in "_DEBUG" refers to a debugging flag for C/C++ function.
    Setting any of these to 1 will cause some debugging information to be printed by the
    appropriate function.


    ##   <OKAPI_ROOT>/.okapi_rc
    ##  
    ##   Okapi GUI parameter file. Calls tcl gui procedure.
    ##
    ##   Debugging flags for C/C++ functions
    ##
    ##   0 = FALSE, 1 = TRUE

    set   env(ADD_TO_BIGR_SET_DEBUG) 0
    set   env(ADD_TO_SEEN_SET_DEBUG) 0
    set   env(BSS_SEARCH_DEBUG) 0
    set   env(BUILD_HITLIST_DEBUG) 1
    set   env(CHECK_FOR_PARAGRAPH_FILE_DEBUG) 0
    set   env(CHECK_USER_RELS_DEBUG) 0
    set   env(CLEAR_RF_DEBUG) 0
    set   env(CONSTRUCT_DOCLENGTH_FIELD_DEBUG) 0
    set   env(CONSTRUCT_TITLE_DEBUG) 0
    set   env(DB_SEARCH_DEBUG) 0
    set   env(DETERMINE_DOC_LENGTH_DEBUG) 0
    set   env(DISPLAY_DEBUG) 0
    set   env(EXTRACT_TERMS_DEBUG) 0
    set   env(FIND_DOCSET_DEBUG) 0
    set   env(MAKE_REL_DEBUG) 0
    set   env(MAKERJ_DEBUG) 0
    set   env(PARSE_HEADER_DEBUG) 1
    set   env(READ_ENV_DEBUG) 0
    set   env(READ_PARAMETER_FILES_DEBUG) 0
    set   env(REMOVE_FROM_BIGR_SET_DEBUG) 0
    set   env(SET_LR_THRESHOLD_DEBUG) 0
    set   env(SET_RSV_FACTOR_DEBUG) 0
    set   env(SET_ENV_DEBUG) 0
    set   env(SHOW_DEBUG) 0
    set   env(TERM_ENTRY_DEBUG) 0
    set   env(TERM_INPUT_DEBUG) 0
    set   env(TERM_OCCURRENCE_DEBUG) 0
    set   env(UPDATE_USER_RELS_DEBUG) 0
    set   env(WRITE_RELS_FILE_DEBUG) 0
    set   env(WRITE_TERMSET_FILE_DEBUG) 0
    set   env(WRITE_USER_TERMS_DEBUG) 0

    ##   Read HOME directory into home_dir and USER into userid
    ##

    set   home_dir $env(HOME)
    set   userid $env(USER)

    ##   rf_flag = [ 0 | 1 ]
    ##  
    ##   0 => relevance feedback off
    ##   1 => relevance feedback on

    set rf_flag 1

    ##   MAX_TERMSET_SIZE determines the size of the structure in
    ##   which okapi stores user-entered and extracted terms.

    set   env(MAX_TERMSET_SIZE) 2048
    set   env(MAX_TERMS_PER_DOC) 3000
    set   env(MAX_RELS) 256

    ##   Maximum document (or passage) length to show user
    ##

    set   env(DOC_THRESHOLD) 102400

    ##   Maximum number of characters in hitlist title

    set   env(MAX_TITLE_CHARS) 256

    ##   Parameters to determine entry to query for extracted terms
    ##

    set   env(RSV_FACTOR) 0.67
    set   env(LR_THRESHOLD) 2

    set   env(MAX_RECS_TO_SHOW) 50

    ##   BSS Parameters
    ##  
    ##   Weighting
    ##

    set   env(WEIGHT_FUNCTION) 2
    set   env(RLOAD) 4
    set   env(BIGRLOAD) 5

    set   env(DEFAULT_OP) "bm25"
    set   env(PASSAGE_OP) "bm250"

    ##   BOTH_PHRASE_OPS determines whether user-defined phrases
    ##   are adjacencies only or a combination of adjacencies and
    ##   same sentence occurrence of query terms.
    ##   0 = adjacencies
    ##   1 = adjacencies and same sentence occurrence.

    set   env(BOTH_PHRASE_OPS) 1

    ##   BSS Passage search parameters
    ##

    set   env(P_UNIT) 6
    set   env(P_STEP) 2
    set   env(BM250_AND) "and2"
    set   env(K1) 1.6
    set   env(BM25B) 0.7
    set   env(BM_TARGET) 1000

    ##   BSS show formats
    ##

    set   env(HEADER_SHOW_FORMAT) 260
    set   env(PASSAGE_SHOW_FORMAT) 259
    set   env(FINAL_SHOW_FORMAT) 2

    ##   'show' pagesize in chars
    ##

    set   env(CHARS_PER_PAGE) 2000
    set   env(HYPHEN_POS) 3

    ##   Set up database environment variables
    ##

    set   env(BSS_TEMPPATH) "/tmp"
    set   env(BSS_PARMPATH) "/project/okapi/okapi-pack/databases"
    set   env(BSS_PASSAGE_AVEDOCLEN) 2500
    set   env(QUERY_WINDOW_WIDTH) 20

    set   env(MAIN_FRAME_X) 1000
    set   env(MAIN_FRAME_Y) 675

    set   env(OFFSET_X) 440
    set   env(OFFSET_Y) 1080

    set   main_frame_geometry "1000x675+400+200"

    set   OKAPI_TCL_SCRIPTS_DIR "/project/okapi/okapi-pack/interface/tcl"

    ##   set OKAPI(TITLE) ""
    ##   set OKAPI(IR_QUERY) ""
    ##   set OKAPI(IR_HIT) ""
    ##   set OKAPI(IR_DOC) ""
    ##   set OKAPI(IR_TERM) ""

    set   auto_path [ linsert $auto_path 0 $OKAPI_TCL_SCRIPTS_DIR ]

    ##   -- global variables
    ##

    set   wvar ""

    ##  
    ##   Set up profiles_dir
    ##

    set   profiles_dir "$home_dir/Profiles"

    set   db_name ""
    set   query ""
    set   profile_name "$userid"
    set   terms ""
    set   text ""

    set   intro_query_terms_title "Working Query"
    set   working_query_terms_title "Working Query"

    set   removed_terms_title "Removed / Dropped Out"
    set   hitlist_title "Document Hitlist"
    set   rels_title "Relevant Documents"
    set   full_title "Okapi - City University, London"

    set   Label1 "To enter a query type:"
    set   Label2 "(a) one or more words, or"
    set   Label3 "(b) one phrase ending in a + sign,"
    set   Label4 "then press return"

    set   Label5 "To add terms to the query type:"

    set   TermEntryLabel_1 "$Label1 $Label2 $Label3 $Label4"
    set   TermEntryLabel_2 "$Label5 $Label2 $Label3 $Label4"

    ##  
    ##   Starting the application:
    ##

    gui



    ##   <OKAPI_ROOT>/.okapi_db
    ##  
    ##   Contains a list of databases that may be accessed by okapi.
    ##   The first one in the list will be opened when okapi is run.
    ##

    cacm.sample
    med.sample
    mydatabase.test


Okapi-Pack Main Menu Mail Okapi Support Registration



Last modified:   12th November 2001