Skip to content

MANE 3351

Lab Five - Using GitHub Desktop

Assigned: October 2, 2024

Due: October 7, 2024 (before 3:30 pm)

Overview

In this lab you will complete the following steps:

  • Clone the Lab Five Assignment to your local computer using GitHub Desktop
  • Start Jupyter Notebook in the directory of your cloned repository
  • Modify the first cell containing Markdown information about your self and run all cells
  • Commit, and push your repository back to GitHub using GitHub Desktop
  • Confirm with Dr. Timmer that the assignment was completed.

Detailed instructions from Fall 2023 are provided in this document. Every effort has been taken to use similar names but slight differences may exist between what is presented in this document and the Fall 2024 assignment.

Step 1

The first step is to click on the Lab Links item in the left-hand menu in your Blackboard classroom.

Step 2

Click on the link for Lab Five.

Step 3

After clicking on the Lab 5 Link shown in Step 3, you will receive a message from GitHub Classroom showing that you accepted the assignment. In this case, MANE 3351 Lab 5 Fall 2023.

Step 4

After accepting the assignment shown in step 3, you can click on the Lab Five link (step 2) to view the final results of accepting the assignment.

Step 5

Clicking on the url shown above, you can view the repository created for your individual assignment.

Step 6

This view of GitHub Classroom is available for Dr. Timmer but not the students. Notice at this point, only one student has accepted the assignment, Dr. Timmer. It also shows that Dr. Timmer has accepted the assignment but not submitted the assignment.

The reason this screen is shown is to inform students that Dr. Timmer can check the status of your assignment.

Step 7

The screenshot show below displays Dr. Timmer's individual repository for Lab Five. Students get to this screen by clicking the URL shown in Step Four. The first step in copying the URL of the assignment URL is to click on the Code button circled in the red ellipse.

Step 8

After clicking on the Code button in Step 7, click on the copy icon circled in the red ellipse.

Step 9

The portion of completing the assignment is to start the GitHub Desktop application. In Dr. Timmer's case, it is a matter of clicking on the GitHub Desktop icon.

Step 10

After double-clicking on the GitHub Desktop icon, GitHub Desktop will start showing the previously used repository within GitHub Desktop. The next portion is to clone the repository from the utrgvqualityengineering organization to your local machine where the lab can be completed. To begin the process of cloning the repository to the local machine, click on File.

Step 11

After clicking on File, click on the Clone repository option shown in the red ellipse.

Step 12

After clicking on Clone a repository, the following screen will appear. To clone the repository, we will use the URL Option shown in the red ellipse.

Step 13

After clicking on the URL, the URL for the repository should be entered in the top text area. As a reminder, the URL was copied to the clipboard in Step 8. To enter the URL, right-click and paste within the top text area.

It is very helpful to note the Local path which is the location on your computer where the repository is stored. Eventually we will need this information.

Step 14

The screenshot shown below is for the local repository. Once it is cloned, there are no local changes yet because the repository has not been processed.

Step 15

Dr. Timmer is demonstrating using a Windows laptop. The first step is to start an Anaconda Prompt for Windows. Mac Users would open a terminal.

Step 16

The Anaconda Prompt window is shown below the next task is to change directory (cd) to the location of the repository (Local Path from Step 13).

Step 17

The change directory command to switch to the location of the repository is shown below. To execute the command, enter must be inputted.

Step 18

To see the contents of the local directory in Windows use the dir command. Mac-users would use the ls command.

Step 19

To start Jupyter Notebook, use the command jupyter notebook. The text from the Jupyter Notebook server is shown in the Anaconda prompt. In Dr. Timmer's configuration, a browser running Jupyter Notebook automatically appears.

Step 20

Notice that there are two files in the directory from which Jupyter Notebook started. The gitHubExample.ipynb is the Jupyter Notebook file for Lab 5. Double-click on the circled file name to view the Jupyter Notebook.

Step 21

The Jupyter Notebook contains two cell. The top cell contains Markdown describing the assignment. The lower cell is a code cell and will be used to do programming in future labs. To edit the Markdown code in the top cell, double-click anywhere in the top cell.

Step 22

After double-clicking in the Markdown cell, the Markdown code will be displayed. Replace the text "Your Name" with your name.

Step 23

To save the changes, click on the disk icon in the red circle.

Step 24

After saving your changes in the Jupyter Notebook application, switch back to the GitHub Desktop. Notice that two files have been changed. So the local version is not the same as the classroom version stored in utrgvqualityengineering organization for this lab.

Step 25

Notice that the text First Attempt has been added and a description of "My first attempt at lab 5." After entering the text click on "Commit to main". Uploading your local copy is a two-step process and committing is the first step.

Step 26

The final step is to push the local repository to the version stored in utrgvqualityengineering.

Step 27

Notice that GitHub Desktop shows "No local changes". This screen is identical to the one shown in Step 14. This indicates the repository stored locally and in utrgvqualityengineering are identical. In summary, the changes have been uploaded to the classroom copy.

Step 28

After completing the process of committing and pushing the repository to the utrgvqualityengineering repository, Dr. Timmer's view of the GitHub Classroom change the status from "Not submitted" to "Submitted".

Step 29

Dr. Timmer can click on the Repository link to view what was submitted.

Step 30

Dr. Timmer can view your submission by clicking on the Jupyter Notebook. It is strongly recommended that every student check with Dr. Timmer after submitting to ensure the assignment was recevied and correct.