README

Japanese

                            apertium-jpn
===============================================================================

This is an Apertium monolingual language package for Japanese. It was started as a final project for LING 073 at Swarthmore College in the spring of 2017.  More information can be found here: https://wikis.swarthmore.edu/ling073/User:Doldham1/Final_project#Evaluation

What you can use this language package for:

* Morphological analysis of Japanese
* Morphological generation of Japanese
* Part-of-speech tagging of Japanese

Requirements
===============================================================================

You will need the following software installed:

* lttoolbox (>= 3.3.0)
* apertium (>= 3.3.0)
* vislcg3 (>= 0.9.9.10297)
* hfst (>= 3.8.2)
* MeCab with ipa dictionary (>= 0.996)

If this does not make any sense, we recommend you look at: apertium.org

Compiling
===============================================================================

Given the requirements being installed, you should be able to just run:

$ ./configure
$ make

You can use ./autogen.sh instead of ./configure if you're compiling
from SVN.

If you're doing development, you don't have to install the data, you
can use it directly from this directory.

If you are installing this language package as a prerequisite for an
Apertium translation pair, then do (typically as root / with sudo):

# make install

You can give a --prefix to ./configure to install as a non-root user,
but make sure to use the same prefix when installing the translation
pair and any other language packages.

Testing
===============================================================================

If you are in the source directory after running make, the following
commands should work:

$  echo "TODO: test sentence" | apertium -d . jpn-morph
TODO: test analysis result

$ echo "TODO: test sentence" | apertium -d . jpn-tagger
TODO: test tagger result

For C++, 
$ g++ `mecab-config --cflags` buffer_mecab.cpp  `mecab-config --libs`
$ ./a.out | hfst-proc jpn.automorf.hfst
$ "TODO: test sentence"

Files and data
===============================================================================

* apertium-jpn.jpn.dix           - Monolingual dictionary
* apertium-jpn.jpn.lexc          - Morphotactic dictionary
* apertium-jpn.jpn.twol          - Morphophonological rules
* apertium-jpn.jpn.rlx           - Constraint Grammar disambiguation rules
* apertium-jpn.post-jpn.dix      - Post-generator
* jpn.prob                       - Tagger model
* modes.xml                      - Translation modes
* tokenize.py                    - Tokeniser
* buffer_mecab.cpp               - C++ Tokenizer
For more information
===============================================================================

* https://wiki.apertium.org/wiki/Installation
* https://wiki.apertium.org/wiki/apertium-jpn
* https://wiki.apertium.org/wiki/Using_an_lttoolbox_dictionary

Help and support
===============================================================================

If you need help using this language pair or data, you can contact:

* Mailing list: apertium-stuff@lists.sourceforge.net
* IRC: #apertium on irc.oftc.net

See also the file AUTHORS included in this distribution.