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

[2.0] Combine rig and instrument #1174

Open
2 tasks
dbirman opened this issue Dec 5, 2024 · 1 comment · May be fixed by #1238
Open
2 tasks

[2.0] Combine rig and instrument #1174

dbirman opened this issue Dec 5, 2024 · 1 comment · May be fixed by #1238
Assignees
Labels
breaking Breaking changes

Comments

@dbirman
Copy link
Member

dbirman commented Dec 5, 2024

Probably wait to do this until after #1172

Describe the solution you'd like

  • Rig and instrument are merged into a single file called instrigument.json
  • Upgrader script that can take v1.X rig/instrument files and merge them into the new format

Describe alternatives you've considered
You might consider calling the file rig.json but this would be frowned upon

Additional context
https://alleninstitute.sharepoint.com/:w:/r/sites/NeuralDynamics/_layouts/15/Doc.aspx?sourcedoc=%7BE27B889D-27A1-4CC0-948C-10ADBE605654%7D&file=Data+Schema+2.0.docx&action=default&mobileredirect=true&DefaultItemOpen=1

@dbirman dbirman added the breaking Breaking changes label Dec 5, 2024
@dbirman
Copy link
Member Author

dbirman commented Jan 2, 2025

@saskiad Inside of a rig there is a validator that looks for specific fields depending on the modalities. I think we should make this behavior more generic in 2.0 by having a CSV file somewhere that maps modalities (rows) to device classes (columns) that are expected to be present. This will make the code a lot more readable and make it easier to modify the requirements if they ever change. This can either live in core/models or we could put it in aind-data-schema-models. Let me know what you think?

@dbirman dbirman self-assigned this Jan 2, 2025
@saskiad saskiad added this to the v2.0 milestone Jan 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment