Skip to content

Update training materials #81

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.

Sign up for GitHub

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

Merged
merged 7 commits into from
May 12, 2025
Merged

Update training materials #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
aeee0fe
add images to event website instructions
stephprince May 8, 2025
c4e7d81
add organizing events faq page
stephprince May 8, 2025
abda6b3
update training materials and events pages
stephprince May 8, 2025
1a738ae
Merge branch 'main' into update-training-materials
stephprince May 12, 2025
b444391
add additional training material links
stephprince May 12, 2025
fa0ef51
add event email templates
stephprince May 12, 2025
3a6e0e0
add event agenda examples
stephprince May 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
189 changes: 189 additions & 0 deletions content/agenda-templates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,189 @@
---
title: "Agenda Templates"
bg_image: "/images/events/default-event-banner.png"
image: "/images/events/default-event-banner.png"
summary: "Example agenda templates for organizing Neurodata Without Borders (NWB) events."
draft: false
type: "page"
---

This page provides example agenda templates for different types of NWB workshops. These templates can be customized to fit your specific event needs.

## NWB \+ DANDI Overview Workshop Template

**Learning objective:** Attendees will learn about the NWB and DANDI software ecosystem, from data conversion and data publication to data reuse.

**Estimated duration:** 1 day. The talks can be covered in a half day, and the remaining time can be used for conversion projects, discussion, or 1:1 support.

**Prerequisites / requirements:** None, this workshop is intended for people new to the NWB ecosystem.

