The okapi-apps distribution contains:
For a list of changes since the previous release, please see the Changes Log document.
Note that parts of this project are still relatively new and still in development. Some of the classes, interfaces and internal workings presented here may change in the upcoming versions of the Okapi Framework.
lib |
All the files needed to run the Okapi libraries and applications. |
help |
The help files. |
config |
Various default configuration files (e.g. segmentation rules, additional filter configurations, etc.) |
dropins |
The directory where you can drop plug-ins. |
The latest version of all documents and help is always available on-line, at the Okapi Framework Web site.
In order to run the Okapi applications on Windows you must have a running installation of Java 11 or later. Sun Java, or an OpenJDK VM is recommended.
To install the Okapi applications on Windows (32- and 64-bit):
C:\Program
Files\Okapi
.To run Rainbow: simply double-click on the rainbow.exe
file
in the main folder.
You can also run the application with the following command line (assuming it has been unzipped in the recommended folder):
C:\>javaw -jar C:\Program Files\Okapi\lib\rainbow.jar
To run Tikal: double-click on the startTikalPrompt.bat
file. This will start a command prompt from where you can invoke Tikal
from any directory. If you want to run Tikal at any time, from anywhere,
you should add the directory where tikal.bat
is located in
the PATH of your system.
To uninstall:
.Rainbow
.In order to run the Okapi applications on Linux you must have a running installation of Java 1 or later. Sun Java, or an OpenJDK VM is recommended.
To install the Okapi applications on Linux (32- and 64-bit):
To run, for example, Rainbow: simply double-click on the rainbow.sh
file in the main directory.
You can also run the application from the command line (assuming Rainbow
is installed in \home\archie\okapi
):
archie@archie:~>java -jar okapi/lib/rainbow.jar
To uninstall:
.Rainbow
and .Ratel
.In order to run the Okapi applications on MacOS you must have Java 11
installed. You can verify your Java version from the Terminal using
java -version
To install the Okapi applications on MacOS:
Release builds are distributed as a signed DMG disk image.
Applications
folder.Snapshot builds are distributed as unsigned ZIP archives.
~/Desktop/Okapi
.Note: Because snapshot builds are unsigned, users on more recent versions of MacOS, particularly versions 10.12 (MacOS Sierra) and later, may have problems when running the applications. You work around this by relaxing the application security. From the Apple menu, choose 'System Preferences.../Security & Privacy/General'. You will see the application name that was prevented from launching. Click on the 'Open Anyway' button to launch the application.
For more information and help, please contact the Okapi Tools users group.
To run, for example, Rainbow:
Rainbow
application bundle (Rainbow.app): simply double-click on it.You can modify the shell file rainbow.sh
that is in the
/Applications/Contents/MacOS
folder of the application bundle to fit your own
parameters. In all cases you MUST specify the -XstartOnFirstThread
option or the application may not work properly.
Tikal is a command-line tool and should be invoked from a Terminal window.
To uninstall:
'rm -rf ~/.Rainbow ~/.Ratel'
If you have questions, suggestions or bug to report, you can do this different ways: