[ET Trac] [Einstein Toolkit] #880: Improve McLachlan documentation

Einstein Toolkit trac-noreply at einsteintoolkit.org
Tue May 8 05:26:42 CDT 2012


#880: Improve McLachlan documentation
-----------------------------------+----------------------------------------
 Reporter:  hinder                 |       Owner:     
     Type:  enhancement            |      Status:  new
 Priority:  major                  |   Milestone:     
Component:  EinsteinToolkit thorn  |     Version:     
 Keywords:                         |  
-----------------------------------+----------------------------------------
 There should be documentation for the McLachlan arrangement.  There is
 currently documentation at
 http://www.carpetcode.org/gitweb/?p=McLachlan.git;a=blob;f=doc/mclachlan.tex;h=d4a9d17f4e6de9a1c96c2facb93d7b3ccfc347a7;hb=HEAD)
 but this is mostly installation instructions, which is not relevant for
 most users of the ET.  This documentation is not built as part of the
 normal documentation build process.

 1. Add standard Cactus arrangement documentation;
 2. Transfer relevant information from mclachlan.tex;
 3. We should probably follow the usual thorn documentation template for
 this arrangement documentation, simultaneously describing all the thorns.
 We should explain precisely what formulation is evolved (possibly by
 reference to the .m file, but it would be nice for users not to have to
 browse through source code).

-- 
Ticket URL: <https://trac.einsteintoolkit.org/ticket/880>
Einstein Toolkit <http://einsteintoolkit.org>
The Einstein Toolkit


More information about the Trac mailing list