ENIAM version 1.0
-----------------

ENIAM is a Categorial Syntactic-Semantic Parser for Polish

System requirements
-------------------

Linux, 64-bit processor, at least 4GB RAM

Install
-------

ENIAM requires OCaml version 4.01.0 compiler together with xml-light library.
It requires also graphviz package.

0. Install xml-light and graphviz, if they are not installed already.
1. Install xlib library. It should be provided in the file xlib-1.0.tar.gz 
2. Install Walenty dictionary.  It should be provided in the file walenty-20160412.tar.gz 
3. Compile parser:

cd pre
make 
cd ..
cd parser
make
cd ..

4. Check config file for compliance of paths.

Usage
-----

First, run pre server typing

cd pre
./pre &
cd ..

Then wait 4-10 minutes (depending on the machine) until it
finishes initialization, which will be marked by string
"Ready!" prompted in the console.

In order to parse a sentence "Ala ma kota." write:

cd parser
./eniam "Ala ma kota."

Note: output directory as well as parser settings may
be modified via editing a config file. Description of 
parser settings and output format is provided in the
documentation.

In order to parse a corpus using a distributed version of ENIAM:

./parser/eniam.distr file

where file contains a corpus in a format of sentences separated by a new line charater.
Number of parser processes is defined in config file.


Credits
-------
Copyright © 2016 Wojciech Jaworski <wjaworski atSPAMfree mimuw dot edu dot pl>
Copyright © 2016 Institute of Computer Science Polish Academy of Sciences

The parser uses the following licensed resources:

SGJP: Grammatical Dictionary of Polish, version 20151020
Copyright © 2007–2015 Zygmunt Saloni, Włodzimierz Gruszczyński, Marcin
Woliński, Robert Wołosz, Danuta Skowrońska
http://sgjp.pl

Walenty: The Polish Valence Dictionary, version 20150909
Copyright © 2016 Institute of Computer Science Polish Academy of Sciences 
http://zil.ipipan.waw.pl/Walenty

plWordNet 2.1 
Copyright © 2013 by Wrocław University of Technology 
http://plwordnet.pwr.wroc.pl/wordnet/

NKJP1M 1.2: The manually annotated 1-million word subcorpus of the National Corpus of Polish
Copyright © 2014 Institute of Computer Science Polish Academy of Sciences 
http://clip.ipipan.waw.pl/NationalCorpusOfPolish


Licence
-------

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
