Installation of NMFF
NMFF is packaged as an encrypted gzipped tar file. Upon completion of the licensing you can decrypt and unpack the program as follows:
openssl enc -d -k {password} -des-ede-cbc -in nmff.tgz.enc -out nmff.tgz
This produces the decrypted gzipped tar file. The {password} should be replaced by
the password you received via email upon registering your copy of NMFF.
tar -ztf nmff.tgz (or gunzip | tar)
This command will produce a directory in the current location called NMFF_V1.0
Move into the NMFF_V1.0 directory and then into the build directory.
cd NMFF_V1.0; cd build
Here is where you will make versions of NMFF for the various platforms
on which you want to run it. In this example, suppose we are making a version for our Apple OS X machines. Make a directory
My_mac_OSX,
mkdir My_mac_OSX
Now we are ready to use configure to build NMFF for this platform. Note that NMFF requires
the additional math/linear algebra libries blas (atlas), lapack, arpack. These libraries will be automatically downloaded and
installed for your platform if thy are not already found on your machine. The command configure can take several agruments
that will control how NMFF is built and installed on your platform, e.g., different compilers can be used, differnt compiler options, etc. By default
NMFF is built using with the g77/gcc (or f77/cc for SGI Unix) with dynamic memory allocation. Additionally, one can build NMFF using fixed array
sizes and static memory or using Fortran 90/95 constructs. (Note, because of issues with 32 bit integers and 64 bit pointers on
x86_64 - Intel Xeon EMT64 processors - the "default" g77 build will fail to execute correctly. If you need to use g77 on your x86_64 Xeon, then the recommended
configureation flags are: FFLAGS="-O3 -DFIXED" CFLAGS="-O3 -DFIXED" - see table below. However, better performance and memory use is available with use of the
g95 compiler or the Intel ifort compilers.) The table below provides some of the options that have
been tested. To configure
NMFF for your platform use the following command:
../../configure {configure options}
For example, if I want to build the NMFF suite for my Apple G4 laptop using the g95 and gcc compilers and install the suite of executable files in
my own bin directory, the command:
../../configure --prefix=/Users/brooks/bin/NMFF F77=g95 CC=gcc FFLAGS="-O3 -DF95" CFLAGS="-O3"
will make ready the following steps to build, test and install the suite.
You can then make the executables using
make all
...and finally test things by running
make test
This will run a short test run and illustrate how to use NMFF. More details on running NMFF are elucidated through the tutorials!
make install
This will install the NMFF suite of programs and perl scripts in the location specified in the
--prefix=/your_desired_bin_directory. Note that the default installation site is
/usr/local/bin and thus may require system privilege to install. If you didn't specify
--prefix=/your_desired_bin_directory when you ran configure above, just rerun configure again
with the desired installation path and then do this last step (no need to do the intervening steps). (Note, if your path
specified above does not end with a bin directory, one will be created.)
|