Compile

Introduction

This tutorial demonstrates how to compile the example codes of libnuceq. It assumes you are in a Linux or Unix environment. If you are using a different operating system, please adjust the following instructions as appropriate . (Microsoft windows users may wish to use Cygwin, a linux/unix-like environment for Windows. To install Cygwin, please see the following blog post.)

Check for Dependencies

The libnuceq codes depend on libxml2, the XML C parser and toolkit of Gnome, gsl, the GNU Scientific Library, wn_matrix, libnucnet, and libstatmech.

To find out if you have libxml2 properly installed on your system, type at the command line:

xml2-config

If libxml2 is properly installed, the command will return a Usage description and a list of Options. Note that you can check which version of libxml2 is installed by typing

xml2-config --version

If libxml2 is not properly installed, the result of running xml2-config will be the line

xml2-config: command not found

In this case, you will need to install libxml2 by following the appropriate instructions from this blog post before compiling libnucnet codes.

To find out if you have gsl properly installed on your system, type at the command line:

gsl-config

If gsl is properly installed, the command will return a Usage description and a list of Options. Note that you can check which version of gsl is installed by typing

gsl-config --version

If gsl is not properly installed, the result of running gsl-config will be the line

gsl-config: command not found

In this case, you will need to install gsl by following the appropriate instructions from this blog post before compiling libnucnet codes.

To find out if you have xsltproc properly installed on your system, type at the command line:

xslt-config

If it is not installed, install it as you did libxml2.

To install wn_matrix, see the download and compile tutorials for the latest release of wn_matrix. To install libnucnet, see the download and compile tutorials for the latest release of libnucnet. To install libstatmech, see the download and compile tutorials for the latest release of libstatmech.

Compile the Examples

After downloading libnuceq, go to the directory examples/ of the distribution. For example, if your current installation of libnuceq is in the directory ~/modules/libnuceq/0.2/src/, type

cd ~/modules/libnuceq/0.2/examples

Now compile the examples by typing:

make all

This will generate all the executable files. You can also make them separately. For example, type

make compute_wse

to generate the executable compute_wse.

Please note that we have the compiler flags set for gcc and for memory checking with Valgrind. You may wish to edit the Makefile. Look for this part of the Makefile:

 #///////////////////////////////////////////////////////////////////////////////
 # The following lines must be edited according to where you have
 # placed your libnucnet, wn_matrix, and libstatmech modules.  You may also
 # edit to choose a different compiler (e.g., g++), to use Valgrind or
 # not, or to profile:
 #///////////////////////////////////////////////////////////////////////////////

 GC=gcc

 MODULES = ../../../..

 LIBNUCEQDIR = ../src/
 LIBNUCNETDIR = $(MODULES)/libnucnet/0.9/src/
 LIBSTATMECHDIR = $(MODULES)/libstatmech/0.4/src/
 MATRIXSRCDIR = $(MODULES)/wn_matrix/0.13/src/
 VALGRIND= yes
 PROFILE= no

 #===============================================================================
 # End of editing
 #===============================================================================

You should only need to change the lines in this section. For example, you might want to change the compiler from gcc to g++ by setting GC=g++ or to optimize by setting VALGRIND=no. (Note that Valgrind works better without optimization.)

Clean the Examples

To remove the object files created during compilation, type

make clean

To remove all the object and executable files, type

make cleanall