MADNESS Documentation

These pages serve as the main programmer's reference manual for MADNESS and were automatically generated from the source using Doxygen.

A good place to start is the modules page, which provides access to documentation for libraries, examples, and applications. The examples are intended to meet the needs of those starting to develop new applications.

Additional technical documentation can be found in the MADNESS doc directory.

• The getting started guide introduces use of the numerical functionality.
• The implementation notes document the internal numerical workings as a resource for both users and MADNESS developers.
• The parallel runtime and API documents document the operation and interface for the parallel programming environment.

The project home contains information on configuring, building, etc.

Status and supported platforms

MADNESS is roughly in beta release. Most things work well enough for several applications to be in production mode, but on the other hand there are still lots of "rough" spots and the documentation in particular does not yet meet our expectations.

Currently, we intend that MADNESS work correctly and efficiently on the following platforms

• Cray,
• IBM BGQ,
• Linux workstations with 64-bit multi-core processors, and clusters thereof
• Apple Macintosh (Intel processors) with recent versions of OS X.

To build on any of these you will need a recent software stack.

Software used by MADNESS

Our deep gratitude to these other projects whose software we employ

• TinyXML
• CFFT
• muParser
• libxc
• Doxygen
• Graphviz
• MPICH
• Open-MPI
• LAPACK
• GCC
• Google test
• Google performance tools
• Libxc

License

  Copyright (C) 2007,2010 Oak Ridge National Laboratory

  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 2 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, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

  For more information please contact:

  Robert J. Harrison
  Oak Ridge National Laboratory
  One Bethel Valley Road
  P.O. Box 2008, MS-6367

  email: harrisonrj@ornl.gov
  tel:   865-241-3937
  fax:   865-572-0680

Todo:

Turn all of the doxygen modules into a PDF users' manual.