Update radar obs_converter README

[johnsonbk]

Description:

Update the radar obs_converter README to consolidate Glen's guidance from this issue #37 into the documentation.

Fixes issue

Fixes Github issue #228 .

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation update

Documentation changes needed?

• My change requires a change to the documentation.
• I have updated the documentation accordingly.

Tests

I rebuilt the documentation on my local machine using Sphinx to ensure that this documentation update builds correctly and does not cause any unintended issues.

Checklist for merging

• Updated changelog entry
• Documentation updated
• Version tag

Testing Datasets

• Dataset needed for testing available upon request
• Dataset download instructions included
• No dataset needed

[hkershaw-brown]

looks good.

One broken link in the list of converters.
obs_converters/README.rst link needs changing to the newfile name:

- `Radar <radar/radar.html>`__
+ `Radar <radar/README.html>`__

Plus, Jeff's comment about adding a link to Alain's pdf.

[johnsonbk]

Two quick questions:

Fix all the obs_converter links?

While I'm editing obs_converters/README.rst should I go ahead and change all of those links in the list of obs_converters into the Sphinx format?

`AIRS <AIRS/README.html>`__
`Aviso+/CMEMS <AVISO/AVISO.html>`__
...
`Var (radar) <var/rad_3dvar_to_dart.html>`__

For example, instead of putting in the HTML link (which is typically used to reference external pages):

`Radar <radar/README.html>`__

It would be the Sphinx :doc: link:

:doc:`radar/README`

The reason that my test build of Sphinx didn't catch the broken link is that it doesn't check for broken html links. It only checks for broken :doc: links.

Okay to omit Alain's PDF in the obs_converter README?

I did some digging. Alain's PDF actually describes the forward operator not the observation converter. We have some documentation of it already:

DART/observations/forward_operators/obs_def_radar_mod.rst

[hkershaw-brown]

yup both of those make sense

[johnsonbk]

I modified the obs_converter lists in both:

• guide/available-observation-converters.rst
• observations/obs_converters/README.rst

While I was at it, I also reformatted the CHAMP README since it contained a broken URL. I can move that commit to a different pull request if that would be cleaner:

• observations/obs_converters/CHAMP/work/README.rst