Live script demonstration of one (1) spike visualization workflow associated to pipeline and up to three (3) use case builds of other developer scripts without demonstration"

[vijayiyer05]

One live script should be polished, i.e. with narrative text, and serve as a public demonstration of a concrete pipeline implementation (e.g. from Issue #2).

Additional scripts (live scripts preferred, but not required) are encouraged and anticipated for other pipeline use cases, i.e. as integration tests for the toolkit.

[yambottle]

Hi @vijayiyer05 ,

Just want to confirm with you, is there any requirements that we need to add some basic visualizations/plots in the Live scripts using the pipeline result? Or you actually just want a 'How-to' Live scripts as an example as well as an integration test?

[vijayiyer05]

Hi @yambottle, I'd say yes the one "polished" live script would ideally have a simple visualization or two. The idea will be to render the one live script as an invitation to potential users, i.e. right at the outset of the README as done here. Having a visualization or two would be the most impactful.

This could likely leverage the Neuropixel Utils code (which @apjanke still plans to add I think!). This will give some ready plotting utilities to make this straightforward I believe.

Having some level of "how to" narrative text is the other core aspect as you describe.

In terms of the proportions and styles, I've lately been discussing two styles of live scripts in different projects:

• demos which are sparser with text and show more the results and the "why"
• tutorials which are more didactic aiming to explain the "how"

Both would have figures, but the demo style would be more focused on those.

From my perspective, either would be a good option for the purpose of introducing users and you might pick either based on preference.