**Previous examples:** [NWB and DANDI Workshop at University of Washington](http://nwb.org/events/workshop-2025-uwashington/), [NWB and DANDI Workshop at CoSyNe 2025](http://nwb.org/events/cosyne-2025/), [NWB and DANDI Workshop at UNAM](http://nwb.org/events/workshop-2025-unam/)

### Example Agenda

| Start Time | End Time | Duration | Topic | Type |
| -----: | -----: | :-----: | :----- | :----- |
| 9:00 AM | 10:00 AM | 1 hour | Introduction to NWB and DANDI | Talk |
| 10:00 AM | 11:00 AM | 1 hour | Converting data to NWB | Talk |
| 11:00 AM | 11:45 AM | 45 min | Using the DANDI Archive | Talk |
| 11:45 AM | 12:30 PM | 45 min | Analyzing and streaming data on DANDI | Talk |

## Community Hackathon Template

**Learning objective:** Attendees will conduct development projects to contribute to the NWB software ecosystem.

**Estimated duration:** 3 days. Most of the time is spent on hacking. Depending on the group, it can be helpful to host breakout discussions for specific topics of interest. The hackathon concludes with final project presentations.

**Prerequisites / requirements:** This is not a training event, so some level of familiarity with NWB is helpful though not required.

**Previous examples:** [NWB Developer Hackathon 2024](http://nwb.org/events/hck18-2024-dev-hackathon-datajoint/), [Developer Days 2023](http://nwb.org/events/hck15-2023-janelia/), [Developer Days 2022](http://nwb.org/events/hck12-2022-remote/)

### Example Agenda

#### Day 1
The first day provides an overview of the hackathon and highlights planned breakout discussions

| Start Time | End Time | Duration | Topic | Type |
| -----: | -----: | :-----: | :----- | :----- |
| 9:00 AM | 9:15 AM | 15 min | Welcome to the Hackathon | Talk |
| 9:15 AM | 9:45 AM | 30 min | Developer updates on NWB | Talk |
| 9:45 AM | 10:30 AM | 45 min | Project overviews | Talk |
| 10:30 AM | 12:00 PM | 1.5 hours | Project Hacking | Hack |
| 12:00 PM | 1:00 PM | 1 hour | Lunch | Discussion |
| 1:00 PM | 2:00 PM | 1 hour | Breakout discussion topic #1 | Discussion |
| 2:00 PM | 3:30 PM | 1.5 hours | Project Hacking | Hack |
| 3:30 PM | 3:45 PM | 30 min | Break | Discussion |
| 3:45 PM | 5:15 PM | 1.5 hours | Project Hacking | Hack |

#### Day 2

| Start Time | End Time | Duration | Topic | Type |
| -----: | -----: | :-----: | :----- | :----- |
| 9:00 AM | 9:05 AM | 5 min | Welcome to the hackathon | Talk |
| 9:05 AM | 12:00 PM | 3 hours | Project Hacking | Hack |
| 12:00 PM | 1:00 PM | 1 hour | Lunch | Discussion |
| 1:00 PM | 2:00 PM | 1 hour | Breakout discussion topic #2 | Discussion |
| 2:00 PM | 3:30 PM | 1.5 hours | Project Hacking | Hack |
| 3:30 PM | 3:45 PM | 30 min | Break | Discussion |
| 3:45 PM | 5:15 PM | 1.5 hours | Project Hacking | Hack |

#### Day 3

| Start Time | End Time | Duration | Topic | Type |
| -----: | -----: | :-----: | :----- | :----- |
| 9:00 AM | 9:05 AM | 5 min | Welcome to the hackathon | Talk |
| 9:05 AM | 12:00 PM | 3 hours | Project Hacking | Hack |
| 12:00 PM | 1:00 PM | 1 hour | Lunch | Discussion |
| 1:00 PM | 2:00 PM | 1 hour | Project Hacking | Hack |
| 2:00 PM | 4:00 PM | 2 hours | Final project presentations | Discussion |
| 4:00 PM | 4:15 PM | 15 min | Break | Discussion |
| 4:15 PM | 5:15 PM | 1 hour | Group discussion and feedback | Discussion |

## Data Reuse Workshop Template

**Learning objective:** Attendees will learn how to work with data on DANDI and will conduct a data reuse project to re-analyze existing data on NWB.

**Estimated duration:** 5 days. The first day covers the core material about working with data on DANDI. The second day can focus on additional guest lectures to introduce attendees to different tools and datasets on DANDI. The remaining time can be spent on project hacking / analysis, with the workshop concluding in project presentations.

**Prerequisites / requirements:** In previous workshops, we have required participants to propose a project with specific dandisets as part of their application. These projects can change throughout the course of the workshop.

**Previous examples:** [NeuroDataReHack 2024](http://nwb.org/events/hck21-2024-janelia-ndrh/), [NeuroDataReHack 2023](http://nwb.org/events/hck16-2023-granada-rh/), [NeuroDataReHack 2022](http://nwb.org/events/hck14-2022-seattle-rh/)

### Example Agenda

#### Day 1
The first day focuses on providing attendees with an introduction to NWB and DANDI and to discuss project plans

| Start Time | End Time | Duration | Topic | Type |
| -----: | -----: | :-----: | :----- | :----- |
| 9:00 AM | 9:30 AM | 30 min | Welcome to the Data Reuse Workshop | Talk |
| 9:30 AM | 10:30 AM | 1 hour | Intro to NWB and DANDI | Talk |
| 10:30 AM | 11:30 AM | 1 hour | How to read NWB files | Talk |
| 11:30 AM | 12:30 PM | 1 hour | Project Hacking | Hack |
| 12:30 PM | 1:30 PM | 1 hour | Lunch | Discussion |
| 1:30 PM | 2:30 PM | 1 hour | A tour of NWB Dandisets and searching tools | Talk |
| 2:30 PM | 3:00 PM | 30 min | A tour of NWB analysis software | Talk |
| 3:00 PM | 3:30 PM | 30 min | Break | Talk |
| 3:30 PM | 4:30 PM | 1 hour | Project roundtable | Discussion |
| 4:30 PM | 5:30 PM | 1 hour | Speed networking | Discussion |

#### Day 2 - 4

The middle days can include invited speakers for different analysis tools and approaches,
with the majority of the time spent on project hacking.

| Start Time | End Time | Duration | Topic | Type |
| -----: | -----: | :-----: | :----- | :----- |
| 9:00 AM | 9:15 AM | 15 min | Welcome to the workshop | Talk |
| 9:15 AM | 11:15 AM | 2 hours | Invited lectures | Tutorial |
| 11:15 AM | 12:00 PM | 45 min | Project hacking | Hack |
| 12:00 PM | 1:00 PM | 1 hour | Lunch | Discussion |
| 1:00 PM | 3:00 PM | 2 hours | Project hacking | Hack |
| 3:00 PM | 3:15 PM | 15 min | Refreshments break | Discussion |
| 3:15 PM | 5:15 PM | 2 hours | Project hacking | Hack |

#### Day 5

The last day should reserve the majority of time for project presentations and overall
discussion and feedback on the workshop and next steps.

| Start Time | End Time | Duration | Topic | Type |
| -----: | -----: | :-----: | :----- | :----- |
| 9:00 AM | 9:15 AM | 15 min | Welcome to the workshop | Talk |
| 9:15 AM | 12:00 PM | 1.75 hours | Project hacking | Hack |
| 12:00 PM | 1:00 PM | 1 hour | Lunch | Discussion |
| 1:00 PM | 4:00 PM | 3 hours | Project presentations | Hack |
| 4:00 PM | 4:15 PM | 15 min | Refreshments break | Discussion |
| 4:15 PM | 5:15 PM | 1 hour | Discussion and feedback | Discussion |


## Data Conversion Workshop Template

**Learning objective:** Attendees will learn how to convert their data to NWB and publish it on the DANDI Archive.

**Estimated duration:** 2-3 days. The core material on data conversion can be covered on the first day. Depending on the interests of the audience, additional lectures can be given on domain specific topics or advanced data I/O.

**Prerequisites / requirements:** Data for conversion.

**Previous examples:** [NWB Data Conversion Workshop 2025](http://www.nwb.org/events/hck22-2025-dataconversion-remote/), [NWB Data Conversion Workshop 2024](http://www.nwb.org/events/hck19-2024-remote/), [NWB User Days 2023](http://www.nwb.org/events/hck15-2023-janelia/)

### Example Agenda

#### Day 1
The first day focuses on providing attendees with an introduction to NWB and the conversion tools used.

| Start Time | End Time | Duration | Topic | Type |
| -----: | -----: | :-----: | :----- | :----- |
| 9:00 AM | 9:15 AM | 15 min | Welcome to the Data Conversion Workshop | Talk |
| 9:15 AM | 10:00 AM | 45 min | Overview of NWB | Talk |
| 10:00 AM | 11:00 AM | 1 hour | NWB GUIDE | Tutorial |
| 11:00 AM | 12:00 PM | 1 hour | NeuroConv, PyNWB, MatNWB | Tutorial |
| 12:00 PM | 12:30 PM | 30 min | Project sharing | Discussion |
| 12:30 PM | 1:10 PM | 40 min | Publishing data and using the DANDI Archive | Tutorial |
| 1:10 PM | 5:00 PM | 4 hours | Data conversion hacking | Hack |

#### Day 2

The second day focuses on domain-specific data conversion. This can be tailored depending on the needs of the audience and the types of data they are using.

| Start Time | End Time | Duration | Topic | Type |
| -----: | -----: | :-----: | :----- | :----- |
| 9:00 AM | 9:10 AM | 10 min | Welcome to the workshop | Talk |
| 9:10 AM | 9:55 AM | 45 min | Introduction to Extracellular Electrophysiology | Tutorial |
| 9:55 AM | 10:40 AM | 45 min | Introduction to Optical Physiology | Tutorial |
| 10:40 AM | 11:25 AM | 45 min | Introduction to Intracellular Electrophysiology | Tutorial |
| 11:30 AM | 4:00 PM | 4.5 hours | Data conversion hacking | Hack |

#### Day 3

The third day focuses on advanced data topics such as different NWB backends, writing NWB extensions, and using external resources with HERD.

| Start Time | End Time | Duration | Topic | Type |
| -----: | -----: | :-----: | :----- | :----- |
| 9:00 AM | 9:10 AM | 10 min | Welcome to the workshop | Talk |
| 9:30 AM | 10:00 AM | 30 min | Advanced data I/O and backends | Talk |
| 10:00 AM | 10:15 AM | 15 min | NWB Extensions | Talk |
| 10:15 AM | 10:30 AM | 15 min | Introduction to terminologies and HERD | Talk |
| 10:30 AM | 12:30 PM | 2 hours | Data conversion hacking | Hack |
| 12:30 PM | 1:30 PM | 1 hour | Final project presentations | Discussion |
| 1:30 PM | 2:00 PM | 30 min | Wrap-up and final surveys | Discussion |
16 changes: 11 additions & 5 deletions content/create-event-website.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,23 @@
---
title: "How to Create an Event Website"
title: "Creating an Event Website"
summary: "Instructions for creating a website for your NWB event."
draft: false
type: "page"
---

# How to Create an Event Website
# Creating an Event Website

Follow these steps to create a website for your NWB event:

1. Go to the NeurodataWithoutBorders website <a href="https://github.com/NeurodataWithoutBorders/neurodatawithoutborders.github.io" target="_blank">GitHub repo</a>
2. Fork and clone the repo

![NWB Website GitHub Repository](/images/nwb_website_github_repo.png)

3. Create a new branch
4. Create a new event markdown file in the content/events folder
5. Fill in the file with information about your event. See previous events for examples for different workshops and flags
6. Submit a pull request from your event
4. Create a new event markdown file in the `content/events` folder. See previous events for examples for different workshops. For self-organized workshops, please add "Self-organized" to the event type section (e.g. "Self-organized Showcase").

![Previous Events Examples](/images/previous_events.png)

5. Fill in the file with information about your event.
6. Submit a pull request to the GitHub repo to merge the branch with your changes into the main events list
159 changes: 159 additions & 0 deletions content/email-templates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,159 @@
---
title: "Email Templates"
bg_image: "/images/events/default-event-banner.png"
image: "/images/events/default-event-banner.png"
summary: "Email templates for organizing Neurodata Without Borders (NWB) events."
draft: false
type: "page"
---

<style>
.email-template {
background-color: #f8f9fa;
border: 1px solid #e9ecef;
border-radius: 5px;
padding: 1.5rem;
margin-bottom: 2rem;
position: relative;
}

.copy-btn {
position: absolute;
top: 10px;
right: 10px;
background-color: #114B7C;
color: white;
border: none;
border-radius: 4px;
padding: 5px 10px;
font-size: 14px;
cursor: pointer;
transition: background-color 0.3s;
}

.copy-btn:hover {
background-color: #d17128;
}

.template-content {
white-space: pre-wrap;
font-family: "Inter", sans-serif;
margin-top: 10px;
}
</style>

This page provides email templates that can be used when organizing NWB events. These templates can be customized to fit your specific event needs. Click the "Copy" button to copy the entire template to your clipboard.

<script>
function copyToClipboard(id) {
const text = document.getElementById(id).innerText;
navigator.clipboard.writeText(text).then(function() {
const btn = document.querySelector(`button[onclick="copyToClipboard('${id}')"]`);
const originalText = btn.innerText;
btn.innerText = "Copied!";
setTimeout(function() {
btn.innerText = originalText;
}, 2000);
}).catch(function(err) {
console.error('Could not copy text: ', err);
});
}
</script>

## Advertising Your Workshop

**Subject:** [Event name] at [Event location]

<div class="email-template">
<button class="copy-btn" onclick="copyToClipboard('advertising-template')">Copy</button>
<div id="advertising-template" class="template-content">

We have are excited to announce our upcoming [Event name]!

**Date:** [Event dates]
**Time:** [Event times]
**Format:** [Event format / location]

Please join us at [Event name], a free workshop where we will train members of the community on how to convert their data to NWB and publish it on the DANDI Archive. During this workshop, we will introduce multiple sets of tools with varying levels of flexibility for converting your data, including NWB GUIDE, a no-code user interface for data conversion.

**Who should attend?**
Researchers of all levels of coding experience interested in converting their data and/or publishing data to DANDI.

**How to participate:**
Please register at [Registration form link] and see the [Event Webpage] for more details.

Let us know if you have any questions!

Best,
[Sender name]</div>
</div>

## Invitation to Presenters

**Subject:** Invitation to present at [Event Name] on [Event Date]

<div class="email-template">
<button class="copy-btn" onclick="copyToClipboard('invitation-template')">Copy</button>
<div id="invitation-template" class="template-content">

Hi [Presenter name],

We would like to invite you or a representative from your team to present [Tool/Topic/Dataset] at our [Event name] on [Event dates / times]. The aim of this virtual event is to promote secondary analysis of open neurophysiology data in NWB and on DANDI, as well as open-source tools for neurophysiology data analysis and the NWB ecosystem. This event is virtual and open to anyone, please see the [Event Webpage] for more details.

Presentation details: [Provide information about presentation format or required materials]

If you are interested in presenting, please sign up for this event using [Presenter registration form], and we will provide you with further details and updates leading up to the event.

If you are interested in attending the event without presenting, please sign up using this [Attendee registration form] to receive updates about the event.

Please do not hesitate to reach out to us if you have any questions.

Best,
[Sender name]</div>
</div>

## Pre-Workshop Email Template

**Subject:** Information for [Event Name] on [Event Date]

<div class="email-template">
<button class="copy-btn" onclick="copyToClipboard('pre-workshop-template')">Copy</button>
<div id="pre-workshop-template" class="template-content">

Dear workshop attendees,

We are looking forward to seeing you on [Date] at the [Event Name / Webpage link] at [Location / Virtual information].

If you have not already, please complete the items below:
- Follow the installation instructions for NWB GUIDE and PyNWB/MatNWB on the "what to bring" section of the workshop website.
- Register for DANDI Hub.
- Join the workshop slack channel. We will use slack for general communications during the workshop.
- Add a data conversion project to this [Projects Google Doc link]. If you are planning to convert your data (or have any other NWB-related project you would like to work on), please add a short description to the doc using the template provided. This will help us better support your data conversion projects and facilitate collaboration among attendees.

Let us know if you have any questions!

Best,
[Sender name]</div>
</div>

## Post-Workshop Email Template

**Subject:** Information for [Event Name] on [Event Date]

<div class="email-template">
<button class="copy-btn" onclick="copyToClipboard('post-workshop-template')">Copy</button>
<div id="post-workshop-template" class="template-content">

Hi everyone,

Thank you for attending the [Event name]! We hope that, from the event, you have learned more about the NWB software ecosystem, made great progress on your projects, and had engaging discussions with fellow attendees.

Your feedback is extremely valuable to us to help improve our future events. If you have already filled out our survey, thank you! If you have not, please fill out [Post-Workshop Survey Link]. It takes only a couple minutes.

Also, please spend a couple minutes to update your project progress in the [Projects Google Doc link]. This helps us write a report for our funders and supporters. We encourage you to continue to use the workshop slack channel for any follow up questions or project updates.

Thank you, and we hope to see you again at the next NWB event.

Best,
[Sender name]</div>
</div>
Loading
Loading