Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improvements for next iteration of tutorial notebooks #3

Open
rly opened this issue Jul 30, 2020 · 0 comments
Open

Improvements for next iteration of tutorial notebooks #3

rly opened this issue Jul 30, 2020 · 0 comments

Comments

@rly
Copy link
Contributor

rly commented Jul 30, 2020

New users are using the tutorial jupyter notebooks as a template for their data conversion scripts. This is problematic because the tutorial notebooks do not cover all the various use cases, e.g., adding raw data from an ecephys experiment.

The tutorial should

  1. point users to the PyNWB API documentation
  2. demonstrate use of the validator since it is possible to use PyNWB to create invalid files
  3. explain common errors such as re-creating a table column that already exists or attempting to set nwbfile.subject twice and how to resolve them

It would also be helpful to provide users with a template conversion script/notebook that works on a dummy data file that is as comprehensive as possible, using every optional field, and with comments noting how data can be stored in other ways.

This was also suggested at Cosyne.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant