diff --git a/docs/assets/cyverse_basics/app_launch.png b/docs/assets/cyverse_basics/app_launch.png new file mode 100644 index 0000000..30fc759 Binary files /dev/null and b/docs/assets/cyverse_basics/app_launch.png differ diff --git a/docs/assets/cyverse_basics/app_settings.png b/docs/assets/cyverse_basics/app_settings.png new file mode 100644 index 0000000..dbf7179 Binary files /dev/null and b/docs/assets/cyverse_basics/app_settings.png differ diff --git a/docs/assets/cyverse_basics/apps.png b/docs/assets/cyverse_basics/apps.png new file mode 100644 index 0000000..ad242a7 Binary files /dev/null and b/docs/assets/cyverse_basics/apps.png differ diff --git a/docs/assets/cyverse_basics/click_cyverse_utils.png b/docs/assets/cyverse_basics/click_cyverse_utils.png new file mode 100644 index 0000000..ddf7445 Binary files /dev/null and b/docs/assets/cyverse_basics/click_cyverse_utils.png differ diff --git a/docs/assets/cyverse_basics/clone.png b/docs/assets/cyverse_basics/clone.png new file mode 100644 index 0000000..875860b Binary files /dev/null and b/docs/assets/cyverse_basics/clone.png differ diff --git a/docs/assets/cyverse_basics/cyverse-utils.png b/docs/assets/cyverse_basics/cyverse-utils.png new file mode 100644 index 0000000..de9c188 Binary files /dev/null and b/docs/assets/cyverse_basics/cyverse-utils.png differ diff --git a/docs/assets/cyverse_basics/email.png b/docs/assets/cyverse_basics/email.png new file mode 100644 index 0000000..6d4bcfa Binary files /dev/null and b/docs/assets/cyverse_basics/email.png differ diff --git a/docs/assets/cyverse_basics/final.png b/docs/assets/cyverse_basics/final.png new file mode 100644 index 0000000..3d92723 Binary files /dev/null and b/docs/assets/cyverse_basics/final.png differ diff --git a/docs/assets/cyverse_basics/go_to_analysis.png b/docs/assets/cyverse_basics/go_to_analysis.png new file mode 100644 index 0000000..802ef3f Binary files /dev/null and b/docs/assets/cyverse_basics/go_to_analysis.png differ diff --git a/docs/assets/cyverse_basics/jupyterlab.png b/docs/assets/cyverse_basics/jupyterlab.png new file mode 100644 index 0000000..f4b4540 Binary files /dev/null and b/docs/assets/cyverse_basics/jupyterlab.png differ diff --git a/docs/assets/cyverse_basics/key.png b/docs/assets/cyverse_basics/key.png new file mode 100644 index 0000000..1670fea Binary files /dev/null and b/docs/assets/cyverse_basics/key.png differ diff --git a/docs/assets/cyverse_basics/launch.png b/docs/assets/cyverse_basics/launch.png new file mode 100644 index 0000000..49e7044 Binary files /dev/null and b/docs/assets/cyverse_basics/launch.png differ diff --git a/docs/assets/cyverse_basics/new_key.png b/docs/assets/cyverse_basics/new_key.png new file mode 100644 index 0000000..5306330 Binary files /dev/null and b/docs/assets/cyverse_basics/new_key.png differ diff --git a/docs/assets/cyverse_basics/open_cyverse_utils.png b/docs/assets/cyverse_basics/open_cyverse_utils.png new file mode 100644 index 0000000..d542da4 Binary files /dev/null and b/docs/assets/cyverse_basics/open_cyverse_utils.png differ diff --git a/docs/assets/cyverse_basics/paste_key.png b/docs/assets/cyverse_basics/paste_key.png new file mode 100644 index 0000000..f515a1b Binary files /dev/null and b/docs/assets/cyverse_basics/paste_key.png differ diff --git a/docs/assets/cyverse_basics/script_1.png b/docs/assets/cyverse_basics/script_1.png new file mode 100644 index 0000000..f316c2c Binary files /dev/null and b/docs/assets/cyverse_basics/script_1.png differ diff --git a/docs/assets/cyverse_basics/settings.png b/docs/assets/cyverse_basics/settings.png new file mode 100644 index 0000000..874200e Binary files /dev/null and b/docs/assets/cyverse_basics/settings.png differ diff --git a/docs/assets/cyverse_basics/ssh.png b/docs/assets/cyverse_basics/ssh.png new file mode 100644 index 0000000..17dc6b8 Binary files /dev/null and b/docs/assets/cyverse_basics/ssh.png differ diff --git a/docs/assets/cyverse_basics/use_this_app.png b/docs/assets/cyverse_basics/use_this_app.png new file mode 100644 index 0000000..c4876cb Binary files /dev/null and b/docs/assets/cyverse_basics/use_this_app.png differ diff --git a/docs/assets/cyverse_basics/username.png b/docs/assets/cyverse_basics/username.png new file mode 100644 index 0000000..fdd0cbc Binary files /dev/null and b/docs/assets/cyverse_basics/username.png differ diff --git a/docs/resources/cyverse_basics.md b/docs/resources/cyverse_basics.md index 9947456..ba45235 100644 --- a/docs/resources/cyverse_basics.md +++ b/docs/resources/cyverse_basics.md @@ -24,88 +24,75 @@ 1. From the Cyverse Discovery Environment, click on `Apps` in the left menu - image + image -2. Select `JupyterLab Earthlab` +2. Select `JupyterLab ESIIL` - image + image -3. Configure and launch your analysis - the defaults are fine for now: +3. Configure and launch your analysis - when choosing the disk size, make sure to choose 64GB or greater. The rest of the settings you can change to suit your computing needs: - image + image - image + image - image + image 4. Click `Go to analysis`: - image + image 5. Now you should see Jupyter Lab! - image + image ## Set up your GitHub credentials -1. From Jupyter Lab, click on the GitHub icon on the left menu: +### If you would prefer to follow a video instead of a written outline, we have prepared a video here: +[![EDS in the Cloud: Setting Up SSH Key Authentication for GitHub](https://img.youtube.com/vi/nOwOzPJEQbU/0.jpg)](https://www.youtube.com/watch?v=nOwOzPJEQbU) - image +1. From Jupyter Lab, click on the Git Extension icon on the left menu: -2. Click `Clone a Repository`: + image - image +2. Click `Clone a Repository` and Paste the link to the cyverse-utils [https://github.com/CU-ESIIL/cyverse-utils.git](https://github.com/CU-ESIIL/cyverse-utils.git) and click `Clone`: + image -3. Paste the link to the innovation-summit-utils [https://github.com/CU-ESIIL/innovation-summit-utils.git](https://github.com/CU-ESIIL/innovation-summit-utils.git) and click `Clone`: +3. You should now see the `cyverse-utils` folder in your directory tree (provided you haven't changed directories from the default `/home/jovyan/data-store` + image - image +4. Go into the `cyverse-utils` folder: + image +5. open up the `create_github_keypair.ipynb` notebook if you prefer Python or the 'create_github_keypair.R' script if you prefer R by double-clicking and then select the default 'macrosystems' kernel: +image -4. You should now see the `innovation-summit-utils` folder in your directory tree (provided you haven't changed directories from the default `/home/jovyan/data-store` +6. Now you should see the notebook open. Click the `play` button at the top. You will be prompted to enter your GitHub username and email: - image + image -5. Go into the `innovation-summit-utils` folder: + image - image + image -6. open up the `configure_github_ssh.ipynb` notebook by double-clicking: +7. You should now see your Public Key. Copy the WHOLE LINE including `ssh-ed25519` at the beginning and the `jovyan@...` at the end +image - image +8. Go to your GitHub settings page (you may need to log in to GitHub first): + image -7. Select the default `earth-analytics-python` kernel +9. Select `SSH and GPG keys` + image - image +10. Select `New SSH key` + image -8. Now you should see the notebook open. Click the `play` button at the top. You will be prompted to enter your GitHub username and email: +11. Give your key a descriptive name, paste your ENTIRE public key in the `Key` input box, and click `Add SSH Key`. You may need to re-authenticate with your password or two-factor authentication.: - image + image - image +12. You should now see your new SSH key in your `Authentication Keys` list! Now you will be able to clone private repositories and push changes to GitHub from your Cyverse analysis! - image - -9. You should now see your Public Key. Copy the WHOLE LINE including `ssh-ed25519` at the beginning and the `jovyan@...` at the end -image - -10. Go to your GitHub settings page (you may need to log in to GitHub first): - - image - -11. Select `SSH and GPG keys` - - image - -12. Select `New SSH key` - - image - -13. Give your key a descriptive name, paste your ENTIRE public key in the `Key` input box, and click `Add SSH Key`. You may need to re-authenticate with your password or two-factor authentication.: - - image - -14. You should now see your new SSH key in your `Authentication Keys` list! Now you will be able to clone private repositories and push changes to GitHub from your Cyverse analysis! - - image + image > NOTE! Your GitHub authentication is ONLY for the analysis you're working with right now. You will be able to use it as long as you want there, but once you start a new analysis you will need to go through this process again. Feel free to delete keys from old analyses that have been shut down.