Installation
Karma is a Web-based application. You can run Karma on a single machine, running both the server and the client on the same machine (this is the usual way to run Karma). You can also install Karma on a server and use it on different machines.
Karma is written in Java and will run on Mac, Linux and Windows. To install Karma you need:
- Java
- Maven
- An internet connection so that Maven can download the needed libraries
- A Web browser: we recommend Safari or Firefox, but Karma will also run on Internet Explorer.
If you are new to GitHub and just want to download Karma, then get the zip file: https://github.com/InformationIntegrationGroup/Web-Karma-Public/archive/master.zip. If you know GitHub, you know that you can also clone the repository.
You need to compile Karma, but this is easy to do with Maven:
- Unpack your zip file in whatever directory you want (use one that you can easily get to from your command line).
- Open a shell (command prompt) and go to the directory where you put Karma.
- On the shell prompt type
mvn jetty:run. This will compile and run Karma. It may take a couple of minutes the first time because maven will download many libraries (you need an internet connection for this to work). If all goes well the last line in your your shell will say[INFO] Started Jetty Server - Note: you only need an internet connection to compile Karma after you download it. Once it is compiled, you can run it without an internet connection.
To run Karma:
- Start the server part by typing
mvn jetty:runin the shell (command prompt). - Wait until you see the
[INFO] Started Jetty Serverin the shell. - Open a Web Browser and go to page
http://localhost:8080/web-karma.html. Note: once the server is running, you can also reload the Karma web page to start a fresh copy of Karma.
You should see a page that looks like this (your version number will be different):
Now that you know your Karma installation is working, you may want to configure it so that you can work with large sources without running out of memory, load ontologies automatically and understand where Karma saves your files. See Configuration.
By default, Karma runs on port 8080.
You can specify the port number in the command to start the Jetty server as in
mvn -Djetty.port=9999 jetty:run
The following warnings are normal and we have yet to eliminate them. If you see them, they are expected (your help fixing these would be greatly appreciated):
[WARNING]
[WARNING] Some problems were encountered while building the effective model for edu.isi:webkarma:war:0.0.1-SNAPSHOT
[WARNING] 'dependencies.dependency.systemPath' for weka:weka:jar should not point at files within the project directory, ${project.basedir}/lib/weka.jar will be unresolvable by dependent projects @ line 100, column 18
[WARNING] 'dependencies.dependency.(groupId:artifactId:type:classifier)' must be unique: com.healthmarketscience.jackcess:jackcess:jar -> version 1.2.10 vs 1.2.4 @ line 176, column 21
[WARNING] 'dependencies.dependency.systemPath' for uk.ac.shef.wit.simmetrics:simmetrics:jar should not point at files within the project directory, ${project.basedir}/lib/simmetrics_jar_v1_6_2_d07_02_07.jar will be unresolvable by dependent projects @ line 242, column 19
[WARNING] 'dependencies.dependency.systemPath' for com.jspsmart.upload:jspsmartupload:jar should not point at files within the project directory, ${project.basedir}/lib/jsmartupload.jar will be unresolvable by dependent projects @ line 259, column 19
[WARNING] 'build.plugins.plugin.version' for org.apache.maven.plugins:maven-compiler-plugin is missing. @ line 374, column 16
[WARNING]
[WARNING] It is highly recommended to fix these problems because they threaten the stability of your build.
[WARNING]
[WARNING] For this reason, future Maven versions might no longer support building such malformed projects.
[WARNING]
The following warning is also normal:
2013-05-13 23:31:17.278:INFO:oejs.Server:jetty-8.0.3.v20111011
2013-05-13 23:31:19.202:INFO:oejpw.PlusConfiguration:No Transaction manager found - if your webapp requires one, please configure one.