NATools - How to Install

back

NATools is only available as a C and Perl source package. You can download it from this site: http://natura.di.uminho.pt/download/TGZ/NATools/. So, this means you need a computer system with a C compiler, the Perl interpreter with default modules, and related tools as make, bash and others.

If you are installing on Unix, Linux or MacOS X you should have all this software installed or in the system installation disks. If you are using Windows I strongly advice to install cygwin.

Supposing you are in a Unix-like system or you had installed cygwin, follows the process of installation for NATools.

If you find any problem installing or find some bug on this document, please contact me (see the contact information in the NATools package).

Dependencies

NATools use a set of different Perl modules. You should install them before trying to compile NATools. Fortunately, Perl has an installation shell which helps you with this task. It should be available on your system as the command line tool cpan or, ir not, running perl -MCPAN -e shell. Run it as superuser (root).

You should be prompted for configuration details in case you are running this command for the first time. Then, you will get a prompt where you can issue installation commands:

      cpan> install Lingua::PT::PLNbase
    
where the module to be installed (in this case, Lingua::PT::PLNbase) follows the install command.

Proceed with the installation for the following modules:

Configuring the package

Uncompress the package. If you are under Windows, do not use WinZip or WinRar, as they change file contents!. Use gzip and tar as in unix systems:

       tar zxvf NATools-x.x.x.tar.gz
       cd NATools-x.x.x
    
Then, configure the package running the configure shell script.
       ./configure
    
and take some attention to the output produced. It will test for your system configuration as well as modules dependencies. If you have problems installing NATools send me always the configure output.

Compiling

NATools is an hybrid application, written in C for efficiency, and in Perl for flexibility. So, the package must compile the C portions before being installed.

To compile, just issue the make command. If its compilation fails, and you can't figure out what is the problem, contact me. Do not forget to send the configure output as well as the output for the make command.

Testing the package

NATools include a set of tests so you can verify if your compilation went ok. It will align some toy corpora and perform some tests on it. Just enter the make check command.

Installing the package

If everything goes alright, you can now install the NATools package. You just need to run the make install command as superuser.

Installing CGIs

NATools web interface needs to be installed in a CGI-Bin enabler directory from your web-server. If you do not know what this means, contact your system administrator.

NATools cgis are in the NAT/cgis directory. You need to copy files nat-about.cgi, nat-dict.cgi, nat-matrix.cgi and nat-search.cgi to the CGI-Bin directory. Also, for usability, we suggest you to add a link from nat-search.cgi to nat, thus you can just access with your browser the nat file, instead of nat-search.cgi. Note that in some web-servers, you need to specify that you allow links for scripts. If you can't do that, copy nat-search.cgi to nat, and the result should be the same.

Note that these CGIs will work just after you get a server running. For information on how to do that, check the next section.

Usage

For usage documentation check the Getting Started section.