Manuals and Guides
Downloadable versions of the manuals that come with the Cactus distribution
|
The Cactus Code is distributed with the LaTeX source for
the User's Guide and the Maintainer's Guide. A Thorn Guide
can also be generated from the documentation found in each
installed thorn, either for all installed thorns, for an
entire arrangement, or those used for a particular
configuation. Downloadable versions, in different formats,
are available on this page for the current Cactus release.
These Guides are still being developed and written, so please
let us know about missing information or inaccuracies.
Note:
these guides are for the stable version of Cactus --
if you are using the development version, then you should use
the documentation that you checked out from CVS instead.
|
User's Guide
The User's Guide covers how to install and run Cactus,
how to write thorns (both application and infrastructure),
and the interfaces provided by the Cactus Flesh. Note that
the User's Guide does not describe any actual thorns, the
relevent thorn documentation should be consulted instead.
|
|
Maintainer's Guide
The Maintainer's Guide documents the Cactus flesh and
interfaces, and defines standards, conventions, and
programming style. [Note that this Guide is very
incomplete at the moment].
|
|
Thorn Guide
The Thorn Guide gathers together the documentation
contained in each thorn, describing what the thorn
does, and listing parameters. (The Thorn Guide distributed
from this page contains documentation for all released
thorns, however using the gmake <config>-ThornGuide
target in your Cactus installation produces a guide for
a particular configuration).
|
|
Reference Manual
The Reference Manual conains descriptions of all the public CCTK_* and Util_* APIs provided by the Cactus Flesh
|
|
Created by
jeffd
Last modified
2008-02-09 09:56 AM
First XiRel Workshop
