Skip to content

Connecting to Cyverse and GitHub

Log in to Cyverse

  1. Go to the Cyverse user account website https://user.cyverse.org/

image

  1. Click Sign up (if you do not already have an account). When you make this account, please use the email that you have been using to communicate with our team regarding the event. That email is attached to our CyVerse workshop.

image

  1. Log in to Cyverse https://user.cyverse.org/ with your new account.

image

  1. From your account, go to the navigation bar at left and select 'Workshops'

user portal

  1. From the workshop page, find the workshop titled "Forest Carbon Codefest". It should look like this:

workshop tile

  1. Click on the tile, and then on the page for the workshop, click, "Enroll" at upper right. You should be enrolled automatically if you are using the email you have given our team.

workshop enroll

  1. Head over to the Cyverse Discovery Environment by clicking on 'Services' at the upper right and then 'Discovery Environment' under 'My Services'.

user portal

You should now see the Discovery Environment:

image

Open up an analysis with the hackathon environment (Jupyter Lab)

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

image

  1. Select JupyterLab ESIIL

select jupyterlab esiil

  1. Configure and launch your analysis - the defaults are fine for now:

defaults1

image

defaults3

  1. Click Go to analysis:

image

  1. Now you should see Jupyter Lab! image

Set up your GitHub credentials

If you would prefer to follow a video instead of a written outline, we have prepared a video here:

  1. From Jupyter Lab, click on the GitHub icon on the left menu:

image

  1. Click Clone a Repository:

image

  1. Paste the link to the innovation-summit-utils https://github.com/CU-ESIIL/innovation-summit-utils.git and click Clone:

image

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

image

  1. Go into the innovation-summit-utils folder:

image

  1. open up the create_github_keypair.ipynb notebook by double-clicking:

create github keypair

  1. Select the default kernel

image

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

image

  1. You should now see your Public Key. Copy the WHOLE LINE including ssh-ed25519 at the beginning and the jovyan@... at the end image

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

    image

  3. Select SSH and GPG keys

    image

  4. Select New SSH key

    image

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

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

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.


Last update: 2024-05-09