-
Notifications
You must be signed in to change notification settings - Fork 38
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move/copy logistics and projects to both ohw23 and ohw22
- Loading branch information
Showing
20 changed files
with
553 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# Getting Help | ||
|
||
We know how overwhelming all of this information can be. Here is some for asking questions and figuring out where to turn for help. | ||
|
||
You can ask anything on the Slack `#ohw22-general` channel, any time. Organizers and helpers are monitoring this channel, and some of your fellow hackweek participants may be able to help you! Also, feel free to send a direct message on Slack to any of the organizers or helpers. | ||
|
||
## Helpdesk | ||
|
||
We've set up the `#ohw22-helpdesk` Slack channel to ask technical questions (or other types of questions, if you'd like). | ||
|
||
We will set up some helpdesk Slack user group that you can use to tag your question as, say, about Python. We'll list and describe those groups here. If you know the rough category of help that you may need, please tag one of the helpdesk user groups to get their attention. All help usergroups can be found by typing `@help-` and Slack will prompt with options. | ||
|
||
You are also welcome to direct message the helpers if you don't feel comfortable asking questions publicly. | ||
|
||
### Slack help groups | ||
|
||
- `@help-infrastructure` - For issues regarding the JupyterHub, Slack, Github, and Zoom. | ||
- `@help-projects` - For help with managing projects, for instance asking how to set up a new repo, or organize meetings. | ||
- `@help-python` - Questions about Python programming. | ||
- `@help-r` - Questions about R programming. | ||
- `@help-ml` - Questions about machine learning. | ||
- `@help-git` - Questions about git. | ||
- `@help-tutorials` - For help with tutorial logistics, like cloning the notebooks. | ||
- `@help-website` - If there are any issues with the website tag us to take a look. | ||
|
||
## During tutorials | ||
|
||
- Ask questions on Slack! Use the `#ohw22-tutorials` channel to ask questions or check out answers to questions others have posed. We will use this same channel every day. Several of us will be monitoring this channel and addressing your questions throughout the tutorials | ||
- **Vote up** questions from others to help the moderators prioritize which questions to ask the speaker during tutorials. | ||
- Tutorial moderators will mark questions that are best answered by the instructor and ask helpers (and anyone else!) to answer the rest in real time. Then when the instructor ask if there are questions the moderators will read those reserved for the instructor. | ||
- Zoom Chat will **not** be available. Ask on Slack! | ||
- You will be muted at the start of the tutorial presentation. The moderator will review questions on Slack and ask the questions to the instructor during Q&A time. | ||
|
||
## Projects | ||
|
||
See the [Projects Getting Started page](../projects/steps.md). Feel free to post a question on the `#ohw22_project` channel, too. | ||
|
||
## Reporting a Code of Conduct violation | ||
|
||
Harassment and other [Code of Conduct violations](../../about/code-of-conduct.md) reduce the value of OceanHackWeek for everyone. If someone makes you or anyone else feel unsafe or unwelcome, please report it as soon as possible to one of the instructors. You can make a report either personally or anonymously. **Anonymous reports can be made [here](https://oceanhackweek.wufoo.com/forms/zep2ybt1swlulc/).** | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# Logistics Overview | ||
|
||
Some of you will participate in person at various satellite events, and others will participate virtually from time zones all over the world. As we have learned throughout the pandemic, each of these gathering styles has strengths and weaknesses. We are committed to providing an engaging and full experience for everyone and will strive to facilitate cross communication and collaboration across all participants. | ||
|
||
## Time | ||
|
||
OceanHackWeek 2022 will take place August 15-19. | ||
|
||
**In-person participants** will gather as for times as directed by the satellite organizers. While **virtual participants** may choose to engage primarily with this group and schedule via Zoom and Slack, we strongly encourage you to join the program designed specifically as a virtual event. The virtual event will be split into two schedules and groups based on the distribution of participant time zones, in a 3-hour daily block of formal, live activities. The **larger virtual event** will take place 11:00am - 2:00pm PDT / 18:00 - 21:00 UTC. | ||
|
||
Detailed schedules are available [Schedule page](../../ohw22/schedule.md). | ||
|
||
## Channel of communication: Slack | ||
|
||
We will use the [OceanHackWeek Slack workspace](http://oceanhackweek.slack.com/) as the main channel of communication before, during, and after the hackweek. You should have received an invitation to join this workspace. If you haven't seen it in your inbox, check your spam folder, or email us at *[email protected]*. | ||
|
||
[Go directly from a channel or direct message chat into a voice or video chat](https://slack.com/help/articles/216771908-Make-calls-in-Slack), with screen-sharing capability. This will be particularly useful during hack project time. | ||
|
||
## OHW JupyterHub ("The Hub") and GitHub | ||
|
||
- OHW JupyterHub ("The Hub"): [https://oceanhackweek.2i2c.cloud](https://oceanhackweek.2i2c.cloud) | ||
- OHW GitHub organization: [https://github.com/oceanhackweek](https://github.com/oceanhackweek) | ||
|
||
## Tutorials broadcasting | ||
|
||
We will use Zoom to broadcast all tutorials. The Zoom link will be distributed via Slack. | ||
|
||
## Hack projects | ||
|
||
See [Project overview](../projects/index.md) and [Hacking at OHW22](../projects/steps.md) for more info. | ||
|
||
## Getting Help | ||
|
||
See the [Getting Help page](getting_help.md) for guidance and links to have your questions answered or connect with organizers with concerns. | ||
|
||
```{toctree} | ||
:hidden: | ||
Overview <./overview> | ||
Getting Help <getting_help> | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
<!-- | ||
++++++++++++++++++++++++++++++++++++++++++++++++++++ | ||
NOT USING THIS PAGE FOR OHW2020, CONSIDER REVIVING FOR LATER IN-PERSON EVENT. | ||
++++++++++++++++++++++++++++++++++++++++++++++++++++ | ||
--> | ||
|
||
|
||
|
||
# Project Guidelines | ||
|
||
## Project Template | ||
Each project requires a brief project summary in the README.md of each GitHub project folder. Below is a template for the project summary. | ||
|
||
### Project title | ||
|
||
Brief title describing the proposed work. | ||
|
||
### Collaborators on this project | ||
|
||
List all participants on the project. | ||
|
||
### The problem | ||
|
||
What oceanographic data science problem are you going to explore? Try to focus on the data science/methodology problem first, followed by the location-specific oceanographic example afterwards. The project is likely more engaging for fellow hackers if it is centered around common data science problems. For example, the project could be to develop a workflow in Python to analyze CTD time series from multiple data sources, instead of emphasizing and focusing only on temperature variations in one very specific part of the ocean. | ||
|
||
### Application example | ||
|
||
Here is where you follow up with a location-specific example of where the data science methodology applies and list example datasets (size, format, how to access) that could be used for this exploration. | ||
|
||
### Specific tasks | ||
|
||
List the specific tasks you want to accomplish. | ||
|
||
### Existing methods | ||
|
||
How would you or others traditionally try to address this problem? | ||
|
||
### Proposed methods/tools | ||
|
||
Building from what you learn at Oceanhackweek, what new approaches would you like to try to implement? | ||
|
||
### Background reading | ||
|
||
Optional: links to manuscripts or technical documents for more in-depth analysis. | ||
|
||
|
||
|
||
## Project Ideas | ||
* Developing tutorials for using NASA data on the cloud. | ||
* Working on an efficient open source matchup tutorial for satellite orbital data and in situ point or trajectory data. | ||
* Developing an OSS algorithm development toolbox in Python to deal with a 400GB AMSR brightness temperature - in situ matchup database. | ||
<!-- | ||
* [Argovis - a visualualization and API for accessing Argo data](https://argovis.colorado.edu/ng/home) | ||
* [OHW18 Projects](https://oceanhackweek.github.io/projects.html) | ||
--> | ||
|
||
|
||
## Project Data Storage | ||
|
||
If your group needs to store data for project use during Oceanhackweek, depending on the volume, below is what we recommend: | ||
- Whenever possible, public datasets like OOI, ARGO, satellite, etc. should be accessed remotely in the Jupyter notebook through standard protocols like OPeNDAP or other programmatic approaches. | ||
- **Data that are <1 MB**: can be included directly in the project Github repository. | ||
- **Data that are <10 GB**: can be stored in your home space on ocean.pangeo.io. When you are accessing data from the internet, it is often useful to have a cell in the notebook that downloads such data into your home space if those data are not there, otherwise do nothing if they are already there. You can also upload a local dataset through the pangeo interface. You can upload only one file as of now, so if you have multiple files you will need to zip them and unzip them later from the terminal. These are two ways to fetch and store larger datasets locally if they are not enormous. | ||
- **Data that are >10 GB**: are best stored in a cloud-optimized format. If you don't already have the data on the cloud, please talk to the instructors about your needs and how you anticipate using the data. We can help you prepare and upload the data to [cloud object storage](https://en.wikipedia.org/wiki/Cloud_storage) with Oceanhackweek support. | ||
- Questions? Feel free post on Slack #project channel or email [[email protected]](mailto:[email protected]). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# Project Overview | ||
|
||
Collaborative projects are a key component of OceanHackWeek, in which you get to interact with others closely and apply new skills to make something exciting happen: it can be creating tools to streamline access of a particular data source, visualizing some high density data interactively, testing existing models with new data sources, or anything else you may want to do at the intersection of oceanography and data science. | ||
|
||
## What is a Hack? | ||
|
||
A "hack" is a small project that aims to solve a specific problem using computational tools. | ||
|
||
Examples of hacks include: | ||
|
||
* Build a working demo of a new or modified algorithm | ||
* Outline of a larger project, with some key features scoped | ||
* Visualization of an old dataset in a new manner | ||
* Modify an algorithm and apply it to a new dataset | ||
* Combine two pre-existing pieces of code to perform some new function | ||
* Create a tool to apply to work with existing code, datasets | ||
* Transform code from one language to another to use with other tools | ||
* Update old code to run faster, on new machines, and/or more efficiently | ||
* Extend an existing project with an additional feature | ||
* Simplify code to be more maintainable, aka "paying technical debt" | ||
|
||
|
||
|
||
## Why hack at OceanHackWeek? | ||
|
||
Increasingly, research and software development are conducted by groups of people with diverse skills and backgrounds. We believe this collaborative work leads to more innovative solutions to complex problems. At OceanHackWeek, our goal is to explore with you some of the skills needed to navigate technical and social challenges of working in these kinds of collaborative settings. We believe the best way to do so is to provide opportunities for you to gain hands-on experience in working together with others on a well-defined problem related to ocean sciences. | ||
|
||
|
||
```{toctree} | ||
:maxdepth: 2 | ||
:caption: OceanHackWeek 2022 (OHW22) | ||
:hidden: | ||
steps.md | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# Hacking at OHW22 | ||
|
||
## How will the projects be conducted? | ||
|
||
We have put together a [few questions](https://github.com/oceanhackweek/discussions/discussions/categories/ohw22-project-planning) that can help you propose a project in [GitHub discussions](https://github.com/oceanhackweek/discussions/discussions/categories/ohw22-project-planning). | ||
|
||
On Monday August 15th we will have a brief “project setup” session for an overview of all projects already proposed up to that point, and give another opportunity to pitch new ideas that may be formed throughout the day. Project proposals must be submitted by the end of this day (Day 1). Each satellite may have its own, specific deadline time, so please connect with your satellite or the global event for details. | ||
|
||
## Tips for getting started | ||
|
||
* Potentially choose something that you've been interested but haven't had the time or skills to do before, or something you can continue to work on post OceanHackWeek! | ||
* Hacking is a community activity! It's okay to choose projects that you can't accomplish alone as other people will be there to help you, both at OceanHackWeek and outside of it! | ||
* Help your group member: you might be the person they need to solve their problem, and vice versa. | ||
* When discussing, pitch your explanation to the least experienced hacker in the group, and you'll end up better understanding what you're trying to do, or need to revise your idea. | ||
* You can mix programming languages as needed in order to get started, but do check in with your project mentors and group members to make sure your efforts are straightforward to be absorbed into the project. | ||
|
||
|
||
<!-- * Start with ideas that are close to home: your research, a project for your company, something you have always been interested in. --> | ||
<!-- * Start with one simple idea first, and when it is built add complexity afterwards. --> | ||
<!-- * Help your neighbor: you might be the person they need to solve their problem, and vice versa. --> | ||
|
||
<!-- | ||
++++++++++++++++++++++++++++++++++++++++++++++++++++ | ||
Below are OHW19 materials: some can be revived for future in-person events, so keeping them here as comments. | ||
++++++++++++++++++++++++++++++++++++++++++++++++++++ | ||
--> | ||
|
||
<!-- ## How will the projects be conducted? | ||
* On day 1 we will facilitate the sharing of ideas and formation of people into small teams (2-5 people) | ||
* Once formed, each team will be guided through exercises to help narrow in on a set of tasks that are doable within the 5 days. A brief project outline will be posted to GitHub, following the "Project Guidelines" below. | ||
## What can I do to prepare in advance? | ||
* If you have a project idea already brewing, we encourage you to share that with the team on the #project channel on Slack. We can add additional channels as the project ideas develop. | ||
* Feel free to explore various projects and initiate conversations. The goal is to gather as much information as you can to inform your decision about which team to join when we meet in person. | ||
* Contact an Oceanhackweek organizer if you would like assistance in assessing whether a project is well-scoped, or if you need help with a particular dataset. | ||
## OceanHackWeek specifics | ||
* Who are you going to hack with? Here's [a list of your fellow hackers](participants_2019) | ||
* What are you going to work on? [Project guidelines and ideas](project_guidelines) | ||
* Start pitching ideas on our [#projects slack](https://oceanhackweek2019.slack.com) channel, and then once projects materialize, we can migrate to a separate project channel | ||
* Begin populating an Oceanhackweek GitHub project page - instructions coming soon | ||
--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# Getting Help | ||
|
||
We know how overwhelming all of this information can be. Here is some for asking questions and figuring out where to turn for help. | ||
|
||
You can ask anything on the Slack `#ohw22-general` channel, any time. Organizers and helpers are monitoring this channel, and some of your fellow hackweek participants may be able to help you! Also, feel free to send a direct message on Slack to any of the organizers or helpers. | ||
|
||
## Helpdesk | ||
|
||
We've set up the `#ohw22-helpdesk` Slack channel to ask technical questions (or other types of questions, if you'd like). | ||
|
||
We will set up some helpdesk Slack user group that you can use to tag your question as, say, about Python. We'll list and describe those groups here. If you know the rough category of help that you may need, please tag one of the helpdesk user groups to get their attention. All help usergroups can be found by typing `@help-` and Slack will prompt with options. | ||
|
||
You are also welcome to direct message the helpers if you don't feel comfortable asking questions publicly. | ||
|
||
### Slack help groups | ||
|
||
- `@help-infrastructure` - For issues regarding the JupyterHub, Slack, Github, and Zoom. | ||
- `@help-projects` - For help with managing projects, for instance asking how to set up a new repo, or organize meetings. | ||
- `@help-python` - Questions about Python programming. | ||
- `@help-r` - Questions about R programming. | ||
- `@help-ml` - Questions about machine learning. | ||
- `@help-git` - Questions about git. | ||
- `@help-tutorials` - For help with tutorial logistics, like cloning the notebooks. | ||
- `@help-website` - If there are any issues with the website tag us to take a look. | ||
|
||
## During tutorials | ||
|
||
- Ask questions on Slack! Use the `#ohw22-tutorials` channel to ask questions or check out answers to questions others have posed. We will use this same channel every day. Several of us will be monitoring this channel and addressing your questions throughout the tutorials | ||
- **Vote up** questions from others to help the moderators prioritize which questions to ask the speaker during tutorials. | ||
- Tutorial moderators will mark questions that are best answered by the instructor and ask helpers (and anyone else!) to answer the rest in real time. Then when the instructor ask if there are questions the moderators will read those reserved for the instructor. | ||
- Zoom Chat will **not** be available. Ask on Slack! | ||
- You will be muted at the start of the tutorial presentation. The moderator will review questions on Slack and ask the questions to the instructor during Q&A time. | ||
|
||
## Projects | ||
|
||
See the [Projects Getting Started page](../projects/steps.md). Feel free to post a question on the `#ohw22_project` channel, too. | ||
|
||
## Reporting a Code of Conduct violation | ||
|
||
Harassment and other [Code of Conduct violations](../../about/code-of-conduct.md) reduce the value of OceanHackWeek for everyone. If someone makes you or anyone else feel unsafe or unwelcome, please report it as soon as possible to one of the instructors. You can make a report either personally or anonymously. **Anonymous reports can be made [here](https://oceanhackweek.wufoo.com/forms/zep2ybt1swlulc/).** | ||
|
Oops, something went wrong.