update README file for the land converters

JCSDA-internal / ioda-converters

Various converters for getting obs data in and out of IODA

9 stars 4 forks source link

update README file for the land converters #1521

Closed BenjaminRuston closed 3 months ago

BenjaminRuston commented 4 months ago

Description

Make some updates to the README for the land converters

Issue(s) addressed

Resolves #1520

Impact

An up to date README markdown

Checklist

[x] I have performed a self-review of my own code
[x] I have made corresponding changes to the documentation
[x] I have run the unit tests before creating the PR

BenjaminRuston commented 4 months ago

@YoulongXia-NOAA please feel free to go ahead and push to my branch and we'll clean these up

remove any that you don't recommend or support anymore if you think that's best (I think it wouldn't be a terrible idea)

YoulongXia-NOAA commented 4 months ago

@BenjaminRuston, now smap NRT and smap 9km ioda converters have been combined into a single converter, the README.md also need to make the corresponding modifications. Additionally, imsfv3 snow depth ioda converter is not included in this README.md file, it also needs to be included. This is what I suggested. Furthermore, as you removed owp snow depth ioda converter from land sub-directory, it also needs to be added into this README.md file.

BenjaminRuston commented 4 months ago

@YoulongXia-NOAA please make whatever changes you see fit, and push to this branch

i could take a swing at it, would be comfortable with you taking the lead

BenjaminRuston commented 3 months ago

excellent, thanks @YoulongXia-NOAA, please either ask me for additional input .

or once you believe it's ready, just select Ready for review and take this out of draft mode and we'll get this reviewed and into the repository

YoulongXia-NOAA commented 3 months ago

@BenjaminRuston, please take a look and see if you need to modify it/put the additional input. After that, we can ask @ClaraDraper-NOAA to take a look and work together with you and I to finish it. Thank you.

BenjaminRuston commented 3 months ago

@YoulongXia-NOAA and @ClaraDraper-NOAA this looks fine to me

and note @YoulongXia-NOAA you can approve this as it is my PR, so please do so if you feel it is ready and we'll update this file