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

Add dataset preview #113

Closed
andersy005 opened this issue Jul 6, 2022 · 1 comment · Fixed by #430
Closed

Add dataset preview #113

andersy005 opened this issue Jul 6, 2022 · 1 comment · Fixed by #430
Labels
enhancement New feature or request

Comments

@andersy005
Copy link
Member

It would also be nice (but definitely not a must-have for scipy) to see some sort of information about the contents of the zarr dataset. Some nice inspiration for that:

idr.github.io/ome-ngff-samples
ome.github.io/ome-ngff-validator/?source=https://uk1s3.embassy.ebi.ac.uk/idr/zarr/v0.4/idr0076A/10501752.zarr

Originally posted by @rabernat in #93 (comment)

@andersy005 andersy005 added the enhancement New feature or request label Jul 6, 2022
@andersy005
Copy link
Member Author

Adding more feedback from @rabernat in #183


I believe this is a good short term solution to ship a much needed feature quickly. This is the same approach used in https://catalog.pangeo.io/.

However, in the long term, I don't think this architecture is optimal for the following reasons:

  • Opening the dataset with python on the backend is expensive and ultimately unnecessary, since the Zarr dataset is well described by a compact json file.
  • Xarray's html repr is unnecessarily large, with lots of inline custom CSS. That will prevent us from customizing the look and feel of the display.

Instead, I think we should aim to develop a native javascript solution to generating the dataset preview. Ideally an npm package providing react components that we can simply drop in instead of the API call. Maybe something like that already exists? Some inspiration for how this would look can be found at https://idr.github.io/ome-ngff-samples/.

If we go with this solution, we should open a placeholder issue to keep track of that for a future refactor.

Originally posted by @rabernat in #183 (review)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant