README.md 1.63 KB
Newer Older
Romana Pernischova's avatar
Romana Pernischova committed
1
2
3
4
5
6
7
8
9
# Change and Impact Visualization (CHIMP) Plugin

This repository contains code for the Protégé desktop plugin.

### Prerequisites

To build and run the plugin, the following items must be installed:

+ Apache's [Maven](http://maven.apache.org/index.html).
Romana Pernischova's avatar
Romana Pernischova committed
10

Romana Pernischova's avatar
Romana Pernischova committed
11
12
13
+ A Protégé distribution (5.0.0 or higher).  The Protégé 5.5.0 release is [available](http://protege.stanford.edu/products.php#desktop-protege) from the main Protégé website.

You can also download a pre-build jar of the plugin under Releases and place it in the Protégé Plugin folder (instructions are available on the Protégé website).
Romana Pernischova's avatar
Romana Pernischova committed
14

Romana Pernischova's avatar
Romana Pernischova committed
15

Romana Pernischova's avatar
Romana Pernischova committed
16
17
18
19
20
21
22
23
24
25
26
27
### Build

1. In the chimp-plugin directory:

        mvn clean package
    
2. On build completion, the "target" directory will contain a chimp-plugin${version}.jar file.

3. Copy the JAR file from the target directory to the "plugins" subdirectory of your Protege distribution.
 
### View the Plugin in Protégé

Romana Pernischova's avatar
Romana Pernischova committed
28

Romana Pernischova's avatar
Romana Pernischova committed
29
1. Launch your Protégé distribution.
Romana Pernischova's avatar
Romana Pernischova committed
30
31
32
33
34
35
36
37
38
39

2. Window > Views > Ontology views > ChImp (Change Impact)

3. Select About from the Help menu to verify successful installation

### Develop

#### Setup

1. Download the project:
Romana Pernischova's avatar
Romana Pernischova committed
40

Romana Pernischova's avatar
Romana Pernischova committed
41
        git clone git@gitlab.ifi.uzh.ch:DDIS-Public/chimp-protege-plugin.git
Romana Pernischova's avatar
Romana Pernischova committed
42

Romana Pernischova's avatar
Romana Pernischova committed
43
44
45
46
47
48
49
50
51
52
53
54
55
56
        
2. Open up in an IDE: Intellij works best.

3. Ensure that Maven is available

4. Setup runtime configuration

    Arguments: clean package
    
    Runtime: Use a JDK instead of a JRE
    
#### Dependencies

The Maven POM file in the top-level directory defines how the [Maven Bundle Plugin](http://felix.apache.org/site/apache-felix-maven-bundle-plugin-bnd.html) packages the plug-in code into the required OSGi bundle format.
Mirko Serbak's avatar
init  
Mirko Serbak committed
57