Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update reader configuration with human-readable long names #876

Closed
djhoese opened this issue Aug 14, 2019 · 4 comments · Fixed by #887
Closed

Update reader configuration with human-readable long names #876

djhoese opened this issue Aug 14, 2019 · 4 comments · Fixed by #887

Comments

@djhoese
Copy link
Member

djhoese commented Aug 14, 2019

We currently have a description field in the reader YAML files, but these are not standardized. Descriptions may also be long sentences or paragraphs (at least commonly in other software/file formats). Maybe we should add a long_name or short_name attribute to the reader so that GUI applications (like SIFT) can have a pretty name to show a novice user:

abi_l1b -> GOES-R ABI Level 1b
viirs_edr_active_fires -> JPSS VIIRS EDR - Active Fires

@djhoese
Copy link
Member Author

djhoese commented Aug 14, 2019

Would it make sense to have a separate parameter for types of satellite supported like polar versus geo versus both?

@sfinkens
Copy link
Member

Good idea! Since all the descriptions are one liners at the moment, we could use them but strip the Reader for ... and ... reader parts.
Not sure about the supported type of satellite. For which reader would you specify both?

@djhoese
Copy link
Member Author

djhoese commented Aug 15, 2019

Ah sorry, should have been clearer. There are some readers which are algorithm software readers like clavrx or geocat so they support multiple sensors including polar-orbiting and geostationary.

@sfinkens
Copy link
Member

Ok I see, then a geo/leo/both tag makes sense!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants