id	summary	reporter	owner	description	type	status	priority	milestone	component	version	resolution	keywords	cc
254	DIAG: improve user docs	Dave Offiler	Ian Culverwell	"Kjartan recommends improving our User Guide documentation for the PP/1DVAR diagnostics structures:
{{{
Dear Ian and Dave

Both the ROPP 1DVAR module and the ROPP preprocessor module have
the possibility of adding extra diagnostic data to the output. 
This is accomplished through the DIAG data structure which gets
written to the output by setting the flag output_diag = .true. in
the configuration file. I assume something similar exists in the
other ROPP modules.

It is a very useful feature that I have used a lot.

I have found the documentation of the DIAG structure and the
available output in the User Guide to be very limited. Both for 
the 1DVAR and the PP module. Here and there there are discussions
of elements in the  diag structure but there's no central listing
and I am fairly sure that there are a number of DIAG elements that
the code will output but that are  nowhere mentioned in the
documentation.

The I/O module user guide has a very, very useful listing of all
elements in the ROPROF structure. Something like that for the DIAG
structure would also be very helpful. Possibly located separately
in each module user guide. Also for some elements in the diag
structure a few lines of description might come in handy.

I don't know if something like that is envisioned or if there's a
good reason to not have it (e.g. diag is more intended as a tool
for developers, or ?)

Anyway, I've been plowing through documentation several times
looking for this without finding it and I thought I'd mention that
it is something I've missed as a user of ROPP.

Sincerely, Kjartan
}}}
"	enhancement	closed	normal	6.0	ROPP (all)	5.0	fixed	DIAG, User Guide, documentation