[MITgcm-support] FLT package documentation

[Jeffery R Scott]

On Oct 4, 2018, at 1:40 PM, Thomas Bryce Kelly <tbk14 at fsu.edu<mailto:tbk14 at fsu.edu>> wrote:

Good morning,

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.

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.

Cheers,
Tom

--
Thomas Bryce Kelly



Hi Tom,

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.

As a starting point for pkg flt:

- see the readme in pkg/flt; there is a fair amount of info there, hopefully reasonably current
- 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
- 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
  Perhaps some others will chime in who have experience with flt and/or useful info to contribute.


In broad terms, what we are aiming for with general package documentation (some of which may not  apply here):

What it does, how best used, appropriate for which setups etc.

Equations/Description (scientific or otherwise), sample results/figure(s)

Explanation of all namelist parms and diagnostics, guide to usage

Guide to implementation/subroutine calls (technical description)


       See the  ‘contributing to the manual’ section of the doc, this contains instructions you would need to get started

writing doc in rst format (once you've figured out how pkg flt works, more or less).


Best,
Jeff Scott






-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mailman.mitgcm.org/pipermail/mitgcm-support/attachments/20181004/7379b014/attachment-0001.html>