search

open-ephys / Bonsai.Miniscope

Bonsai package for controlling headborne, calcium imaging miniscopes
12 stars 6 forks source link

Add example workflow of usage with OE coax commutator. #12

Open ChucklesOnGitHub opened 1 year ago

ChucklesOnGitHub commented 1 year ago

Add example workflow of usage with OE coax commutator.

cjsha commented 1 year ago

in the form of a bonsai gallery?

ChucklesOnGitHub commented 1 year ago

Also an examples folder. The idea would be to have the Bonsai examples:

cjsha commented 1 year ago

Is there a particular example workflow you want in the repo and as a Bonsai gallery? I suppose we should post all example workflows in the repo and as Bonsai galleries?

Also, the repo in question is the onix-commutator repo?

ChucklesOnGitHub commented 1 year ago

What we had talked about with Jon was having an example folder in this repo, since it would be a specific set of examples for use with this package. The documentation already has workflows embedded for different applications. I'm now wondering if this would be redundant. How are the bonsai example galleries handled? Are they downloaded with packages or separately?

I'm thinking: a user downloads the miniscope bonsai package to use the miniscope and goes to the package docs or gallery examples to see examples of how to use it. This might circumvent the commutator-docs and that's why we had discussed having them here.

cjsha commented 1 year ago

It seems that galleries are downloadable separately from packages and that downloading a gallery will also install all of its associated packages/dependencies.

cjsha commented 1 year ago

I think if the user circumvents the commutator-docs, more power to them. If they are able to get up-and-running without having to reference the docs, that's a win for the commutator's design. They'll probably consult the docs later down-the-line if they run into trouble. Does this sound reasonable or am I missing something?

Instead of having the workflows in this repo, we can link people (1) to the commutator-docs repo where are the workflows are available for download and (2) to the commutator documentation where there are instructions. What do you think? I'm just trying to avoid repetition which gets messy sometimes.