Skip to content

Commit

Permalink
Updating cyverse basics
Browse files Browse the repository at this point in the history
  • Loading branch information
Erick Verleye committed Jan 24, 2024
1 parent 2ba46f6 commit cb49294
Show file tree
Hide file tree
Showing 21 changed files with 37 additions and 50 deletions.
Binary file added docs/assets/cyverse_basics/app_launch.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 added docs/assets/cyverse_basics/app_settings.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 added docs/assets/cyverse_basics/apps.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/cyverse_basics/clone.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 added docs/assets/cyverse_basics/cyverse-utils.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 added docs/assets/cyverse_basics/email.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 added docs/assets/cyverse_basics/final.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 added docs/assets/cyverse_basics/go_to_analysis.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 added docs/assets/cyverse_basics/jupyterlab.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 added docs/assets/cyverse_basics/key.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 added docs/assets/cyverse_basics/launch.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 added docs/assets/cyverse_basics/new_key.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/cyverse_basics/paste_key.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 added docs/assets/cyverse_basics/script_1.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 added docs/assets/cyverse_basics/settings.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 added docs/assets/cyverse_basics/ssh.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 added docs/assets/cyverse_basics/use_this_app.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 added docs/assets/cyverse_basics/username.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
87 changes: 37 additions & 50 deletions docs/resources/cyverse_basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,88 +24,75 @@

1. From the Cyverse Discovery Environment, click on `Apps` in the left menu

<img width="881" alt="image" src="https://github.com/CU-ESIIL/hackathon2023_datacube/assets/3465768/4bb45960-0a9b-4e3d-af83-fd424dae9bf4">
<img width="881" alt="image" src="../assets/cyverse_basics/apps.png">

2. Select `JupyterLab Earthlab`
2. Select `JupyterLab ESIIL`

<img width="881" alt="image" src="https://github.com/CU-ESIIL/hackathon2023_datacube/assets/3465768/31bdaedf-efa7-4778-bd3b-b790efa128b9">
<img width="881" alt="image" src="../assets/cyverse_basics/use_this_app.png">

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:

<img width="881" alt="image" src="https://github.com/CU-ESIIL/hackathon2023_datacube/assets/3465768/1108f008-3c4d-4216-80f6-fa6f9a63248f">
<img width="881" alt="image" src="../assets/cyverse_basics/app_launch.png">

<img width="881" alt="image" src="https://github.com/CU-ESIIL/hackathon2023_datacube/assets/3465768/b82f08d7-4d21-4fba-9e40-f0a4ac492898">
<img width="881" alt="image" src="../assets/cyverse_basics/app_settings.png">

<img width="881" alt="image" src="https://github.com/CU-ESIIL/hackathon2023_datacube/assets/3465768/ecb6051c-17bc-4e79-a40a-04d5949ed472">
<img width="881" alt="image" src="../assets/cyverse_basics/launch.png">


4. Click `Go to analysis`:

<img width="1004" alt="image" src="https://github.com/CU-ESIIL/hackathon2023_datacube/assets/3465768/f9ea6ffe-cfd7-44c3-9ca2-cb90740df6a4">
<img width="1004" alt="image" src="../assets/cyverse_basics/go_to_analysis.png">

5. Now you should see Jupyter Lab!
<img width="1004" alt="image" src="https://github.com/CU-ESIIL/hackathon2023_datacube/assets/3465768/b7702aee-b561-440d-92a9-daa9990a7f96">
<img width="1004" alt="image" src="../assets/cyverse_basics/jupyterlab.png">

## 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)

<img width="1004" alt="image" src="https://github.com/CU-ESIIL/hackathon2023_datacube/assets/3465768/8c694ad7-2454-4ffc-b422-e95382d0205f">
1. From Jupyter Lab, click on the Git Extension icon on the left menu:

2. Click `Clone a Repository`:
<img width="1004" alt="image" src="../assets/cyverse_basics/jupyterlab.png">

<img width="1004" alt="image" src="https://github.com/CU-ESIIL/hackathon2023_datacube/assets/3465768/42f691b0-efbd-45f8-8554-157c70902abe">
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`:
<img width="1004" alt="image" src="../assets/cyverse_basics/clone.png">

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`
<img width="1004" alt="image" src="../assets/cyverse_basics/cyverse-utils.png">

<img width="1004" alt="image" src="https://github.com/CU-ESIIL/hackathon2023_datacube/assets/3465768/50c07e00-fb17-48a5-a460-ab5fc730384c">
4. Go into the `cyverse-utils` folder:
<img width="1004" alt="image" src="../assets/cyverse_basics/click_cyverse_utils.png">

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:
<img width="1004" alt="image" src="../assets/cyverse_basics/open_cyverse_utils.png">

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:

<img width="1004" alt="image" src="https://github.com/CU-ESIIL/hackathon2023_datacube/assets/3465768/7e455efc-7d56-47d4-a854-563c38a14acc">
<img width="1004" alt="image" src="../assets/cyverse_basics/script_1.png">

5. Go into the `innovation-summit-utils` folder:
<img width="1004" alt="image" src="../assets/cyverse_basics/username.png">

<img width="1004" alt="image" src="https://github.com/CU-ESIIL/hackathon2023_datacube/assets/3465768/bbc0955b-008a-4376-9d4e-9644982ccb8c">
<img width="1004" alt="image" src="../assets/cyverse_basics/email.png">

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
<img width="1462" alt="image" src="../assets/cyverse_basics/key.png">

<img width="1004" alt="image" src="https://github.com/CU-ESIIL/hackathon2023_datacube/assets/3465768/a3cbf78c-b1ce-448b-b02b-a648fd074136">
8. Go to your GitHub settings page (you may need to log in to GitHub first):
<img width="1462" alt="image" src="<img width="1462" alt="image" src="../assets/cyverse_basics/settings.png">

7. Select the default `earth-analytics-python` kernel
9. Select `SSH and GPG keys`
<img width="1462" alt="image" src="<img width="1462" alt="image" src="../assets/cyverse_basics/ssh.png">

<img width="1004" alt="image" src="https://github.com/CU-ESIIL/hackathon2023_datacube/assets/3465768/7a59013b-160d-4a91-81d8-e64f77acbbfe">
10. Select `New SSH key`
<img width="1462" alt="image" src="../assets/cyverse_basics/new_key.png">

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.:

<img width="1004" alt="image" src="https://github.com/CU-ESIIL/hackathon2023_datacube/assets/3465768/50f617c6-8b77-4e32-99cd-d2dcdb7dc5dc">
<img width="1462" alt="image" src="../assets/cyverse_basics/paste_key.png">

<img width="1004" alt="image" src="https://github.com/CU-ESIIL/hackathon2023_datacube/assets/3465768/46115471-60de-4fa9-918b-9a3cbf2d28af">
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!

<img width="1004" alt="image" src="https://github.com/CU-ESIIL/hackathon2023_datacube/assets/3465768/8a71d74b-0e53-417a-9a30-ac31915c8ce4">

9. You should now see your Public Key. Copy the WHOLE LINE including `ssh-ed25519` at the beginning and the `jovyan@...` at the end
<img width="1004" alt="image" src="https://github.com/CU-ESIIL/hackathon2023_datacube/assets/3465768/876c3294-34e9-4d05-86e2-046a69b6d843">

10. Go to your GitHub settings page (you may need to log in to GitHub first):

<img width="1462" alt="image" src="https://github.com/CU-ESIIL/hackathon2023_datacube/assets/3465768/9dc79edc-e527-4b98-a94f-4d500571b97a">

11. Select `SSH and GPG keys`

<img width="1462" alt="image" src="https://github.com/CU-ESIIL/hackathon2023_datacube/assets/3465768/427be66e-b1e2-46ca-93b6-e3585a7c7fb3">

12. Select `New SSH key`

<img width="1462" alt="image" src="https://github.com/CU-ESIIL/hackathon2023_datacube/assets/3465768/a33ad793-ea4d-4d44-9a8f-bde1b04f69c0">

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.:

<img width="1462" alt="image" src="https://github.com/CU-ESIIL/hackathon2023_datacube/assets/3465768/74888d16-5042-4f3b-abaa-34498c83a276">

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!

<img width="1462" alt="image" src="https://github.com/CU-ESIIL/hackathon2023_datacube/assets/3465768/a4bdfada-f7f4-40b7-a1af-41b18d7bd3e6">
<img width="1462" alt="image" src="../assets/cyverse_basics/final.png">

> 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.

0 comments on commit cb49294

Please sign in to comment.