The stream daq relies on bitfiles - i believe these are the "programs" that run on the FPGA, but i actually have no idea.
We need to
[ ] Document what bitfiles are - user facing documentation, so people know how their cameras and DAQs work
[ ] Document how they are generated - developer facing documentation, so people can debug, modify, make their own, contribute to the project, etc.
This probably goes along with needing to document FPGA stuff generally, so i'll defer basically all of the "how" this gets done to @phildong - i am not sure what the plans are for release of that stuff, and if there are plans for making separate documentation for FPGA that we can just link to, or if that should all live here.
at the moment we are sort of operating with a manual, black box dependency, and it would be nice to make that more explicit -- like we will probably need to make updates to the FPGA code at some point, and it would be nice to be able to declare that version compatibility. e.g. if we change miniscope-io code to use some new features or new behavior of FPGA code, there would currently not be a good way for us to tell a user that the new version is incompatible with their existing FPGA code, etc. That's a separate discussion, but raising it here because it underscores the need for us to document what the bitfiles are and how they relate to the rest of the FPGA system. We are currently public pre-alpha on this project, but i think the FPGA stuff is all still private? so that would be a bridge i'd rather cross sooner than in a rush while the paper is coming together.
Continuing https://github.com/Aharoni-Lab/miniscope-io/issues/19
The stream daq relies on bitfiles - i believe these are the "programs" that run on the FPGA, but i actually have no idea.
We need to
This probably goes along with needing to document FPGA stuff generally, so i'll defer basically all of the "how" this gets done to @phildong - i am not sure what the plans are for release of that stuff, and if there are plans for making separate documentation for FPGA that we can just link to, or if that should all live here.
at the moment we are sort of operating with a manual, black box dependency, and it would be nice to make that more explicit -- like we will probably need to make updates to the FPGA code at some point, and it would be nice to be able to declare that version compatibility. e.g. if we change miniscope-io code to use some new features or new behavior of FPGA code, there would currently not be a good way for us to tell a user that the new version is incompatible with their existing FPGA code, etc. That's a separate discussion, but raising it here because it underscores the need for us to document what the bitfiles are and how they relate to the rest of the FPGA system. We are currently public pre-alpha on this project, but i think the FPGA stuff is all still private? so that would be a bridge i'd rather cross sooner than in a rush while the paper is coming together.