#######################################################################################
#                                                                                     #
#                                        README                                       #
#                                                                                     #
#######################################################################################
#                                                                                     #
#            NOMAD - Nonsmooth Optimization by Mesh Adaptive Direct search            #
#            V 3.3                                                                    #
#            2009/07                                                                  #
#                                                                                     #
#	Copyright (C) 2001-2009                                                       #
#                                                                                     #
#                           Mark Abramson	 - the Boeing Company, Seattle        #
#                           Charles Audet	 - Ecole Polytechnique, Montreal      #
#                           Gilles Couture	 - Ecole Polytechnique, Montreal      #
#                           John Dennis		 - Rice University, Houston           #
#                           Sebastien Le Digabel - Ecole Polytechnique, Montreal      #
#                                                                                     #
#-------------------------------------------------------------------------------------#
#                                                                                     # 
#	Contact information:                                                          #
#    Ecole Polytechnique de Montreal - GERAD                                          #
#    C.P. 6079, Succ. Centre-ville, Montreal (Quebec) H3C 3A7 Canada                  #
#    e-mail: nomad@gerad.ca                                                           #
#    phone : 1-514-340-6053 #6928                                                     #
#    fax   : 1-514-340-5665                                                           #
#                                                                                     #
#  This program is free software: you can redistribute it and/or modify it under the  #
#  terms of the GNU General Public License as published by the Free Software          #
#  Foundation, either version 3 of the License, or (at your option) any later         #
#  version.                                                                           #
#                                                                                     #
#  This program is distributed in the hope that it will be useful, but WITHOUT ANY    #
#  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A    #
#  PARTICULAR PURPOSE.  See the GNU General Public License for more details.          #
#                                                                                     #
#  You should have received a copy of the GNU General Public License along with this  #
#  program. If not, see <http://www.gnu.org/licenses/>.                               #
#                                                                                     # 
#  You can find information on the NOMAD software at www.gerad.ca/nomad               #
#                                                                                     #
#######################################################################################


     AUTHORS :

• Mark A. Abramson (Mark.A.Abramson@boeing.com), The Boeing Company.

• Charles Audet (www.gerad.ca/Charles.Audet), GERAD and Département de
mathématiques et de génie industriel, École Polytechnique de Montréal.

• J.E. Dennis Jr. (www.caam.rice.edu/»dennis), Computational and Applied
Mathematics Department, Rice University.

• Sébastien Le Digabel (www.gerad.ca/Sebastien.Le.Digabel), GERAD and Département
de mathématiques et de génie industriel, École Polytechnique de Montréal.


     DESCRIPTION :

NOMAD is a C++ implementation of the Mesh Adaptive Direct Search (MADS) algorithm,
designed for constrained optimization of black-box functions.

The project started in 2001, and was funded in part by AFOSR, CRIAQ, FQRNT, LANL,
NSERC, the Boeing Company, and ExxonMobil Upstream Research Company.


     WEB PAGE :

http://www.gerad.ca/nomad/


     FURTHER INSTRUCTIONS :

Please visit the web page for futher instruction on the following:

  * Downloading, configuring, compiling, and installing NOMAD
  * Using NOMAD and setting the parameters
  * Reports on NOMAD
  * How to report bugs and make enhancement requests
  * And more...


     DOWNLOADING NOMAD :

1. Go to http://www.gerad.ca/NOMAD/PHP_Forms/Download.php
2. Register and submit
3. Choose your version
4. When prompted, save the file to disk


     UNPACKING NOMAD :

To unpack the compressed zip file, type

  unzip nomad.3.3.0.zip

This will create a directory named NOMAD.3.3.0 containing the source code for NOMAD.
The full path of the resulting appspack directory will be referred to as
$NOMAD_HOME for the remainder of this file.


     BATCH OR LIBRARY MODE :

NOMAD is designed to be used in two different modes : batch and library.
The batch mode is intended for a basic ans simple usage of the MADS method,
while the library mode allows more flexibility.
For example, in batch mode, users must define their separate black-box program,
that will be called with system calls by NOMAD.
In library mode, users can define their black-box function as C++ code
that will be directly called by NOMAD, without system calls and temporary files.


     TYPES OF USE :

There are two ways of using NOMAD, one can directly use an executable or compile
the source code.

NOMAD batch mode executables are located in directory $NOMAD_HOME/bin.
In order to avoid compiling the code, you can simply use the executable
corresponding to your system. You may erase the ones not designed for your system.


     COMPILING THE SOURCE CODE :

The first step is configuring NOMAD for your computing environment.
To do this, go to the $NOMAD_HOME/install directory and type

  ./configure [options]

A full list of configure options can be obtained by typing 

  ./configure --help

This command will creat the Makefile in the same directory.

Once NOMAD has been successfully configured, the libraries and executables
can be built.

To compile NOMAD, just type

  make

This command will create the nomad executable :

  $NOMAD_HOME/bin/nomad


     LIBRARY MODE :

If you want to use NOMAD in library mode, you have to create the library.
To do this, just type 

  make lib

in the $NOMAD_HOME/install directory.

The NOMAD library $NOMAD_HOME/lib/nomad.a will also be created.


     INSTALLING NOMAD :

Optionally, NOMAD can be installed via the make install command.
The default installation location is /usr/local,
but this can be changed using the --prefix configure option.


     HOW TO EXECUTE NOMAD :

For informations about the execution of NOMAD, please read the user_guide :

  $NOMAD_HOME/doc/user_guide

or

  http://www.gerad.ca/NOMAD/Downloads/user_guide.pdf