simularium / simularium-planning

Apache License 2.0
0 stars 0 forks source link

Prototype jupyter notebook viewer #127

Closed blairlyons closed 1 year ago

blairlyons commented 1 year ago

Use Case

As a developer, I want a jupyter notebook module that displays the Simularium viewer in a cell of a notebook so that I can work toward making it easier for computational users working in jupyter notebooks to use simularium viewer.

Acceptance Criteria

A developer can run a jupyter notebook that loads a trajectory in a simularium viewer window embedded in one of the notebook cells.

Details

Use nbvv structure as a starting point.

Notebook window just needs to have the viewer, adding left and right UI panels from the viewer website are out of scope.

blairlyons commented 1 year ago

I heard that notebook widgets can be glitchy when the user runs the notebook in an online binder or converts the notebook to html. Would be good to check into ways to make the viewer widget handle those cases gracefully.