GUI requirements

[alexpiet]

We need to articulate a list of what we want the GUI to do, so we can streamline code, and fix bugs.

• Add a checkbox "[ ]" to each point that needs to be implemented, and link to open issues

Notes

loose notes:

• load water calibration results
  • Is the water currently calibrated in the GUI too?
• load laser calibration results
  • how is the calibrated?
    Start session, generate trials, deliver rewards

loading a mouse

• The user either presses load:
  • If unsaved_data=True, then is prompted to save first
  • Then is prompted to enter a mouse id, and experimenter name
    • If this mouse already has a session (on any computer) (https://github.com/AllenNeuralDynamics/aind-behavior-blog/issues/140), then we load that session.
      • we always load the last session, no file browser navigation
      • Loads the training parameters (from auto-train)
      • loads the weight info Changing the mouse ID does not update the weight and water fields #194
    • If the mouse has no sessions (on any computer), the user is prompted to select a curriculum
  • Starts a new session

Start a new session

• Clears plots
• clears generated trials
• sets unsaved_data = False

When to Save

• Once trials start, a flag unsaved_data is set.
  • This flag locks metadata: mouse id, and experimenter ID mouse ID doesn't lock when session starts #195
• Every 50 trials, the data is saved in the default location Autosave: should save data every ? trials #196
• When the session stops:
  • The save button turns green
• We have a "Save" and "Saveas" button Create "save" and "save as" buttons #232
  • The data saves to the default location, which sets unsaved_data = False. The user does not navigate the file system. The save button is turned gray
  • Do we actually need a saveas button? Maybe we should never allow saving to a non-default location
  • Training parameters are not saved to the template training stage parameters are getting saved #229
• if newsession, or close is pressed when unsaved_data is set, then the user is prompted to save
  • if unsaved_data is False, the user is not prompted to save (https://github.com/AllenNeuralDynamics/aind-behavior-blog/issues/130)
• starting a NewSession, or saving data, resets unsaved_data

Saving data

• format, metadata, etc
• Improve json -> NWB  #197
• Why do we save a json and nwb? #173
• Force Save fails to export to nwb #171

Automatic upload to AWS

• Enable version autobump on merges to main via github action #218
• Data upload notes (meeting with David and Jon) #209
• Need to document data transfer process #200