<div dir="ltr">I recommend using ThornDoc and ArrangementDoc instead of ThornGuide. This directory should show up when you "make ArrangementDoc".<div><br></div><div style>-erik</div><div style><br></div></div><div class="gmail_extra">
<br><br><div class="gmail_quote">On Tue, Apr 2, 2013 at 5:36 PM, Kelly, Bernard J. (GSFC-660.0)[UNIVERSITY OF MARYLAND BALTIMORE COUNTY] <span dir="ltr"><<a href="mailto:bernard.j.kelly@nasa.gov" target="_blank">bernard.j.kelly@nasa.gov</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div style="font-size:14px;font-family:Calibri,sans-serif;word-wrap:break-word"><div><div>Hi Ian.</div><div><div><br></div>
<div>Yes, I saw the McLachlan/doc directory, but of course that won't show up in a Cactus-generated ThornGuide, even if it *did* contain the information we're talking about.</div></div></div><div><br></div><div>It's true that thorn documentation can easily go out of date, but if the .tex file is date-stamped (or even release-stamped), it should inform the reader as to how up-to-date it is. And the current alternative is no documentation at all ...</div>
<div><br></div><div>Bernard</div><div><br></div><span><div style="border-right:medium none;padding-right:0in;padding-left:0in;padding-top:3pt;text-align:left;font-size:11pt;border-bottom:medium none;font-family:Calibri;border-top:#b5c4df 1pt solid;padding-bottom:0in;border-left:medium none">
<span style="font-weight:bold">From: </span> Ian Hinder <<a href="mailto:ian.hinder@aei.mpg.de" target="_blank">ian.hinder@aei.mpg.de</a>><br><span style="font-weight:bold">Date: </span> Tuesday, April 2, 2013 5:28 PM<br>
<span style="font-weight:bold">To: </span> Bernard Kelly <<a href="mailto:bernard.j.kelly@nasa.gov" target="_blank">bernard.j.kelly@nasa.gov</a>><br><span style="font-weight:bold">Cc: </span> "<a href="mailto:users@einsteintoolkit.org" target="_blank">users@einsteintoolkit.org</a>" <<a href="mailto:users@einsteintoolkit.org" target="_blank">users@einsteintoolkit.org</a>><br>
<span style="font-weight:bold">Subject: </span> Re: [Users] Cactus documentation in Kranc-generated thorns?<br></div><div><div class="h5"><div><br></div><div><div style="word-wrap:break-word"><br><div><div>On 2 Apr 2013, at 23:16, "Kelly, Bernard J. (GSFC-660.0)[UNIVERSITY OF MARYLAND BALTIMORE COUNTY]" <<a href="mailto:bernard.j.kelly@nasa.gov" target="_blank">bernard.j.kelly@nasa.gov</a>> wrote:</div>
<br><blockquote type="cite">Hi.<br><br>
I recently went through the main McLachlan_BSSN.m Kranc/Mathematica<br>
script, noting the exact form of the BSSNOK evolution equations, as well<br>
as their CCZ4 and GSFC variants. It occurred to me that these would be<br>
useful things to have in a human-readable format, as part of the ML_BSSN<br>
(say) thorn documentation. But of course, there *is* not ML_BSSN/doc<br>
directory by default.<br><br>
Can McLachlan.m incorporate external documentation? Perhaps something<br>
stored in the "prototype" subdirectory could be added to the newly<br>
generated thorn?<br></blockquote><div><br></div><div>There is arrangement documentation in McLachlan/doc. This could be added to. I have always wanted Kranc to output documentation LaTeX files including the equations in tensorial form, but have not implemented this. One problem was that there was no good
way to automatically line-break the equations in LaTeX. I think there are some hacks, but nothing reliable. I would prefer the equation documentation to be automatically-generated, as otherwise it risks becoming out of date.</div>
</div><br><div><span style="border-collapse:separate;font-family:Helvetica;border-spacing:0px;font-size:medium"><span style="text-indent:0px;letter-spacing:normal;font-variant:normal;font-style:normal;font-weight:normal;line-height:normal;border-collapse:separate;text-transform:none;font-size:12px;white-space:normal;font-family:Helvetica;word-spacing:0px"><div style="word-wrap:break-word">
<span style="text-indent:0px;letter-spacing:normal;font-variant:normal;font-style:normal;font-weight:normal;line-height:normal;border-collapse:separate;text-transform:none;font-size:12px;white-space:normal;font-family:Helvetica;word-spacing:0px"><div style="word-wrap:break-word">
<span style="text-indent:0px;letter-spacing:normal;font-variant:normal;font-style:normal;font-weight:normal;line-height:normal;border-collapse:separate;text-transform:none;font-size:12px;white-space:normal;font-family:Helvetica;word-spacing:0px"><div style="word-wrap:break-word">
<div>-- </div><div>Ian Hinder</div><div><a href="http://numrel.aei.mpg.de/people/hinder" target="_blank">http://numrel.aei.mpg.de/people/hinder</a></div></div></span></div></span></div></span></span></div><br></div></div>
</div></div></span></div>
<br>_______________________________________________<br>
Users mailing list<br>
<a href="mailto:Users@einsteintoolkit.org">Users@einsteintoolkit.org</a><br>
<a href="http://lists.einsteintoolkit.org/mailman/listinfo/users" target="_blank">http://lists.einsteintoolkit.org/mailman/listinfo/users</a><br>
<br></blockquote></div><br><br clear="all"><div><br></div>-- <br>Erik Schnetter <<a href="mailto:schnetter@cct.lsu.edu" target="_blank">schnetter@cct.lsu.edu</a>><br><a href="http://www.perimeterinstitute.ca/personal/eschnetter/" target="_blank">http://www.perimeterinstitute.ca/personal/eschnetter/</a>
</div>