NWB:N support

[bendichter]

Hi miniscoPy dev team. Nice work on this package! It looks very convenient and well-documented. I see that NWB support is a goal for you so I wanted to let you know about a few efforts and start a thread for discussing how support might be accomplished in this project.

When toolboxes such as miniscoPy look into NWB support, I generally recommend that you think about it in 2 stages: 1) read in NWB files 2) write NWB files. Implementing read or write independently would be a valuable step, and clearly implementing both would be ideal.

I am currently developing a small extension to NWB:N to handle meta-data specifically associated with miniscopes. It is still in alpha and I do not have that much experience with miniscopes myself, so I am going off of data that has been shared with me. I would welcome suggestions for any additional data you think might be important for future users to understand the data.

The CaImAn team and I just added NWB:N integration (both read and write). You can see these changes here. I think a lot of these changes will be transferable to this package. We've been putting together a best practices document to help adopters with common pitfalls. Once you have something together in this repo, we'd be happy to look it over and make sure it uses NWB most efficiently.

Ultimately, we would like to add this package to our list of NWB:N tools. Generally the bar for this is to have NWB support (read or write) merged into the master branch along with a demo illustrating its usage.

Let us know if you are interested in NWB support and we'll be happy to help!

fyi @rly (NWB:N core dev)