Skip to content

Latest commit

 

History

History
69 lines (44 loc) · 2.88 KB

03_githubHomework.md

File metadata and controls

69 lines (44 loc) · 2.88 KB
Raw

GitHub Introduction: Homework Submissions

You will submit weekly homeworks via this Homework Form The form expects you to submit a URL to a file on github.com. You will need an account on GitHub to do this.

You will also need to setup SSH Keys on github and in your ALCF account.

  • The SSH Key setup is described here
  • Setup git on Polaris (or target machine):
git config --global user.name "<first-name> <last-name>"
git config --global user.user "<github-username>"
git config --global user.email "<github-email-address>"

Navigate to the main page of this repository and follow the steps below. If you need help with logging into ALCF, please have a look HERE.

Fork the repo on GitHub

This repository is controled by the ALCF account space, but you can make a copy in to your own github account space by forking the repository as show here. Simply go to the main repository page and click the fork button on the top right.

fork repo

Clone the repo in your Home directory

After you have forked the repo, login to Polaris, and clone the repository in to your home directory.

clone repo

The command looks like git clone git@github.com:<your-github-account>/ai-science-training-series.git and it will clone the repo into a directory named ai-science-training-series.

Do your homework

Some homework can be done via Jupyter notebooks, and others will be source code.

When you sign in to our Jupyter server, you see the contents of your home directory. There you can open your repository and create a new file with an appropriate name, like YEAR-MONTH-DAY_Name_SessionNumber.

create homework

Upload your homework to your github repo

Now you need to:

  • add your new homework file to the list of tracked files in your repository
  • commit your file to the repository
  • push your commit to the web server at github

commit homework

Sync Your Fork

We will periodically update the content in the "upstream" repository at: https://github.com/argonne-lcf/ai-science-training-series

You'll want to execute these commmands each week, just prior to the start of class, to update your personal "fork" with our latest updates.

To do this run these commands inside the directory ai-science-training-series where you cloned your personal fork:

You only need to do this once after you first clone your personal fork:

git remote add upstream git@github.com:argonne-lcf/ai-science-training-series.git

Then, every week, prior to class run this:

git fetch upstream main
git merge upstream/main
git push

This will keep your fork up to date with the ACLF repository.