|
| 1 | +<img alt="NWB Docathon Banner" src="../logos/nwb_logo_brain_text_transp_hor.png"> |
| 2 | + |
| 3 | +# NWB Docathon 2025 |
| 4 | + |
| 5 | + * [Survey](#survey) |
| 6 | + * [Dates and Location](#dates-and-location) |
| 7 | + * [Objective](#objective) |
| 8 | + * [Registration](#registration) |
| 9 | + * [Logistics](#logistics) |
| 10 | + * [Resources](#resources) |
| 11 | + * [What to bring?](#what-to-bring) |
| 12 | + * [Agenda](#agenda) |
| 13 | + * [Code of Conduct](#code-of-conduct) |
| 14 | + * [Disclaimer](#disclaimer) |
| 15 | + |
| 16 | + |
| 17 | +## Survey |
| 18 | + |
| 19 | +To let us know about your experience with NWB documentation, please feel free to complete the [NWB Documentation Survey](https://forms.gle/ihC8xLDeSX5XKyXN8) 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! |
| 20 | + |
| 21 | +## Dates and Location |
| 22 | + |
| 23 | +- **Dates:** May 1-2, 2025 |
| 24 | +- **Location:** Virtual |
| 25 | + |
| 26 | +## Objective |
| 27 | + |
| 28 | +The [Neurodata Without Borders](nwb.org) project is an effort to standardize the description and storage of neurophysiology |
| 29 | +data and metadata. NWB enables data sharing and reuse and reduces the energy barrier to applying data analytics both within |
| 30 | +and across labs. NWB has seen wide adoption in the neurophysiology community, and there are now over 300 datasets on the |
| 31 | +DANDI Archive in NWB, including data from the Allen Institute and the International Brain Laboratory. |
| 32 | + |
| 33 | +One of the goals of NWB is to ensure that members of the neuroscience community have the resources and tools to easily |
| 34 | +interact with their data. We are hosting a dedicated docathon to invite members of the community to join us in updating, |
| 35 | +improving, and expanding our documentation. The goal of this workshop is to make sure our documentation and |
| 36 | +educational materials are up-to-date and accessible to new and existing users of NWB. |
| 37 | + |
| 38 | +Many types of contributions are welcome, including updates to: |
| 39 | +* tutorials |
| 40 | +* how-to guides |
| 41 | +* docstrings |
| 42 | +* user documentation |
| 43 | +* developer documentation |
| 44 | +* recorded demo videos |
| 45 | + |
| 46 | +If you cannot attend but there is an a particular gap or aspect of the documentation you think could use improvement, |
| 47 | +please submit a documentation issue on the relevant GitHub repo. |
| 48 | + |
| 49 | +**Note:** All levels of experience are welcome! We have several existing open issues and welcome new contributors. |
| 50 | + |
| 51 | +## Registration |
| 52 | + |
| 53 | +Register for the event [here](https://forms.gle/YA5LBR4iSG8UVgpf6). |
| 54 | + |
| 55 | +## Logistics |
| 56 | + |
| 57 | +We will be use Zoom for the meeting and will send an email with a link to all registrants. |
| 58 | + |
| 59 | +## What to bring? |
| 60 | + |
| 61 | +* If you have any particular documentation issues you are interested in working on, feel free to open a new issue or |
| 62 | +comment on an existing issue in advance |
| 63 | + * [PyNWB issues](https://github.com/NeurodataWithoutBorders/pynwb/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22topic%3A%20docs%22&page=1) |
| 64 | + * [MatNWB issues](https://github.com/NeurodataWithoutBorders/matnwb/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22topic%3A%20docs%22) |
| 65 | + * [NWB Schema issues](https://github.com/NeurodataWithoutBorders/nwb-schema/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22topic%3A%20docs%22) |
| 66 | + |
| 67 | + |
| 68 | +## Agenda |
| 69 | + |
| 70 | +The tentative agenda is below. All times are in Pacific Time (PT): |
| 71 | +* May 1st: |
| 72 | + * 9:00AM - 9:30AM: Introduction to the docathon |
| 73 | + * 9:30AM - 10:00AM: Project discussion |
| 74 | + * 10:00AM - 5:00PM: Documenting / hacking |
| 75 | +* May 2nd: |
| 76 | + * 9:00AM - 9:30AM: Project check-in and discussion |
| 77 | + * 9:30AM - 5:00PM: Documenting / hacking |
| 78 | + |
| 79 | +## Code of Conduct |
| 80 | + |
| 81 | +Please see the [Code of Conduct](https://neurodatawithoutborders.github.io/nwb_hackathons/code_of_conduct) for all NWB events. |
| 82 | + |
| 83 | + |
| 84 | +## Disclaimer |
| 85 | + |
| 86 | +This website and related content were prepared as an account of or to expedite work sponsored at least in part by |
| 87 | +the United States Government. While we strive to provide correct information, neither the United States Government |
| 88 | +nor any agency thereof, nor The Regents of the University of California, nor any of their employees, makes any |
| 89 | +warranty, express or implied or assumes any legal responsibility for the accuracy, completeness, or usefulness of |
| 90 | +any information, apparatus, product, or process disclosed, or represents that its use would not infringe privately |
| 91 | +owned rights. Reference herein to any specific commercial product, process, or service by its trade name, trademark, |
| 92 | +manufacturer, or otherwise, does not necessarily constitute or imply its endorsement, recommendation, or favoring by |
| 93 | +the United States Government or any agency thereof, or The Regents of the University of California. Use of the |
| 94 | +Laboratory or University’s name for endorsements is prohibited. The views and opinions of authors expressed herein |
| 95 | +do not necessarily state or reflect those of the United States Government or any agency thereof or The Regents of |
| 96 | +the University of California. Neither Berkeley Lab nor its employees are agents of the US Government. Berkeley Lab |
| 97 | +web pages link to many other websites. Such links do not constitute an endorsement of the content or company and we |
| 98 | +are not responsible for the content of such links. |
| 99 | + |
| 100 | + |
0 commit comments