SpikeInterface / SpikeInterface/spikeinterface
Centralise the binary file saving metadata
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 847
- Forks
- 280
- Avg merge
- 3d 9h
- Merged PRs (30d)
- 29
Description
Following on from a discussion at #3245. At present there is a binary.json metadata file written during the saving of binary data. This duplicates the si_folder.json metadata which has caused some problems with failure to propagate metadata and confusing behaviour during debugging #3245. The logic flow for the data-saving is discussed here. It would be nice to completely deprecate binary.json and use only si_folder.json to centralise the metadata.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the data-saving logic discussed in pull request #3245 and trace where binary.json and si_folder.json are written and read. Determine the compatibility and migration implications of deprecating binary.json, then verify saving and loading behavior so si_folder.json is the sole authoritative metadata file.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100