README

README.md

+General BioHPC Setup
+====
+
+Instructions for logging into BioHPC and adding SSH key to Github profile. The
+latter is required to clone Github repos from the dorsolab group.
+
+Logging into BioHPC
+----
+
+Login into your UTSW BioHPC account. In the Linux/Mac terminal, type
+
+```
+ssh username@nucleus.biohpc.swmed.edu
+```
+
+where `username` is your individual user account name. 
+Then type in your `password` to complete the login process.
+If you have forgotten your `password`, you can reset it [here](https://portal.biohpc.swmed.edu/accounts/password-change/).
+After logging in, go to your individual `project` folder. 
+Using the username - `pikachu`
+
+```
+cd /project/SCCC/DOrso_lab/pikachu
+```
+
+  
+Add SSH Key to Github Profile
+----
+
+In order to download Github repos from the dorsolab group,
+you must provide authentication in the form of a `SSH key`.
+The key is added to your secure profile.
+
+Log into your profile on [UTSW's Github page](https://git.biohpc.swmed.edu/). 
+To login, use your Portal or BioHPC username/password.
+
+Complete instructions to add SSH key to your
+Github Profile are found [here](https://git.biohpc.swmed.edu/help/ssh/README).
+
+You can follow an abbreviated version of it below. 
+To generate a SSH key for your BioHPC account, type  
+
+```
+ssh-keygen -t rsa -C "your.email@example.com" -b 4096
+```  
+
+where `your.email@example.com` should be replaced with your UTSW email.
+After typing in the above command, you will see a few prompts. 
+Press `Enter` when it ask for the default directory and to save a passphrase - 
+Press `Enter` at both passphrase prompts.  
+
+To view your SSH key, type  
+
+```
+cat ~/.ssh/id_rsa.pub
+```
+
+You should see the following
+
+```
+ssh-rsa ... = your.email@example.com
+```
+
+where `...` is a long alphanumeric key that spans multiple lines. 
+Highlight the entire ssh key - starting from `ssh` and ending with `.com` - 
+and copy it to the clipboard. 
+Then navigate to the `SSH Keys` tab in your `Profile Settings` and 
+paste your key in the `Key` section and give it a relevant `Title`.