Skip to content
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

Preliminary - Major overhaul #156

Merged
merged 8 commits into from
Mar 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 3 additions & 10 deletions book/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ format: jb-book
parts:
- caption: Details
chapters:
- file: application
- file: logistics
- title: Schedule
url: https://uwhackweek.github.io/jupyterbook-template/index.html?jump_to=schedule
Expand All @@ -14,15 +13,9 @@ parts:
- file: CoC
- caption: Preparation
chapters:
- file: preliminary/checklist_index
sections:
- file: preliminary/checklist/github
- file: preliminary/checklist/jupyterhub
- file: preliminary/checklist/git
- file: preliminary/checklist/earthdata
- file: preliminary/skills_refresher_index
sections:
- file: preliminary/skills-refresher/swc
- file: preliminary/index
- file: preliminary/checklist
- file: preliminary/git
- caption: Tutorials
chapters:
- file: tutorials/index
Expand Down
27 changes: 0 additions & 27 deletions book/application.md

This file was deleted.

Binary file removed book/img/CoC.png
Binary file not shown.
Binary file removed book/img/belonging.png
Binary file not shown.
Binary file removed book/img/clone-result.png
Binary file not shown.
Binary file removed book/img/clone.png
Binary file not shown.
Binary file removed book/img/co-creation.png
Binary file not shown.
Binary file removed book/img/earthdata-login.png
Binary file not shown.
Binary file removed book/img/education.png
Binary file not shown.
Binary file removed book/img/git-fork-clone-update.png
Binary file not shown.
Binary file removed book/img/git-linear-flow-2.png
Binary file not shown.
Binary file removed book/img/git-repo-structure.png
Binary file not shown.
Binary file removed book/img/github-clone-url.png
Binary file not shown.
Binary file removed book/img/github-fork.png
Binary file not shown.
Binary file removed book/img/github-signup.png
Binary file not shown.
Binary file modified book/img/github-token.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed book/img/github_whw_repos_image.png
Binary file not shown.
Binary file removed book/img/hackweek-mission.png
Binary file not shown.
Binary file removed book/img/hub-logout-button.png
Binary file not shown.
Binary file removed book/img/interactivity.png
Binary file not shown.
Binary file modified book/img/jupyter-terminal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed book/img/jupyterhub-authentication.png
Binary file not shown.
Binary file removed book/img/jupyterhub-connectivity.png
Binary file not shown.
Binary file removed book/img/jupyterhub-overview.png
Binary file not shown.
Binary file removed book/img/jupyterhub-upload.png
Binary file not shown.
Binary file removed book/img/jupyterhub-website-folder.png
Binary file not shown.
Binary file removed book/img/jupyterlab-git.jpg
Binary file not shown.
Binary file removed book/img/jupyterlab.png
Diff not rendered.
Binary file removed book/img/networking.png
Diff not rendered.
Binary file removed book/img/pangeo-image-select.png
Diff not rendered.
Binary file removed book/img/pangeo-opening.png
Diff not rendered.
Binary file removed book/img/pangeo-server-starting.png
Diff not rendered.
Binary file removed book/img/participant-selection.png
Diff not rendered.
Binary file removed book/img/people-github.png
Diff not rendered.
Binary file removed book/img/private-github.png
Diff not rendered.
Binary file removed book/img/projects.png
Diff not rendered.
Binary file removed book/img/public-github.png
Diff not rendered.
Binary file removed book/img/repos.png
Diff not rendered.
Binary file removed book/img/terminal-button.png
Diff not rendered.
Binary file removed book/img/terminal-clone.png
Diff not rendered.
Binary file removed book/img/terminal.png
Diff not rendered.
Original file line number Diff line number Diff line change
Expand Up @@ -42,22 +42,32 @@ the week.
### EarthData Login

We'll have you download some data from NSIDC for your tutorials and projects.
Visit our [Earthdata](checklist/earthdata.md) page to learn how to access and Earthdata
login account if you don't already have one!
Visit the [Earthdata](https://www.earthdata.nasa.gov/eosdis/science-system-description/eosdis-components/earthdata-login)
help page and learn how to register, access, and login if you don't already have
an account!

### GitHub Account

Everyone attending {{ hackweek }} will require obtaining a GitHub account.
Visit our [GitHub instruction page](checklist/github.md) to learn how!
Visit [the GitHub help pages](https://docs.github.com/en/get-started/start-your-journey/creating-an-account-on-github)
if you are in need for an account!

(accessing-jupyterhub)=
### JupyterHub

We will offer all tutorials within the Jupyter Hub computing environment.
Visit our [Introduction to Jupyter Hub](checklist/jupyterhub.md) page to learn more!
We will offer all tutorials based on a JupyterHub environment. Please visit the
[Project Pythia Foundation Skills](https://foundations.projectpythia.org/foundations/getting-started-jupyter.html)
to learn more about the components of project Jupyter.

### Git
Specifically for the event, we will be using [CryoCloud](https://book.cryointhecloud.com/intro.html).
To get started, please see the [onboarding instructions](https://book.cryointhecloud.com/content/Getting_Started.html)
to gain access.

All content of the hackweek will be shared via GitHub and interacting with the
website will be done via the `git` command.
Visit [Setting up the `git` command](checklist/git.md) to learn how to configure that!
Optional setup after you are logged in CryoCloud:
* Earthdata authentication to automate data downloads:
[Configure a netrc file](https://wiki.earthdata.nasa.gov/display/EL/How+To+Access+Data+With+cURL+And+Wget)
* Git authentication:

All content of the hackweek will be shared via GitHub and interacting with the
website will be done via the `git` command. See our {ref}`setting-up-git`
to configure your access.
35 changes: 0 additions & 35 deletions book/preliminary/checklist/earthdata.md

This file was deleted.

70 changes: 0 additions & 70 deletions book/preliminary/checklist/github.md

This file was deleted.

67 changes: 0 additions & 67 deletions book/preliminary/checklist/jupyterhub.md

This file was deleted.

16 changes: 9 additions & 7 deletions book/preliminary/checklist/git.md → book/preliminary/git.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Git
# Setting up `git`

## What is Git?

Expand All @@ -14,7 +14,7 @@ You are not required to know Git in advance of this event, but come prepared to

Below are instructions to get you setup with `git` on the {{hackweek}} hackweek
JupyterHub. These are only basic instructions to get started. See the
[Software Carpentry Git](http://swcarpentry.github.io/git-novice/02-setup/index.html)
[Software Carpentry Git](https://swcarpentry.github.io/git-novice/index.html)
instructions for a more thorough explanation and background information.

### 1. Login to JupyterHub
Expand All @@ -23,7 +23,7 @@ Go to {{ jupyterhub_url }}. See also our JupyterHub documentation: {ref}`accessi
### 2. Open a Terminal
Choose the 'Terminal' from the 'Other' options in the 'Launcher' tab.

![jupyterlab](../../img/jupyter-terminal.png)
![jupyterlab](../img/jupyter-terminal.png)

### 3. Configure basic `git` information
Set your username and email address. The email address should be the same
Expand All @@ -45,7 +45,7 @@ git config --global credential.helper store

The third line is a configuration option that needs to be done with a first time
setup. It specifies the strategy on how git will apply changes you pull from
a remote git repository.
a remote git repository.
More on strategies is [described here.](http://git-scm.com/book/en/v2/Git-Branching-Rebasing)

The last line of the config will store your GitHub credentials and will save
Expand Down Expand Up @@ -73,10 +73,12 @@ However, a better, more secure practice is to use a GitHub Personal Access Token
more customizable permissions and can be revoked without affecting your main GitHub user
account password.

Take a moment to work through the instructions on the [GitHub personal access tokens](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) page. For this hackweek, you need to check the **repo**, **admin:org**, and **workflow** scope.
Take a moment to work through the instructions on the
[GitHub personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic)
page. For this hackweek, you need to check the **repo**, **admin:org**, and **workflow** scope.

Screenshot from github.com setting up the token:
![github-token](../../img/github-token.png)
![github-token](../img/github-token.png)

Once you have created your token, be sure to save it on your computer in case
you need to re-authenticate again. The token will give you access to your
Expand All @@ -89,7 +91,7 @@ terminal on the JupyterHub. where you will be prompted for your GitHub username
and the token.

```shell
git clone {{github_org_url}}.github_setup_check.git
git clone {{ github_org_url }}/github_setup_check.git
```

Since this is the first time you are interacting from the JupyterHub with GitHub,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
# Skills Refresher
# What to Expect

Our hackweeks focus on applied, hands-on learning, with participants engaging in extended periods of small-group work. Our tutorials are designed to offer a broad snapshot of data science tools to support your applied investigations. Due to the relatively short duration of our events, we are not able to provide comprehensive, in-depth training in fundamental tools. Rather, our goal is to inform you about the types of tools we think are best suited to working with your datasets, leaving details of implementation to be supported through peer-learning and office hours.
Our hackweeks focus on applied, hands-on learning, with participants engaging in
extended periods of small-group work. Our tutorials are designed to offer a broad
snapshot of data science tools to support your applied investigations. Due to the
relatively short duration of our events, we are not able to provide comprehensive,
in-depth training in fundamental tools. Rather, our goal is to inform you about
the types of tools we think are best suited to working with your datasets,
leaving details of implementation to be supported through peer-learning and
office hours.

## Typical Workflows and Tools

Expand All @@ -26,13 +33,10 @@ bit less time for applied group work. If you are already proficient in a lot of
tools you may find you can dedicate more energy to applied project work, which
we support through facilitated group activities.

## Software Carpentry Session
## Prerequisites

We strongly suggest that participants who are just beginning to learn Python and
collaborative data science tools to complete our
recorded ([Software Carpentry Training](./skills-refresher/swc)) in advance of the hackweek. You
may choose whichever topics you'd like to brush up on or learn.

## Project Pythia

Another excellent resource for training and skills development is the [Project Pythia](https://projectpythia.org/) organization. Their lessons and galleries are developed specifically for the geoscience community. For a good skills refesher, we encourage you to work through their [Pythia Foundations](https://foundations.projectpythia.org/landing-page.html) notebooks.
All tutorials and project work will assume participants are familiar with Python-based
computing in the geosciences as described on the
[Pythia Foundations](https://foundations.projectpythia.org/landing-page.html) website.
We can provide resources to participants wishing to brush up on their skills before
an event, however we will not be teaching these core concepts during the hackweek.
Loading
Loading