Cactus 4.0
Maintainers’ Guide DRAFT VERSION
Revision
Date
This document should describe the Cactus flesh. In particular it should describe
In addition it should contain ideas for future enhancements.
Overview of documentation
This guide covers the following topics
The philosophy behind the flesh and the coding style used.
The nitty-gritty of the make system.
The nitty-gritty of the CST.
General miscellaneous things used all over the flesh.
Everything you never wanted to know about the files in the Main subdirectory of the flesh.
Everything you never wanted to know about the files in the Comm subdirectory of the flesh.
Everything you never wanted to know about the files in the IO subdirectory of the flesh.
Everything you never wanted to know about the various utility files.
Everything you never wanted to know about the Schedule system.
I’m sure we’ll need something here.
Other topics to be discussed in separate documents include:
This will contain details about the arrangements and thorns making up the standard Cactus Computation Tool Kit
This will contain details about the arrangements and thorns making up the Cactus Relativity Tool Kit, one of the major motivators, and still the driving force, for the Cactus Code.
The stuff users need to know. This in particular documents the functions the flesh needs to make available to the thorns.
Typographical Conventions
Is currently used for everything you type, for program names, and code extracts.
Indicates a compulsory argument.
Indicates an optional argument.
How to Contact Us
Please let us know of any errors or omissions in this guide, as well as suggestions for future editions. These can be reported via our bug tracking system at http://www.cactuscode.org, or via email to cactusmaint@cactuscode.org. Alternatively, write to us at
The Cactus Team
Center for Computation & Technology
216 Johnston Hall
Louisiana State University
Baton Rouge, LA 70803
USA
Acknowledgements
Hearty thanks to all those who have helped with documentation for the Cactus Code.