Improve Documentation

[kmuehlbauer]

We now have a minimal documentation, yikes https://docs.openradarscience.org/projects/xradar/ It already looks very nice, but can be improved.

What's missing list (please extend):

• [x] mention current version string in docs #19
• [x] mention conda-forge package #19
• [x] update installation guide #19
• [x] update contributing guide #19
• [x] direct links to the current standards #24
• [x] description of the data model (mandatory, optional) #24
• [x] fleshed out description how the importers are working #20
• [x] showcase of implementation of an example accessor #21
• [x] tutorial on producing PPI plots #28
• [ ] tutorial on producing RHI plots
• [ ] how to overlay other types of data (ex. model)
• [ ] using hvplot to create interactive plots
• [ ] xmovie example
• [ ] tbc

[mgrover1]

Thanks for opening this - I agree here. We can definitely start with these points and continue to expand.

[mgrover1]

@kmuehlbauer - here is the repo setup to host sample datasets https://github.com/openradar/open-radar-data . I think we can use this in our examples and such, across these different projects.

[mgrover1]

@kmuehlbauer - when I was working on an RHI example, I noticed how helpful it would be if we had azimuth with range as the dimensions instead of time... so one could use the following

radar.sel(azimuth=270, method='nearest')

Is this something we can consider? Or does this violate the data model?

[kmuehlbauer]

@mgrover1

Yes, that's what we did in wradlib already. Internally we can do anything we want if only we write out in the correct manner.

Try to open with keyword argument first_dim="auto". This will get either "azimuth" or "elevation" as first dim.