README.md 4.62 KB
Newer Older
Markus Krug's avatar
Markus Krug committed
1
Repository for ATHEN (Annotation and Text Highlighting Environment!
Markus Krug's avatar
Markus Krug committed
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
===================


What is it?
---------------
ATHEN is an Annotation Environment based on Eclipse4 RCP. In its core it uses UIMA and allows the editing of .xmi -text documents as well as unnanotated .txt documents. (Other formats will be supported by version 1.0 but are currently unsupported)

It allows to assign a multitude of different stylings for your types and allows the creation and changing of annotation of thelike. 
It supports the creation of Apache Lucene Indexes, based on UIMA annotations to be able to query your corpus and get a quick insight into your analysis rules.

On top there is special support in ATHEN for editing Named Entities, Coreferences, Scenes and direct speech.
On top there is a view that supports an OWL-based information extraction and ontology creation.

ATHEN was built to support novel-sized documents and should therefore be relatively efficient for huge documents.

Markus Krug's avatar
Markus Krug committed
17 18 19
Download
-------
To download the newst version of ATHEN, just select the according .zip for your platform and download it:
Markus Krug's avatar
Markus Krug committed
20

Markus Krug's avatar
Markus Krug committed
21
http://ki.informatik.uni-wuerzburg.de/nappi/release/
Markus Krug's avatar
Markus Krug committed
22

Markus Krug's avatar
Markus Krug committed
23 24 25
it contains an executable that launches ATHEN, if you want to build it from source you should follow the **Installation from source** section

Installation from source
Markus Krug's avatar
Markus Krug committed
26 27 28 29 30 31 32 33 34 35 36
-------------
Download or clone the master branch

```
git clone https://gitlab2.informatik.uni-wuerzburg.de/mak28ma/Athen_maven.git
```
The next step requires you to have Maven available and installed. Switch to the main directory
"de.uniwue.mk.athen"  and execute in the command line
```
mvn clean install 
```
Markus Krug's avatar
Markus Krug committed
37
**NOTE:(This requires you to have Java 8 and a Maven Version newer than 3.05)**
Markus Krug's avatar
Markus Krug committed
38 39 40 41 42 43 44 45 46
this will download all requirements by accessing different software sites, make sure you got a stable internet connection.

After the build (which can take a few minutes if you build it for the first time) you can find executables for your platform in the folder:
```
de.uniwue.mk.athen\releng\de.uniwue.mk.athen.product\target\products\de.uniwue.mkrug.kallimachos.athen
```

Launch your according executable.

Markus Krug's avatar
Markus Krug committed
47 48
**Note: if you cannot build it and just want a made executable, just contact me: markus.krug@uni-wuerzburg.de **

Markus Krug's avatar
Markus Krug committed
49
Introduction to the functionality of ATHEN and Tutorials!
Markus Krug's avatar
Markus Krug committed
50
-------------
Markus Krug's avatar
Markus Krug committed
51
[ [Tutorial] ATHEN -First time use](de.uniwue.mk.athen/releng/de.uniwue.mk.athen.docu/ATHEN_core.md)
Markus Krug's avatar
Markus Krug committed
52

Markus Krug's avatar
Markus Krug committed
53
[ [Tutorial] ATHEN -Labelling Syntactic Parsing](de.uniwue.mk.athen/releng/de.uniwue.mk.athen.docu/ATHEN_syntacticParsing.md)
Markus Krug's avatar
Markus Krug committed
54

Markus Krug's avatar
Markus Krug committed
55
[ [Prcoess description] ATHEN -Rule based ontology driven Information Extraction](de.uniwue.mk.athen/releng/de.uniwue.mk.athen.docu/ATHEN_ontologyBasedIE.md)
Markus Krug's avatar
Markus Krug committed
56

Markus Krug's avatar
Markus Krug committed
57
[ [Tutorial] ATHEN -Switch workspace](de.uniwue.mk.athen/releng/de.uniwue.mk.athen.docu/ATHEN_switchWS.md)
Markus Krug's avatar
Markus Krug committed
58

Markus Krug's avatar
Markus Krug committed
59 60
[ [Tutorial] ATHEN -Import data](de.uniwue.mk.athen/releng/de.uniwue.mk.athen.docu/ATHEN_importData.md)

Markus Krug's avatar
Markus Krug committed
61 62
[ [Tutorial] ATHEN -Annotating Coreferences and Character References](de.uniwue.mk.athen/releng/de.uniwue.mk.athen.docu/CorefView.md)

Markus Krug's avatar
Markus Krug committed
63 64
[ [Tutorial] ATHEN -Annotating Direct Speech, including Speaker and Addressee](de.uniwue.mk.athen/releng/de.uniwue.mk.athen.docu/DSAnnotatingView.md)

Markus Krug's avatar
Markus Krug committed
65 66
[ [Tutorial] ATHEN -Comparing Annotations](de.uniwue.mk.athen/releng/de.uniwue.mk.athen.docu/ATHEN_goldstandard.md)

tu's avatar
tu committed
67
[ [Tutorial] ATHEN -Annotating Speech-, Thought- and Writing Representation (STWR)](de.uniwue.mk.athen/releng/de.uniwue.mk.athen.docu/STWRView.md)
Markus Krug's avatar
Markus Krug committed
68 69 70 71 72 73

Utility of ATHEN
-------
Even though there is still a lot of work in progress, ATHEN comes with a bunch of utility, read the according instructions if you want to know how they work:

[ [Instruction] ATHEN -Index your XMI documents with Lucene](de.uniwue.mk.athen/releng/de.uniwue.mk.athen.docu/ATHEN_luceneView.md)
Markus Krug's avatar
Markus Krug committed
74

Markus Krug's avatar
Markus Krug committed
75
**TODO - Converting Documents between formats in ATHEN**
Markus Krug's avatar
Markus Krug committed
76

Markus Krug's avatar
Markus Krug committed
77 78 79 80 81 82 83
**TODO - Preprocessing documents in ATHEN with Nappi**

Extending ATHEN
-------------
ATHEN is written as a eclipse 4 RCP Application, which means it is based on plugins that can be loaded dynamically at runtime. Currently ATHEN supports the loading of
a new view for the annotation perspective while ATHEN is running. If you need to know how this works, please contact me.

Markus Krug's avatar
Markus Krug committed
84 85
If you are interested in extending the functionality of ATHEN you should consider reading the [developer handbook](https://gitlab2.informatik.uni-wuerzburg.de/kallimachos/Athen/wikis/developer-handbook) of ATHEN

Markus Krug's avatar
Markus Krug committed
86

Markus Krug's avatar
Markus Krug committed
87 88 89 90

Troubleshooting and contact
-----
If problems occur you can check
Markus Krug's avatar
Markus Krug committed
91
[ATHEN -troubleshooting](de.uniwue.mk.athen/releng/de.uniwue.mk.athen.docu/ATHEN_troubleshooting.md)
Markus Krug's avatar
Markus Krug committed
92 93 94

and see whether your problem is known and has a workaround. If not you should contact us at:
<athen@informatik.uni-wuerzburg.de>