Make the product's catalog more visible
See original GitHub issueI’ve just had the case of a user who didn’t know a product type was made available by eodag. The new website (#233) will display the content of product_types.yml
in one of the sections of the Getting Started. However, this still won’t be so easy to find or to browse. eodag list
or dag.list_product_types()
return the content of the YAML file, but this is also not so easy to explore.
I was thinking that we could have a script to generate a nicely formatted HTML page of this catalog. We could generate it during the docs build and link it or embed it in the documentation. We could also generate this HTML the first time EODataAccessGateway
is instantiated (like the whoosh index or the default configuration file) and have a method to open that page in a browser (e.g. dag.open_product_catalog()
).
This would allow users to:
- Easily see the products that are made available directly by eodag
- Find the product’s identifier eodag uses (e.g. S2_MSI_L1C)
For each product, we could add the list of providers that make it available.
Issue Analytics
- State:
- Created 2 years ago
- Comments:7 (2 by maintainers)
Top GitHub Comments
Yes, the
guess_product_type
was an attempt to achieve that. It would definitely help to gather the EO community thoughts somewhere to enhance it.Hi @aoyono , glad to see your message! And also, thanks for the suggestion.
That is true that the product type may be something not so easy to handle : it can be named differently between eodag, one provider, or another one.
There already exist the “guess product type” functionality. Is is documented here https://eodag.readthedocs.io/en/latest/notebooks/api_user_guide/4_search.html#Guess-a-product-type (It might need an example to be more clear).
We may also add some more examples in the documentation to show how to use it, like:
It is also related to #165 to have some keywords to describe product types, and query them