Edit this page

nwb_hackathons

:rewind: Back to main page

What should my hackathon project look like?

Since this is a user hackathon, many project will likely focus on integration of a select dataset with NWB:N. However, projects may span a broad range of topics beyond just integrating new data with NWB:N, e.g., developing new features for PyNWB, exploring new problems, or creating documentation. Design your project in a way that:

  1. You can make significant progress during the hackathon (i.e., in ~1 day). This also means that you should come prepared for the hackathon. For example, if your project is about integrating data with NWB:N then you should a) know the data, b) ideally have scripts for reading the data in Python already preparted, and c) bring the data with you to the hackathon.
  2. The project is a) relevant to NWB:N and b) useful either as is or be something that you or someone else can build on after the hackathon

Does everyone need to have their own project?

Everyone should be part of a project, but not everyone must have their own project. Hacking in teams is fun!

How can I talk with other attendees about my project?

We have created a GitHub team for the hackathon. You can use the following team forum to chat with attendees before and during the hackathon: https://github.com/orgs/NeurodataWithoutBorders/teams/hck05

How to create a new project

When you are ready, create a new project by creating a new README.md file in a new subfolder of the projects folder using the provided project description template and add your project to the project list in the PROJECTS.md file. Step-by-step instructions for creating a new project using GitHub are:

  1. Open project description template and copy its full content to the clipboard
  2. Go back to the projects folder on GitHub
  3. Click on “Create new file” button
  4. Type YourProjectName/README.md
  5. Paste the previously copied content of project template page into your new README.md
  6. Update at least your project’s title, key investigators, and project description sections
  7. Add a link to your project to the project list

Note: some steps above may require creating a pull request until your account is given write access.