Design Jupyter notebook interface

Background

User problems, context, goals, known challenges, unknowns, etc

See examples of Jupyter notebooks here. Once complete, add implementation details to this issue

Users [may] need a modified UI design for the controls in a modified viewer that displays in a Jupyter notebook cell.

A few differences from the main web viewer:

This viewer will be in a smaller window so the interface will take minimal screen real estate, and maybe have an easy way to toggle full screen or hide some controls.
Users will be able to generate and display plots directly in the notebook interface so the plots panel is likely not needed.
The model will be loaded through code so the 'Load model' menu (and the rest of the top bar?) is likely not needed.

User needs statement(s)

As a [type of user], I need/want to [action(s)], so that I can [goal].

As a computational biologist using a jupyter notebook to develop a new simulation model, I want to be able to view my spatial results interactively without leaving the notebook application so that I can iterate on debugging my model faster with less steps to view Simularium results.

As a biologist using a jupyter notebook to view an existing model shared by another biologist, I want to be able to view spatial results interactively in the notebook so that I can understand the model.

Size

Expected level of user research, discovery and design effort (xs, sm, m, lg, xl)

XS discovery/research
likely none or XS design effort

Design Requirements

Talk to internal users to assess user needs (After identified, we will decide what is in scope for this project, and list further requirements here)

Likely requirements:

UI will look the same as the web viewer in browser, minus the plots panel
Banner at top in lieu of website's header with Simularium title???
A way to view view either full screen or adjust widget height???

Deliverables

It is not yet known if UI design is needed for this project. It was determined at kickoff that UX will start with a discovery phase and identify any user needs that require design efforts

Stakeholder(s)

Who is directly involved? (developers, main points of contact, final approver)

Blair, Megan

Timeline

Add completion date to ticket and any time specific notes here

Notes

Additional notes here

Scenario 1: Running a short simulation or debugging a simulation, they want to make sure things are running as expected. Send data directly from their simulation results (in memory) into the jupyter simularium widget

Scenario 2: Longer simulation, maybe intend to convert a precomputed file to a simularium file, but first able to view it in the conversion process.

Run simulation, save to file
In notebook: load file into viewer widget
Add any metadata they want, be able to see how that will end up labeling things
Save out the simularium file (by calling nbsv.save())

simularium / simularium-planning