Welcome to the IOOS Code Sprint

We’re glad you’re here!

This guide explains how the code sprint is being organized, from how we will be communicating, what activities we envisage you will undertake, how we suggest you access data and store your code/outputs.

Overview

In this guide we’ll cover:

We recommend that when you first sit down with your group, someone volunteers to serve as the chair for your topic. This person should be responsible for:

  • Ensuring that the group works to the suggested agenda.
  • The group is ready to present their work during their presentation slot(s).
  • The code/outputs are well organized. This is an excellent way of getting some team management experience and so we emphasize that this person does not need to be somebody who is already leading a topic.
  • Updating the #code-sprint-2024 channel every 45 minutes with a short update on your track’s activity. Make sure to #tag your topic’s channel.

How our event is structured

The event is a hybrid format with attendees both in-person at The Wharf, and virtual connecting through Zoom and Slack.

For virtual attendees

Before the week of the Code Sprint, you will receive a link to a Google Calendar for the Code Sprint events. Below is a description of how each of those events relates to the Code Sprint as a whole.

MAIN ROOM - This will be the virtual connection to the parts of the agenda that are for the entire Code Sprint audience (Introductions, Daily kickoff, and Daily recap).

[track] - There are individual Zoom breakout rooms for each of the Tracks listed here. This is where participants will be spending the majority of their time. These spaces will be available for you to connect to during the break group portions of the event. You can enter and exit the sprint track rooms as you wish.

For in-person attendees

  • Make sure the room you are in has a connection to the appropriate Zoom breakout room for virtual attendees.
  • Make an announcement on the #code-sprint-2024 channel, identifying the topic to be worked on and the Zoom breakout room information.
  • Check the agenda or the #code-sprint-2024 channel on Slack for more detailed information.

How we are communicating

We are using:

  • Zoom for the talks and breakout groups. All participants will be invited to all the meetings so virtual attendees can easily move between them as needed.
  • Slack for text-based chat, sharing of ideas, announcements and technical support (we have a channel for each project group, plus the main #code-sprint-2024 channel.
  • Resources will be where any slides, or resources can be linked for reference during the event of afterwards (this page will live on!).
  • Topic pages will fill out as the sprint progresses. Anyone can submit a change to these pages.

How we are storing code, data and outputs

Each project should have:

  • A GitHub repository, which you can use to share you code and the outcomes of your work

We ask that by the end of the code sprint:

  1. Your project’s GitHub repository has a README file (or GitHub issue), identifying what work you did, how far you got and what the next steps required are
  2. You identify one (or more) key figures/outcomes that could be showcased at the Annual DMAC meeting.

Where to go for help

The best way to contact us during the code sprint is to use the channel #code-sprint-2024 on Slack.

A note on bandwidth at the event

For those attending in-person, at The Wharf, we will be using the wifi network provided. If you need high bandwidth to download large amounts of data for your project we recommend using cloud services, preload on local machine, or bring usb sticks. If you have special circumstances or questions, please post your requirements to the #code-sprint-2024 Slack channel and we can see how we can accommodate your needs.

Feedback

We really appreciate your feedback on this code sprint, in the hope that we can improve future events for yourself and others. Near the end of the code sprint we will send round a link to a feedback form for you to complete.

Questions?

Email (or Slack) Matt Biddle (mathew.biddle@noaa.gov)!