Skip to content
Merged
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ You can view the information in Module 0 in your browser by clicking on the Gith

Additional information on how to [create an Azure account](https://github.com/NIGMS/NIGMS-Sandbox/blob/main/docs/HowToCreateAzureMLNotebooks.md) is provided by the NIGMS in abbreviated form for those with a subscription to Azure.

* Video directions can be viewed at ____________
* Video directions can be viewed at [Learning Modules for Cloud-Based Biomedial Research.](https://www.youtube.com/playlist?list=PLXaEJPtnQ4w7Vu7vqWbttBjUGrPp4Qa7b)


## **Software Requirements**
Expand All @@ -74,7 +74,7 @@ Data will be obtained from online databases (e.g., NCBI) or will be in folders i

## **Module Outline**
**Module 0 - Intro to Cloud Computing and Git**
- Lecture (coming)
- Lecture (upcoming)

- Tutorial 1: Github Download *how to get the tutorials*
- Tutorial 2: Jupyter Notebooks *how to navigate these tutorials*
Expand All @@ -88,7 +88,7 @@ Data will be obtained from online databases (e.g., NCBI) or will be in folders i

Learn core concepts, diverse applications, introductory algorithms, ethical considerations, and data challenges.

- Lecture (coming)
- Lecture (upcoming)
-
- Tutorials
- Tutorial 1: Python Overview
Expand Down
19 changes: 18 additions & 1 deletion Submodule 0/Submodule_0_Tutorial_1_GithubDownload.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,15 @@
"\n",
"You are likely familiar with cloud data storage, for example with your files saved on OneDrive (Microsoft) or Google Drive (Google). Cloud *computing* takes that a step farther and carries out data processing and runs programs on computers that are located in some distant site. \n",
"\n",
"The advantage of \"cloud computing\" is that the computational speed and power is not limited by what you have in *your* desktop or laptop. Rather, cloud computers are very FAST computers with substantially more memory (to work on big biological data sets). Additionally, the providers of cloud computing can make more (or fewer) processors available to your job, depending on the need. "
"The advantage of \"cloud computing\" is that the computational speed and power is not limited by what you have in *your* desktop or laptop. Rather, cloud computers are very FAST computers with substantially more memory (to work on big biological data sets). Additionally, the providers of cloud computing can make more (or fewer) processors available to your job, depending on the need. \n",
"\n",
"<p align=\"center\">\n",
" <a href=\"https://www.youtube.com/watch?v=-xRTFjgiBKw&list=PLXaEJPtnQ4w7Vu7vqWbttBjUGrPp4Qa7b&index=30\">\n",
" <img src=\"../images/WhatIsGitHub.png\" alt=\"NIH/NIGMS Sandbox Foundations of Python Video 3\", width=\"550\"/>\n",
" </a>\n",
" <br>\n",
" <span> Click above image to watch introductory video </span>\n",
"</p>"
]
},
{
Expand All @@ -83,6 +91,15 @@
"metadata": {},
"source": [
"## What you see when you arrive at the \"Sandbox\"\n",
"\n",
"<p align=\"center\">\n",
" <a href=\"https://www.youtube.com/watch?v=M6kKeMjr5e8&list=PLXaEJPtnQ4w7Vu7vqWbttBjUGrPp4Qa7b&index=36\">\n",
" <img src=\"../images/TourofGitHub.png\" alt=\"NIH/NIGMS Sandbox Foundations of Python Video 6\", width=\"550\"/>\n",
" </a>\n",
" <br>\n",
" <span> Click above image to watch introductory video </span>\n",
"</p>\n",
"\n",
"It is possible that you are reading this file having already navigated to the \"Sandbox.\" \n",
"\n",
"The [Sandbox](https://github.com/NIGMS/NIGMS-Sandbox) is housed at github.com. Github is a collaboration tool/website/repository that is being used by NIGMS as a great way to share materials.\n",
Expand Down
103 changes: 103 additions & 0 deletions Submodule 0/Submodule_0_Tutorial_4_GitHub4You.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,23 @@
## Overview
Git is a powerful version control tool that helps track changes to your data files over time. While Git is traditionally used for computer code, it can be just as effective for managing structured data by recording each change, allowing you to compare versions and collaborate efficiently.

<p align="center">
<a href="https://www.youtube.com/watch?v=JgafvlC0_L8&list=PLXaEJPtnQ4w7Vu7vqWbttBjUGrPp4Qa7b&index=37">
<img src="../images/GitIntro.png" alt="NIH/NIGMS Sandbox Foundations of Python Video 1", width="550"/>
</a>
<br>
<span> Click above image to watch introductory video </span>
</p>

<p align="center">
<a href="https://www.youtube.com/watch?v=IlOxDz45Hz0&list=PLXaEJPtnQ4w7Vu7vqWbttBjUGrPp4Qa7b&index=39">
<img src="../images/InstallGit.png" alt="NIH/NIGMS Sandbox Foundations of Python Video 12", width="550"/>
</a>
<br>
<span> Click above image to watch introductory video </span>
</p>


## Learning Objectives
By the end of this lesson, you will be able to:
- Define FAIR data practices
Expand Down Expand Up @@ -45,6 +62,15 @@ The key word: *AUTOMATICALLY* though we'll not get to THAT until the next tutori

Version control tools like Git provide a structured way to track, manage, and document changes to data over time, ensuring that every update, correction, or modification is properly recorded.

<p align="center">
<a href="https://www.youtube.com/watch?v=SRMrrrGfMN8&list=PLXaEJPtnQ4w7Vu7vqWbttBjUGrPp4Qa7b&index=31">
<img src="../images/VersionControl.png" alt="NIH/NIGMS Sandbox Foundations of Python Video 2", width="550"/>
</a>
<br>
<span> Click above image to watch introductory video </span>
</p>


### Why Version Control for Research Data?
<br>1️⃣ Ensuring Data Integrity Over Time
<br>
Expand Down Expand Up @@ -89,6 +115,7 @@ Now that we understand why research labs need version control, let's set up Git

Before you can start using GitHub for your materials, you need to create an account. GitHub is a platform that allows you to store, share, and collaborate on code. It is widely used by developers, students, and organizations for managing software projects using Git, a version control system that tracks changes in your code.


To get started, you need to sign up for a free GitHub account. This will give you access to your own profile, repositories, and collaboration tools. Follow the steps below to create your GitHub account.

- Go to GitHub's website
Expand All @@ -97,6 +124,15 @@ To get started, you need to sign up for a free GitHub account. This will give yo
- Click Create an account and follow the instructions.
- GitHub will send a verification email. Click the link in the email to verify your account.

<p align="center">
<a href="https://www.youtube.com/watch?v=2W8t4YTcLM4&list=PLXaEJPtnQ4w7Vu7vqWbttBjUGrPp4Qa7b&index=44">
<img src="../images/CreateGitHubAccount.png" alt="NIH/NIGMS Sandbox Foundations of Python Video 4", width="550"/>
</a>
<br>
<span> Click above image to watch introductory video </span>
</p>


## Step 2: Setting Up a GitHub Account & Installing GitHub Desktop

Before tracking your data, you need to install GitHub Desktop, a user-friendly application that simplifies version control without needing command-line commands.
Expand All @@ -107,6 +143,13 @@ Before tracking your data, you need to install GitHub Desktop, a user-friendly a
2. Install GitHub Desktop and sign in with your GitHub account.
3. Set up your GitHub profile with your name and email (important for tracking contributions) from the account you set up in step 1.

<p align="center">
<a href="https://www.youtube.com/watch?v=2FaMfNerGsM&list=PLXaEJPtnQ4w7Vu7vqWbttBjUGrPp4Qa7b&index=42">
<img src="../images/GitHubDesktopInstall.png" alt="NIH/NIGMS Sandbox Foundations of Python Video 5", width="550"/>
</a>
<br>
<span> Click above image to watch introductory video </span>
</p>

## Step 3: Creating a Repository for Your Research Data
A repository (A "repo") is like a folder where you store your research data and track changes over time.
Expand All @@ -121,11 +164,35 @@ A repository (A "repo") is like a folder where you store your research data and
5. Check “Initialize this repository with a README” (important for documenting your dataset). This is the appropriate spot to include summary information about this particular repository's purpose
6. Click Create Repository.

<p align="center">
<a href="https://www.youtube.com/watch?v=6jxVqGyXLb4&list=PLXaEJPtnQ4w7Vu7vqWbttBjUGrPp4Qa7b&index=45">
<img src="../images/CreatingandPopulatingNewRepo.png" alt="NIH/NIGMS Sandbox Foundations of Python Video 5", width="550"/>
</a>
<br>
<span> Click above image to watch introductory video </span>
</p>

<p align="center">
<a href="https://www.youtube.com/watch?v=6jxVqGyXLb4&list=PLXaEJPtnQ4w7Vu7vqWbttBjUGrPp4Qa7b&index=45">
<img src="../images/CreatingandPopulatingNewRepoExample.png" alt="NIH/NIGMS Sandbox Foundations of Python Video 10", width="550"/>
</a>
<br>
<span> Click above image to watch introductory video </span>
</p>

Now, you have a version-controlled folder on your computer where you can store and track your research data.

## Step 4: Adding Data Files to GitHub Desktop
Once your repository is set up, you can start adding data files like Excel, CSV, or JSON datasets.

<p align="center">
<a href="https://www.youtube.com/watch?v=U88RuYzclvQ&list=PLXaEJPtnQ4w7Vu7vqWbttBjUGrPp4Qa7b&index=43">
<img src="../images/DesktopTutorialRepo.png" alt="NIH/NIGMS Sandbox Foundations of Python Video 9", width="550"/>
</a>
<br>
<span> Click above image to watch introductory video </span>
</p>

### Instructions:
1. Open your repository folder *on your computer.*
2. Copy or move your data files (e.g., temperature_data_2024.csv) into the folder.
Expand Down Expand Up @@ -167,4 +234,40 @@ Now, every protocol update is documented and timestamped, ensuring full transpar
## Managing a lab group using the same git repository
It is rather unlikely that ONLY one person would be the involved in collecting all of the data for a research lab. In order to control and protect overwriting, Git provides clear management tools. That is covered in the next tutorial.

### Additional Resources:

<p align="center">
<a href="https://www.youtube.com/watch?v=sBXo6IYMe88&list=PLXaEJPtnQ4w7Vu7vqWbttBjUGrPp4Qa7b&index=32">
<img src="../images/UsingGitwithGitHub.png" alt="NIH/NIGMS Sandbox Foundations of Python Video 13", width="550"/>
</a>
<br>
<span> Click above image to watch introductory video </span>
</p>

<p align="center">
<a href="https://www.youtube.com/watch?v=SLQQB8omUP8&list=PLXaEJPtnQ4w7Vu7vqWbttBjUGrPp4Qa7b&index=35">
<img src="../images/GenerateGitHubAcctToken.png" alt="NIH/NIGMS Sandbox Foundations of Python Video 14", width="550"/>
</a>
<br>
<span> Click above image to watch introductory video </span>
</p>

<p align="center">
<a href="https://www.youtube.com/watch?v=DNNKjt5aqbk&list=PLXaEJPtnQ4w7Vu7vqWbttBjUGrPp4Qa7b&index=40">
<img src="../images/DeleteRepoGitHub.png" alt="NIH/NIGMS Sandbox Foundations of Python Video 15", width="550"/>
</a>
<br>
<span> Click above image to watch introductory video </span>
</p>

<p align="center">
<a href="https://www.youtube.com/watch?v=xunkadSUs90&list=PLXaEJPtnQ4w7Vu7vqWbttBjUGrPp4Qa7b&index=41">
<img src="../images/DeleteLocalRepoDesktop.png" alt="NIH/NIGMS Sandbox Foundations of Python Video 16", width="550"/>
</a>
<br>
<span> Click above image to watch introductory video </span>
</p>



Go to the [next tutorial](Submodule_0_Tutorial_5_ManagingGit.md)
17 changes: 17 additions & 0 deletions Submodule 0/Submodule_0_Tutorial_5_ManagingGit.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,14 @@ Please complete tutorial 4 before tutorial 5.
## Why use Git for your research lab team *DATA?*
In a research lab environment, managing data properly is just as important as collecting it. Labs often deal with long-term datasets, changing protocols, and *multiple* contributors, which can lead to data integrity issues if not properly managed.

<p align="center">
<a href="https://www.youtube.com/watch?v=w0kEpFDl75c&list=PLXaEJPtnQ4w7Vu7vqWbttBjUGrPp4Qa7b&index=36">
<img src="../images/TourofGit.png" alt="NIH/NIGMS Sandbox Foundations of Python Video 11", width="550"/>
</a>
<br>
<span> Click above image to watch introductory video </span>
</p>

🧪 GitHub Repo Management Guide for Science Lab PIs

🎯 Goal:
Expand Down Expand Up @@ -74,6 +82,15 @@ In Branch name pattern, type:

main (or master, depending on your repo)

<p align="center">
<a href="https://www.youtube.com/watch?v=l-CzbtBzy_0&list=PLXaEJPtnQ4w7Vu7vqWbttBjUGrPp4Qa7b&index=40">
<img src="../images/TypicalCollabProcess.png" alt="NIH/NIGMS Sandbox Foundations of Python Video 8", width="550"/>
</a>
<br>
<span> Click above image to watch introductory video </span>
</p>


**Check the following boxes:**

✅ Require pull request reviews before merging
Expand Down
12 changes: 10 additions & 2 deletions Submodule_1/Submodule_1_Tutorial1_PythonOverview.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,21 @@
"\n",
"This section of the introductory module gives you the foundations for understanding how Python works. \n",
"\n",
"<p align=\"center\">\n",
" <a href=\"https://www.youtube.com/watch?v=I13dInHrpa4&list=PLXaEJPtnQ4w7Vu7vqWbttBjUGrPp4Qa7b&index=29\">\n",
" <img src=\"../images/IntroPythonforBioinfo.png\" alt=\"NIH/NIGMS Sandbox Foundations of Python Video 7\", width=\"550\"/>\n",
" </a>\n",
" <br>\n",
" <span> Click above image to watch introductory video </span>\n",
"</p>\n",
"\n",
"<div class=\"alert alert-block alert-warning\"> <b>Attention:</b> This page is for novices!</a>. </div>\n",
"\n",
"## Learning Objectives\n",
"- Describe a Python program\r",
"- Describe a Python program\n",
"- Recognize and create comments\n",
"- Find help for Python Tools\n",
"- Use functions and methods on variables (at a beginner level)\r\n",
"- Use functions and methods on variables (at a beginner level)\n",
"## Prerequisites\n",
"NONE\n",
"\n",
Expand Down
Binary file added images/CreateGitHubAccount.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 images/CreatingandPopulatingNewRepo.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 images/CreatingandPopulatingNewRepoExample.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 images/DeleteLocalRepoDesktop.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 images/DeleteRepoGitHub.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 images/DesktopTutorialRepo.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 images/GenerateGitHubAcctToken.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 images/GitHubDesktopInstall.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 images/GitIntro.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 images/InstallGit.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 images/IntroPythonforBioinfo.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 images/TourofGit.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 images/TourofGitHub.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 images/TypicalCollabProcess.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 images/UsingGitwithGitHub.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 images/VersionControl.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 images/WhatIsGitHub.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading