BciPy icon indicating copy to clipboard operation
BciPy copied to clipboard

Simulator fix and orchestrator saving updates

Open tab-cmd opened this issue 1 year ago • 0 comments

Overview

This PR updates the simulator to support the new Task refactor and updates the parameter name and data save path in the orchestrator. Some cleanup of variable names, data in Tasks, and typing are included.

Ticket

  • Fix simulator: https://www.pivotaltracker.com/story/show/188405042
  • Update parameter save name: https://www.pivotaltracker.com/story/show/188476200
  • Update data save path in orchestrator: https://www.pivotaltracker.com/story/show/188497283

Contributions

  • update DEFAULT_PARAMETER_FILENAME to DEFAULT_PARAMATERS_FILENAME for consistency.
  • update get_evidence_type in the simulator to check for supported types and cast to an ENUM (from a string). Ensure it is used wherever needed.
  • update the parameter saving in the orchestrator to use the DEFAULT_PARAMATERS_FILENAME to support use throughout the codebase.
  • update the file save structure in the orchestrator from user/experiment/datetime/tasks/ to user/date/experiment/timestamp/tasks/

Test

  • make test-all
  • bcipy-sim -d ".../2024-10-17_13-33-26" -m ".../Matrix Calibration_2024-10-17_13-00-19" -g "*Copy*" -p ".../parameters.json" -n "25"
  • bcipy --fake --task "RSVP Calibration" -nv
  • bcipy --fake --task "RSVP Calibration"
  • bcipy --fake --task "Matrix Calibration" -nv
  • bcipy --fake --task "Matrix Copy Phrase" -nv

Documentation

  • Are documentation updates required? In-line, README, or documentation? Updated docstrings and task README

CHANGELOG

Updated with all current 2.0rc4 changes of note.

tab-cmd avatar Oct 29 '24 21:10 tab-cmd