Acro User Manual Version Version 1.0

## Installation

### Standard UNIX Installation

After the Acro software has been downloaded, it must be configured for building on specific hosts for specific target platforms. Installation on UNIX systems is performed by the following steps:

1. If you have an archive, unpack it as follows

           gunzip acro-$VERSION.tar.gz    # uncompress the archive
           tar xf acro-$VERSION.tar       # unpack it

2. Move into the acro directory and run the configure script.

           cd acro
           ./configure
           make

   This will configure the software for your machine and compile the Acro library (see Section Configuration for more details concerning configuration options and the details of the configuration process). After building Acro, the Makefile scripts will create links to package header directories in the directory acro/include, and links to all package libraries are included in acro/lib. Note that the makefiles in Acro may not be portable to all make commands. However, they do work with the GNU gmake command.

You can remove object files, libraries, and executables by typing

        make clean

If you wish to re-configure your Acro source from scratch or re-generate all custom makefiles, type

        make distclean

This will remove all symbolic links, custom makefiles, and config.status files. This will require a re-configure of the system and is usually done in preparation for updating source in the CVS repository or creating tape archives for distribution.

### Custom UNIX Installation

Acro can also be built with the following custom configure/build process

        cd acro
        ./setup configure build

This custom configure/build process overcomes a common problem with the standard configure/build process: it can create a voluminous output that is difficult to follow and which can mask the fact that there errors have occured. This is a particular issue for large projects like Acro, which has many independent packages that may fail to configure or build.

The setup command performs the following actions

1. Pipe the configuration output into acro/test/config.out and generate a test/config.xml summary file

2. Pipe the build output into acro/test/build.out and generate a test/build.xml summary file (this includes builds of Acro executables and test executables)

The XML files generated in the acro/test director provide a quick reference to confirm that the software was configured and built properly. The use of setup can be extended to include configuration options, and to perform tests. For example the following configures using MPI and performs fast smoke tests of various Acro packages:

        cd acro
        ./setup configure --with-mpi  build  smoke

### Setup Documentation

The main Acro makefile includes several targets for generating documentation. This documentation is generated with the doxygen utility, so documentation can be generated in several formats. The command

        make html

creates HTML documentation, and the command

        make pdf

creates documentation in a single PDF file. This later command requires the use of latex, dvips and ghostscript packages.