NAME

Treex::Tutorial::Install - Installing the Treex NLP framework

VERSION

version 0.07297

TWO WAYS TO GET TREEX

You can download Treex from CPAN http://www.cpan.org or from the SVN repository. However, so far only the latter is usable, because only the core modules (Treex::Core) were released on CPAN and to do something interesting with Treex you need also some other modules.

Downloading and Installing Treex from CPAN

You can install Treex and its dependecies from shell using the cpan tool:

cpan Treex::Core

In future, there will be also distributions for the analysis (and synthesis) of several languages: Treex::EN for English, Treex::DE for German, Treex::CS for Czech etc.

Downloading and Installing Treex from SVN

Treex is being developed in TectoMT subversion repository. For read-only access you can use:

cd ~
svn --username public co https://svn.ms.mff.cuni.cz/svn/tectomt_devel/trunk tectomt
# password is "public"

Install the needed Perl modules dependencies:

cpan Moose MooseX::Getopt MooseX::NonMoose MooseX::Params::Validate\
     MooseX::SemiAffordanceAccessor Readonly Treex::PML\
     File::Slurp File::HomeDir File::Path File::ShareDir\
     LWP::Simple Data::Dumper Module::Reload Locale::Language\
     Parse::RecDescent Cwd Scalar::Util autodie String::Util

Add Treex modules to your $PERLLIB so perl can find them, and the treex script to your $PATH so you can execute it from shell. Add the following lines to your ~/.bashrc:

export TMT_ROOT=${HOME}/tectomt/
export PATH="${TMT_ROOT%/}/treex/bin:$PATH"
export PERL5LIB="${TMT_ROOT%/}/treex/lib:${TMT_ROOT%/}/libs/other:$PERL5LIB"
export PERLLIB=$PERL5LIB   

And source ~/.bashrc or open a new terminal. Check that it works by running:

treex -h 

Some Treex applications use huge pre-trained models, dictionaries etc. These resources are stored in an unversioned directory $TMT_ROOT/share and they should be automatically downloaded when running the respective application. You should create the empty directory or symlink.

mkdir $TMT_ROOT/share
#ln -s /mnt/my_big_disk/tectomt_share $TMT_ROOT/share

Similarly, some applications need a directory for temporary files.

ln -s /tmp $TMT_ROOT/tmp
#mkdir $TMT_ROOT/tmp

Installing other tools

TrEd

For visualization of trees it is beneficial to install TrEd from http://ufal.mff.cuni.cz/~pajas/tred. Install it to the $TMT_ROOT/share/tred directory (or symlink). Now you can check if you can run the Treex-modified version of TrEd:

ttred

XS-based perl modules

Morce is a high-quality part-of-speech tagger for English. You can install it by:

cd $TMT_ROOT/libs/packaged/Morce-English
less INSTALL
# follow the instruction in INSTALL

In the same way, you can install CzechMorpho and Morce-Czech (in this order).

AUTHOR

Martin Popel <popel@ufal.mff.cuni.cz>

COPYRIGHT AND LICENSE

Copyright © 2011 by Institute of Formal and Applied Linguistics, Charles University in Prague

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

cpanm Treex::Tutorial::Install

perl -MCPAN -e shell
install Treex::Tutorial::Install