openradar / xradar

A tool to work in weather radar data in xarray
https://docs.openradarscience.org/projects/xradar
MIT License
91 stars 17 forks source link

Combined docs fixes #11

Closed kmuehlbauer closed 1 year ago

kmuehlbauer commented 1 year ago

consumes #9 and #10

kmuehlbauer commented 1 year ago

@mgrover1 Would be nice, if we could enable the rtd pull request builds. Otherwise checking the doc build is a bit clunky.

I've fixed the doc builds with regard to rst <-> md and activated some more sphinx-plugins. Progressing a bit on this.

kmuehlbauer commented 1 year ago

@scollis, @jfigui, @DanielMichelson, @mgrover1, @wolfidan

I gave the about section a shot, summarising in a few sentences the whereabouts of this project. Please have look if you find the time. We can modify/change any time.

kmuehlbauer commented 1 year ago

Adding the text here for easier access:

_At a developer meeting held in the course of the ERAD2022 conference in Locarno, Switzerland, future plans and cross-package collaboration of the openradarscience community were intensively discussed.

The consensus was that a close collaboration that benefits the entire community can only be maximized through joint projects. So the idea of a common software project whose only task is to read and write radar data was born. The data import should include as many available data formats as possible, but the data export should be limited to the recognized standards, such as ODIM_H5 and CfRadial.

As memory representation an xarray based data model was chosen, which is internally adapted to the forthcoming standard CfRadial2.1/FM301.

Any software package that uses xarray in any way will then be able to directly use the described data model and thus quickly and easily import and export radar data. Another advantage is the easy connection to already existing open source radar processing software, like Py-ART, pyrad and wradlib._

mgrover1 commented 1 year ago

Adding the text here for easier access:

_At a developer meeting held in the course of the ERAD2022 conference in Locarno, Switzerland, future plans and cross-package collaboration of the openradarscience community were intensively discussed.

The consensus was that a close collaboration that benefits the entire community can only be maximized through joint projects. So the idea of a common software project whose only task is to read and write radar data was born. The data import should include as many available data formats as possible, but the data export should be limited to the recognized standards, such as ODIM_H5 and CfRadial.

As memory representation an xarray based data model was chosen, which is internally adapted to the forthcoming standard CfRadial2.1/FM301.

Any software package that uses xarray in any way will then be able to directly use the described data model and thus quickly and easily import and export radar data. Another advantage is the easy connection to already existing open source radar processing software, like Py-ART, pyrad and wradlib._

This is fantastic @kmuehlbauer ! Thank you for drafting this up/converting more documents here to markdown. My only suggest here would be to link to the different projects and documents (ex. FM301, Py-ART, wradlib, and pyrad)

kmuehlbauer commented 1 year ago

@mgrover1 Yes, I thought that links would be good. I'm unsure which packages I should mention/link. Maybe I'll just refer to the openradarscience projects page?

mgrover1 commented 1 year ago

@mgrover1 Yes, I thought that links would be good. I'm unsure which packages I should mention/link. Maybe I'll just refer to the openradarscience projects page?

I think using the ones I mentioned in that comment! Not sure if the FM301 spec is openly available

kmuehlbauer commented 1 year ago

I meant a link to https://openradarscience.org/pages/projects/ would catch all projects.

kmuehlbauer commented 1 year ago

FM301 I could link to the WMO group there.

kmuehlbauer commented 1 year ago

I change trains in a few minutes but have another 2 hours to update this later.

mgrover1 commented 1 year ago

Woo! Great @kmuehlbauer - again, thanks for putting this all together. I am going to grab some dinner and can review again once you make those changes!

kmuehlbauer commented 1 year ago

@mgrover1 Finally, the rtd build is activate from PullRequests too. I fiddled with it over at RTD (thanks for adding me) and resynced the webhooks at GitHub. Not sure what made the difference.

For the version 999 problem. We would just need to install the package on rtd or derive the naming via git in an analogous way to setuptools_scm.

kmuehlbauer commented 1 year ago

Let's move on with this. We can change/adapt anytime.

kmuehlbauer commented 1 year ago

I've squashed and regrouped commits.