<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space;" class="">
<br class="">
<div>
<blockquote type="cite" class="">
<div class="">On Oct 4, 2018, at 1:40 PM, Thomas Bryce Kelly <<a href="mailto:tbk14@fsu.edu" class="">tbk14@fsu.edu</a>> wrote:</div>
<br class="Apple-interchange-newline">
<div class="">
<div class="">
<div dir="ltr" class="">Good morning,
<div class=""><br class="">
</div>
<div class="">My lab would like to start building modeling capacity using the flt (Lagrangian particle) package; but as many of you know, the documentation is on the sparse side. If anyone has documentation--even informal notes--on the setup and package options
then I would be very interested. Links to blog posts, wiki sites or whatever also welcomed.</div>
<div class=""><br class="">
</div>
<div class="">Since I have to imagine that there are other modelers & biogeochemists out there that are looking for this information, I'll also be writing it all up and linking it to my lab's site and github repo in the hope that the wheel doesn't need to be
reinvented too many times. <br clear="all" class="">
<div class=""><br class="">
</div>
<div class="">Cheers,</div>
<div class="">Tom</div>
</div>
<div class=""><br class="">
</div>
-- <br class="">
<div dir="ltr" class="gmail_signature" data-smartmail="gmail_signature">
<div dir="ltr" class="">
<div class="">
<div dir="ltr" class="">
<div class="">
<div dir="ltr" class="">
<div dir="ltr" class="">
<div class="">Thomas Bryce Kelly</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</blockquote>
<br class="">
</div>
<div><br class="">
</div>
<div><br class="">
</div>
<div>Hi Tom,</div>
<div><br class="">
</div>
<div>Indeed there is no documentation of the float package in the manual at this point; we’d certainly love to have you contribute and would be willing to help get you started.</div>
<div><br class="">
</div>
<div>As a starting point for pkg flt:</div>
<div><br class="">
</div>
<div>- see the readme in pkg/flt; there is a fair amount of info there, hopefully reasonably current</div>
<div>- see the verification experiment flt_example for a setup using floats. See also the extra directory here, and the helpful matlab files in the input directory</div>
<div>- I’ve cc’ed Arne Biastoch, the original author, and Christopher Wolfe, who knows MITgcm well and appears to have used the package for some work</div>
<div> Perhaps some others will chime in who have experience with flt and/or useful info to contribute.</div>
<div><br class="">
</div>
<div><br class="">
</div>
<div>In broad terms, what we are aiming for with general package documentation (some of which may not apply here):</div>
<div><br class="">
</div>
<div><span class="Apple-tab-span" style="text-indent: -0.25in; white-space: pre;"></span><span style="text-indent: -0.25in;" class="">What it does, how best used, appropriate for which setups etc. </span></div>
<div>
<p class="MsoListParagraphCxSpFirst" style="text-indent:-.25in;mso-list:l0 level1 lfo1;
tab-stops:4.0in">
<span style="text-indent: -0.25in;" class=""><span class="Apple-tab-span" style="white-space:pre"></span>Equations/Description (scientific or otherwise), sample results/figure(s)</span></p>
<p class="MsoListParagraphCxSpMiddle" style="text-indent:-.25in;mso-list:l0 level1 lfo1;
tab-stops:4.0in">
<o:p class=""></o:p></p>
<p class="MsoListParagraphCxSpMiddle" style="text-indent:-.25in;mso-list:l0 level1 lfo1;
tab-stops:4.0in">
<span class="Apple-tab-span" style="white-space:pre"></span>Explanation of all namelist parms and diagnostics, guide to usage<o:p class=""></o:p></p>
<p class="MsoListParagraphCxSpLast" style="text-indent:-.25in;mso-list:l0 level1 lfo1;
tab-stops:4.0in">
<span class="Apple-tab-span" style="white-space:pre"></span>Guide to implementation/subroutine calls (technical description)<o:p class=""></o:p></p>
<p class="MsoListParagraphCxSpLast" style="text-indent:-.25in;mso-list:l0 level1 lfo1;
tab-stops:4.0in">
<br class="">
</p>
<p class="MsoListParagraphCxSpLast" style="text-indent:-.25in;mso-list:l0 level1 lfo1;
tab-stops:4.0in">
See the ‘contributing to the manual’ section of the doc, this contains instructions you would need to get started</p>
<div class="">writing doc in rst format (once you've figured out how pkg flt works, more or less).</div>
<div class=""><br class="">
</div>
<div class=""><br class="">
</div>
<div class="">Best,</div>
<div class="">Jeff Scott</div>
<div class=""><br class="">
</div>
<div class=""><br class="">
</div>
<p class="MsoListParagraphCxSpLast" style="text-indent:-.25in;mso-list:l0 level1 lfo1;
tab-stops:4.0in">
<br class="">
</p>
<p class="MsoListParagraphCxSpLast" style="text-indent:-.25in;mso-list:l0 level1 lfo1;
tab-stops:4.0in">
<br class="">
</p>
<p class="MsoListParagraphCxSpLast" style="text-indent:-.25in;mso-list:l0 level1 lfo1;
tab-stops:4.0in">
<br class="">
</p>
<!--EndFragment--></div>
<br class="">
</body>
</html>