Documentation of output_forward_op_errors

[kdraeder]

Describe the bug

filter_mod.f90:

https://github.com/NCAR/DART/blob/6eeb4539f1d140c3184c2f9521a1b3bdf9d3396f/assimilation_code/modules/assimilation/filter_mod.f90#L2004

subroutine verbose_forward_op_output:
do i = 1, ens_size
   do j = 1, qc_ens_handle%my_num_vars
      if(nint(qc_ens_handle%copies(i, j)) /= 0) write(forward_unit, *) i, keys(j), nint(qc_ens_handle%copies(i, j))
   end do
end do

So ensemble member is printed first, then (local) observation number.

But filter_mod.rst says "Each line will have three values listed: the observation number, the ensemble member number, and the istatus return code." https://github.com/NCAR/DART/blob/6eeb4539f1d140c3184c2f9521a1b3bdf9d3396f/assimilation_code/modules/assimilation/filter_mod.rst?plain=1#L362

Error Message

None. User might notice that the numbers in the first column range from 1 to ens_size and be skeptical that it's a coincidence.

Which model(s) are you working with?

Any

Version of DART

v10.8.2-2-g8c29b618c

Have you modified the DART code?

No

Build information

All

[hkershaw-brown]

Hi @kdraeder Nice catch.

This is just a note for git information, this output from git describe --tags
v10.8.2-2-g8c29b618c

Tells us you are using Tag v10.8.2 with 2 commits that you've added since tag v10.8.2. In this case I believe you've run git describe --tags while having cam-fv_small_fixes checked out.

[kdraeder]

Thanks for parsing the 'describe' for me. I'll look more carefully in the future. You're right about the branch.

On Fri, Aug 18, 2023 at 7:38 AM Helen Kershaw @.***> wrote:

Hi @kdraeder https://github.com/kdraeder Nice catch.

This is just a note for git information, this output from git describe --tags v10.8.2-2-g8c29b618c

Tells us you are using Tag v10.8.2 with 2 commits that you've added since tag v10.8.2. In this case I believe you've run git describe --tags while having cam-fv_small_fixes checked out.

— Reply to this email directly, view it on GitHub https://github.com/NCAR/DART/issues/530#issuecomment-1683935368, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADFFGEHOGQWDYXNO73DRKWLXV5V4LANCNFSM6AAAAAA3VQJ2CY . You are receiving this because you were mentioned.Message ID: @.***>

[hkershaw-brown]

@ann-norcio this a documentation fix, filter_mod.rst needs changing to correctly describe what the code outputs.

To build the dart documentation on your machine you'll need to install sphinx https://ncar.github.io/dart-developers-guide/documentation.html#installing-sphinx-locally

Sphinx==6.2.1 sphinx-rtd-theme==1.2.2