-
Notifications
You must be signed in to change notification settings - Fork 47
Reorganize Resources, top menu, and ohw23 & ohw22 menus #261
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.
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
Changes from 7 commits
e6141e1
64932fc
acf0b19
23eaf87
09ae940
39de20d
a806700
9b56dce
7eb7853
11f3790
ba7ed03
e8cb154
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It feels like most of getting help and the projects info right now are more general and could live in resources.
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The mix of general and event-specific content seemed more even in getting help and projects info. It's fair to say that both follow a template where some specific information (Slack channel names, dates, brief descriptions, etc) would be customized in each event. For the getting help page, the text is the same except for a bunch of Slack channel names that are spread throughout the page. I think that makes the use of admonitions too crowded / bloated. Anyways, I'll take another look. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| # Getting started on tutorials | ||
|
|
||
| ## Introduction | ||
|
|
||
| Tutorials will be run live on the [OceanHackWeek JupyterHub ("The Hub"), https://oceanhackweek.2i2c.cloud](https://oceanhackweek.2i2c.cloud) in your browser either as Jupyter notebooks or as scripts and notebooks in RStudio. The instructor and all participants can be running their own copies of the tutorial in their Hub account, with files cloned from the OHW source in GitHub. | ||
|
|
||
| Below are instructions for getting the tutorials started on the the Hub in your browser, and updating the tutorials files with the latest version from the GitHub tutorials repository, [https://github.com/oceanhackweek/ohw-tutorials](https://github.com/oceanhackweek/ohw-tutorials). | ||
|
|
||
| The schedule of tutorials is available [here](../../ohw22/schedule.md), and links to tutorial materials and some background resources will be available there as well. | ||
|
|
||
| ## How do I get the tutorial repository into the Hub? | ||
|
|
||
| For the tutorials, we recommend the use of [nbgitpuller](https://jupyterhub.github.io/nbgitpuller/) to clone and pull the tutorials repository, or update the clone you already have. Use the magical nbgitpuller link below to accomplish this clone or update. | ||
|
|
||
| ```{admonition} Pull tutorial repo via the magic of nbgitpuller | ||
|
|
||
| The nbgitpuller link is magical, but it can't detect which profile you are currently running. Either should update the (same) tutorial repo, but it may error if you use the Python link if you are actively using the R profile, or the other way around. | ||
|
|
||
| ::::{tab-set} | ||
|
|
||
| :::{tab-item} Python | ||
|
|
||
| [Pull tutorial repo for the Python profile](https://oceanhackweek.2i2c.cloud/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2Foceanhackweek%2Fohw-tutorials&urlpath=lab%2Ftree%2Fohw-tutorials%2F&branch=OHW22) | ||
|
|
||
| ::: | ||
|
|
||
| :::{tab-item} R | ||
|
|
||
| [Pull tutorial repo for the R profile](https://oceanhackweek.2i2c.cloud/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2Foceanhackweek%2Fohw-tutorials&urlpath=rstudio%2F&branch=OHW22) | ||
|
|
||
| ::: | ||
|
|
||
| :::: | ||
|
|
||
| ``` | ||
|
|
||
| See this [extended discussion](../prep/jupyterhub.md#how-do-i-get-the-tutorial-repository) for more details about `nbgitpuller` and the alternative approach relying on `git` commands and `GitHub` workflows. |
emiliom marked this conversation as resolved.
Show resolved
Hide resolved
|
| 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/).** | ||
|
|
| 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> | ||
| ``` | ||
|
|
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| # 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} | ||
| :hidden: | ||
|
|
||
| steps.md | ||
| ``` |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| # Hacking at OHW23 | ||
|
|
||
| ## 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 | ||
| --> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # Schedule | ||
|
|
||
| **OceanHackWeek 2022 will take place August 15-19.** | ||
|
|
||
| With a global virtual event and many satellites, this schedule is still very much under development. The global virtual event will be meeting from 11-2 Pacific, and most satellites are planning at least part of their day around that time block to encourage cross-satellite interaction. | ||
|
|
||
| ## Overview of the global event | ||
|
|
||
| <iframe width=700 height=600 src="https://docs.google.com/spreadsheets/d/e/2PACX-1vQSK-BFmCaqDp04f6Kfc1tWNIHFDaxHclqe-2Rb4vNlt0we2bqXednUJ_Zk2sRoeqd5nxqsEvJHjYfm/pubhtml?gid=0&single=true&widget=true&headers=false"></iframe> | ||
|
|
||
|
|
||
| <!-- ## Satellite events | ||
|
|
||
| For satellite event schedules, please check out their individual pages to see how each satellite will work with the global event. Some satellite schedules may not be ready yet; contact the satellite organizers via Slack for more information. | ||
|
|
||
| - [US Northeast](./maine/index.md) | ||
| - [US Northwest](./seattle/index.md) | ||
| - [US Southwest](./san-diego/index.md) | ||
| - [Australia](./australia/index.md) | ||
| - [Brazil](./brazil/index.md) | ||
| - [Español](./espanol/index.es.md) | ||
|
|
||
| ```{toctree} | ||
| :hidden: | ||
|
|
||
| monday | ||
| ``` --> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| # Data access in Python | ||
|
|
||
| ```{toctree} | ||
|
|
||
| ../tutorials/01-Tue/00-data-access-in-python/00-data-access.ipynb | ||
| ../tutorials/01-Tue/00-data-access-in-python/01-extras-https.ipynb | ||
| ../tutorials/01-Tue/00-data-access-in-python/02-extras-data-clean-up.ipynb | ||
| ../tutorials/01-Tue/00-data-access-in-python/03-extras-argopy-erddap.ipynb | ||
| ../tutorials/01-Tue/00-data-access-in-python/04-extras-erddapy_saildrone.ipynb | ||
| ``` |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| # Data access in R | ||
|
|
||
| ```{toctree} | ||
| ../tutorials/01-Tue/00-data-access-in-R/01_data_access.Rmd | ||
| ../tutorials/01-Tue/00-data-access-in-R/02_get_nbdc.Rmd | ||
| ../tutorials/01-Tue/00-data-access-in-R/03_get_nao.Rmd | ||
| ``` |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| # Data visualization in Python | ||
|
|
||
| ```{toctree} | ||
|
|
||
| ../tutorials/02-Wed/01-data-visualization-in-python/tutorial/index.ipynb | ||
| ../tutorials/02-Wed/01-data-visualization-in-python/tutorial/00_Setup.ipynb | ||
| ../tutorials/02-Wed/01-data-visualization-in-python/tutorial/01_Overview.ipynb | ||
| ../tutorials/02-Wed/01-data-visualization-in-python/tutorial/02_Building_Panels.ipynb | ||
| ../tutorials/02-Wed/01-data-visualization-in-python/tutorial/03_Interlinked_Panels.ipynb | ||
| ../tutorials/02-Wed/01-data-visualization-in-python/tutorial/04_Basic_Plotting.ipynb | ||
| ../tutorials/02-Wed/01-data-visualization-in-python/tutorial/05_Composing_Plots.ipynb | ||
|
|
||
| ``` |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| # Espanol Tutorials | ||
|
|
||
| ```{toctree} | ||
| python-cientifico | ||
| ../../tutorials/optional/espanol/datos-espaciales-tidy/Notas.Rmd | ||
| ``` |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # Python Cientifico | ||
|
|
||
| ```{toctree} | ||
| Intro to Python <../../tutorials/optional/espanol/python-cientifico/intro_to_python_ohw2022.ipynb> | ||
| Read tabular data<../../tutorials/optional/espanol/python-cientifico/read_tabulardata.ipynb> | ||
| Intro to Plotting <../../tutorials/optional/espanol/python-cientifico/Intro_to_plot.ipynb> | ||
| Intro to NetCDF <../../tutorials/optional/espanol/python-cientifico/intro_to_netcdf.ipynb> | ||
| ``` |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # Tutorials | ||
|
|
||
| ```{toctree} | ||
| :maxdepth: 1 | ||
|
|
||
| ../tutorials_getting_started | ||
| ../tutorials/00-Mon/xarray-in-45-min.ipynb | ||
| data-access-in-python | ||
| data-access-in-r | ||
| data-vis-in-python | ||
| machine-learning-applications | ||
| espanol/index | ||
| ../tutorials/optional/managing-conda-envs/README.md | ||
| ``` |
Uh oh!
There was an error while loading. Please reload this page.