search

NeurodataWithoutBorders / pynwb

A Python API for working with Neurodata stored in the NWB Format
https://pynwb.readthedocs.io
Other
174 stars 85 forks source link

[Documentation]: Refactor Configuration Tutorial #1906

Open mavaylon1 opened 2 months ago

mavaylon1 commented 2 months ago

What would you like changed or added to the documentation and why?

Refactor the configuration tutorial to be more user approachable in terms of language.

Do you have any interest in helping write or edit the documentation?

Yes.

Code of Conduct

rly commented 2 months ago

Ref: https://github.com/NeurodataWithoutBorders/pynwb/pull/1829#discussion_r1610434882

rly commented 2 months ago

I think we should also explain to the user in the documentation that the config file in https://github.com/NeurodataWithoutBorders/pynwb/tree/dev/src/pynwb/config/nwb_config.yaml is maintained by us and recommended for use and how to use it. We can also tell people to copy it into a new file and modify it for their own use if they want to customize the config file.

Understanding this now, I think that this config should be the default setting, but if so, we need to curate the species term set to be all the common species used in neurophysiology experiments.

Ref: https://github.com/NeurodataWithoutBorders/pynwb/pull/1829/files#r1610743030