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

ENH: list_engines function #6577

Open
snowman2 opened this issue May 5, 2022 · 4 comments · May be fixed by #9821
Open

ENH: list_engines function #6577

snowman2 opened this issue May 5, 2022 · 4 comments · May be fixed by #9821

Comments

@snowman2
Copy link
Contributor

snowman2 commented May 5, 2022

Is your feature request related to a problem?

It can be difficult to know what engines are available and where they come from. This could help with that.

Describe the solution you'd like

import xarray
xarray.list_engines()

Output:

Name | Description | Documentation
------------------------------------------------
rasterio | Open geospatial files (GeoTiff) | https://corteva.github.io/rioxarray

Describe alternatives you've considered

No response

Additional context

No response

@snowman2
Copy link
Contributor Author

snowman2 commented Sep 1, 2022

Looks like something already exists:

from xarray.backends.plugins import list_engines

It would be nice to add the description & documentation properties to xarray.backends.common.BackendEntrypoint that can be implemented by external libraries (and internally) and a more official list_engines function with the above metadata could be added.

@JessicaS11
Copy link
Contributor

I'm happy to work on this!

@dcherian
Copy link
Contributor

@pydata/xarray in #7000 we update the docstrings and output for xr.backends.list_engines to be more user-friendly.

Shall we also add a top-level import: xr.show_backends like xr.show_versions. This would be a lot more discoverable.

@TomNicholas
Copy link
Member

(I'm looking for issues to tag as beginner-friendly)

Shall we also add a top-level import: xr.show_backends like xr.show_versions. This would be a lot more discoverable.

This is easy right? You could just add an xr.show_backends that points to the same function as xr.backends.list_engines? And point out in the docstring that they are actually the same function?

@VeckoTheGecko VeckoTheGecko linked a pull request Nov 25, 2024 that will close this issue
4 tasks
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.

5 participants