[MITgcm-devel] documenation for pkg/streamice

[Patrick Heimbach]

Hi Dan,

it would be great if you added the documentation (we talked about this).
There is no real standard for the doc, or rather, the current standard of packages 
is "too little documentation", so your text would likely be above standard.

Probably the only standard is to try to adhere to the way how text/files/figs
are organized in the latex source, and the way you describe seems exactly right.

Your text would then go in as new Section 6.6.4
Perhaps we should change section 6.6 to more generally "Ice Packages"

Also no real vetting process for this, main thing is that the
latex source compiles properly.

So go for it (I'd say).
Cheers
-Patrick

On Nov 16, 2013, at 6:57 AM, Daniel Goldberg <dngoldberg at gmail.com> wrote:

> Hi all,
> 
> I have written up a short document explaining the equations solved and the numerical scheme.
> 
> It is not complete; for one thing, it does not have a tutorial (as the verification halfpipe_streamice has not been extended into a tutorial; though i have written documentation for such a tutorial as well, the proper tutorial folders just need to be created). For another, it does not discuss adjoint capabilities, as the adjoint can only be produced with TAF. And lastly, it might not conform to documentation standards, i.e. it might not be organized in line with other package descriptions.
> 
> Is there a vetting process to adding this? I was thinking to add it under the SEAICE section, as that is where SHELFICE is described; or STREAMICE and SHELFICE could have their own sections? 
> 
> I gather I would need to modify manual/s_phys_pkgs/text/top_section.tex and add a new .tex file with a subsection to manual/s_phys_pkgs/text and put my figures in the /figs folder. Is there anything else? Is there a vetting process to make sure the section is up to standard (J-M?), or is it OK as long as it compiles? 
> 
> Many thanks
> Dan
> 
> -- 
> 
> Daniel Goldberg, PhD
> Lecturer in Glaciology
> School of Geosciences, University of Edinburgh
> Geography Building, Drummond Street, Edinburgh EH8 9XP
> 
> 
> em: Dan.Goldberg at ed.ac.uk
> web: http://ocean.mit.edu/~dgoldberg
> _______________________________________________
> MITgcm-devel mailing list
> MITgcm-devel at mitgcm.org
> http://mitgcm.org/mailman/listinfo/mitgcm-devel


---
Patrick Heimbach | heimbach at mit.edu | http://www.mit.edu/~heimbach
MIT | EAPS 54-1420 | 77 Massachusetts Ave | Cambridge MA 02139 USA
FON +1-617-253-5259 | FAX +1-617-253-4464 | SKYPE patrick.heimbach

-------------- next part --------------
A non-text attachment was scrubbed...
Name: smime.p7s
Type: application/pkcs7-signature
Size: 1588 bytes
Desc: not available
URL: <http://mitgcm.org/pipermail/mitgcm-devel/attachments/20131117/8412ff9d/attachment.p7s>