LOCKER:          tao-petsc_v3.7

FILE:            /mit/tao-petsc_v3.5/README.athena

CONTENTS:        TAO, PETSc 3.7.5 version locker

DESCRIPTION:     PETSc is a suite of data structures and routines for the 
                 scalable (parallel) solution of scientific applications 
                 modeled by partial differential equations. It supports MPI, 
                 shared memory pthreads, and NVIDIA GPUs, as well as hybrid 
                 MPI-shared memory pthreads or MPI-GPU parallelism. The version
                 on Athena supports MPI parallelism but does not support GPU 
                 computation.

                 TAO is software for solving large-scale optimization problems.
                 It uses an object-oriented design to create a flexible toolkit
                 with strong emphasis on the reuse of external tools (it is
                 designed to run on top of PETSc). The design enables 
                 bi-directional connection to lower level linear algebra 
                 support (for example, parallel sparse matrix data structures) 
                 as well as higher level application frameworks. It has 
                 algorithms for unconstrained and bound-constrained 
                 optimization. The TAO distribution is now merged with PETSc.

HOW TO RUN:

  COMMAND:	 setup tao-petsc

                 Consult documentation and example makefiles for usage details.
                 These applications are quite complex and are supplied as
                 libraries that you link your code against with many options.

                 You can copy subtrees named "tutorials" to a location where
                 you have write permission, and use the makefiles to compile
                 examples and run the code. You can modify these build and
                 run commands to use with your own code. Most but not all 
                 of the examples will run.

An outline of the compile and run commands for example rosenbrock1.c in
/mit/tao-petsc_v3.7/petsc/src/tao/unconstrained/examples/tutorials:

     to build: 
g++ -o rosenbrock1.o -c -O3  -I/mit/tao-petsc_v3.7/include rosenbrock1.c
g++ -O3 -o rosenbrock1 rosenbrock1.o -L/mit/tao-petsc_v3.7/lib -lpetsc -lmpi

       to run: 
./rosenbrock1 -tao_monitor -tao_view

       to see options:
./rosenbrock1 -help

  FROM DASH:	 no

INTERFACES:	 command line

VERSIONS:	 For Linux 64: TAO 3.7.5, PETSc 3.7.5
                  
DEPENDENCIES:    MPI infrastructure

DATAFILES:	 Platform-independent

LICENSE SERVER:	 no

-------------------------------------------------------------------------

SUPPORT ISSUES --

I/S SUPPORT:

  CONSULTING:	 none

  TRAINING:	 none

  DOCUMENTATION: 
             TAO: http://web.mit.edu/tao-petsc_v3.7/tao_manual.pdf
             PETSc: http://web.mit.edu/tao-petsc_v3.7/petsc_manual.pdf  
           http://web.mit.edu/tao-petsc_v3.7/petsc-3.7.5/docs/

OTHER SUPPORT:

  CONSULTING:	 (none)

  TRAINING:      (none)

  DOCUMENTATION:  

  WEB PAGE:      http://www.mcs.anl.gov/petsc/
                 petsc4py: https://bitbucket.org/petsc/petsc4py 

BUG REPORTS:	 Use sendbug

-------------------------------------------------------------------------

LEGAL ISSUES -- 

STATUS: freely distributable under 2 clause BSD license: see
http://www.mcs.anl.gov/petsc/documentation/license.html

 SITES:         any
 
 RESTRICTIONS:  
 
 DOCUMENTATION: 
                                
-------------------------------------------------------------------------

ABOUT THIS LOCKER --

MAINTAINER(S):	 swmaint (group), alexp

DIRECTORY STRUCTURE:

	/mit/tao-petsc_v3.7/petsc - link to top level of distribution tree
                            bin     link to binaries, scripts
                            docs    link to documentation
                            etc     configuration files
                            include include files
                            lib     link to libraries, jar files
                            man     link to man pages
                            sbin    miscellaneous scripts
                            share   miscellaneous files, man pages

MODIFY HISTORY:
	4/17/17 - Alex Prengel
                  Created this README.athena, initial locker setup

MISCELLANEOUS:

Many external applications and libraries have been added; see the bin and lib
directories (and the external package configure options below).

To run examples, run the locker setup command, copy the desired example or 
tutorial subtree to a location where you have write permission and run the 
desired makefile from there.  

Some detailed instructions for selected examples are at 

http://www.mcs.anl.gov/petsc/petsc-current/tutorials/HandsOnExercise.html

external package configure options used to compile the binaries are listed 
in file README.config in this locker as --download-* options.