NWB Docathon 2025

NWB Docathon 2025

May 01, 2025 - May 2, 2025

Virtual

Docathon

Summary

A virtual event focused on updating, improving, and expanding NWB documentation to ensure it is up-to-date and accessible to new and existing users.

Dates and Location

  • Dates: May 1-2, 2025
  • Location: Virtual

Objective

The Neurodata Without Borders project is an effort to standardize the description and storage of neurophysiology data and metadata. NWB enables data sharing and reuse and reduces the energy barrier to applying data analytics both within and across labs. NWB has seen wide adoption in the neurophysiology community, and there are now over 300 datasets on the DANDI Archive in NWB, including data from the Allen Institute and the International Brain Laboratory.

One of the goals of NWB is to ensure that members of the neuroscience community have the resources and tools to easily interact with their data. We are hosting a dedicated docathon to invite members of the community to join us in updating, improving, and expanding our documentation. The goal of this workshop is to make sure our documentation and educational materials are up-to-date and accessible to new and existing users of NWB.

Many types of contributions are welcome, including updates to:

  • Tutorials
  • How-to guides
  • Docstrings
  • User documentation
  • Developer documentation
  • Recorded demo videos

If you cannot attend but there is a particular gap or aspect of the documentation you think could use improvement, please submit a documentation issue on the relevant GitHub repo.

Note: All levels of experience are welcome! We have several existing open issues and welcome new contributors.

Survey

To let us know about your experience with NWB documentation, please feel free to complete the NWB Documentation Survey even if you are unable to participate in the Docathon. This survey is a great way to help us better understand your experience with the NWB documentation and how we can improve!

Logistics

We will use Zoom for the meeting and will send an email with a link to all registrants.

What to bring?

If you have any particular documentation issues you are interested in working on, feel free to open a new issue or comment on an existing issue in advance:

Agenda

The tentative agenda is below. All times are in Pacific Time (PT):

May 1st:

  • 9:00AM - 9:30AM: Introduction to the docathon
  • 9:30AM - 10:00AM: Project discussion
  • 10:00AM - 5:00PM: Documenting / hacking

May 2nd:

  • 9:00AM - 9:30AM: Project check-in and discussion
  • 9:30AM - 5:00PM: Documenting / hacking

Event Details

Date & Time

May 1, 2025 - May 2, 2025

Location

Virtual

Event Type

Docathon

Organizers

  • NWB Team

Registration

Register for the event here.