Skip to content

Commit

Permalink
Add .ipynb files
Browse files Browse the repository at this point in the history
These were converted from the .Rmb by jupytext
  • Loading branch information
joannmudge authored Aug 6, 2024
1 parent 55f8fa4 commit 82430d9
Show file tree
Hide file tree
Showing 15 changed files with 5,933 additions and 0 deletions.
105 changes: 105 additions & 0 deletions 01-prerequisites.ipynb
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
{
"cells": [
{
"cell_type": "markdown",
"id": "270fdadd",
"metadata": {},
"source": [
"# Prerequisites\n",
"\n",
"## Software\n",
"\n",
"You will need to install the following software on your computer.\n",
"\n",
"+ **Zoom**\n",
" + https://zoom.us/download\n",
" + Install the correct version for your OS. Don't plan to use the web version, as this does not have enough features. \n",
"+ **Terminal Emulator**\n",
" + Comes with Linux/Mac\n",
" + Windows: MobaXterm\n",
"+ **IGV** v2.17.1\n",
" + https://software.broadinstitute.org/software/igv/\n",
" + https://www.nature.com/articles/nbt.1754\n",
"+ **Bandage** v0.9.0 and **BLAST+** v2.15.0\n",
" + https://rrwick.github.io/Bandage/\n",
" + https://github.com/rrwick/Bandage/wiki/BLAST-searches\n",
" + https://academic.oup.com/bioinformatics/article/31/20/3350/196114\n",
" + *Mac Install*\n",
" + Go to https://github.com/rrwick/Bandage/releases\n",
" + Scroll down to assets\n",
" + Download the macOS zip file with aarch64 if you have Apple Silicon (M1 or M2 processor)\n",
" + you can check this under the apple menu: About this Mac\n",
" + Otherwise download the macOS zip file with x86-64\n",
" + Double-click to unzip\n",
" + If you have security warnings you can go to the apple menu: System Preferences: Privacy and Security. Choose \"Open Anyway\" (you might need to scroll down).\n",
" + If you get a \"Bandage is damaged and can't be opened\" message, it means your mac has put the file in quarantine. Open a terminal, cd to Downloads, then cd into the unzipped Bandage folder. Type the following then hit enter: xattr -cr Bandage.app\n",
" + If you are still having issues with the \"damaged\" error, you can download the x86-64 version instead\n",
" + To install **blast**, go to https://www.ncbi.nlm.nih.gov/books/NBK569861/, click on the ftp link, choose \"LATEST\", and download the one ending in dmg\n",
" + Double-click on it and follow the install instructions, using the default location where Bandage should be able to see it.\n",
" + *Windows Install*\n",
" + Go to https://github.com/rrwick/Bandage/releases\n",
" + Scroll down to assets\n",
" + Download Bandage_Windows_v0_8_0.zip\n",
" + Right-click (or ctrl-click) on the dowloaded file and choose \"Extract All\"\n",
" + Open up the unzipped Bandage folder and double-click on \"Bandage.exe\". If you get a secruity warning, choose \"More Info\" and \"Run Anyway\"\n",
" + To install **blast**, go to https://www.ncbi.nlm.nih.gov/books/NBK52637/ and follow the directions under \"Steps\" (you will download the file ending in .exe)\n",
" + If you get an error that makeblastdb can't be found, we need to fix your windows environment paths. In the windows search bar type \"environment\" and click on \"Edit the system environment variables\". Click on \"New\" and under Variable_name type \"BLASTDB\". Under Variable_value type the path to the blast db folder (for example: `C:\\Users\\jm\\Downloads\\blast-2.10.0+\\db\\`). Restart your computer.\n",
" \n",
"<!--We can also help the students if they need this but it hasn't been an issue yet:\n",
"Make sure the path to the blast bin file is in the path (for example: \"\"C:\\Users\\jm\\Downloads\\blast-2.10.0+\\bin\\\"). If not edit the path.-->\n",
" \n",
"<!--If the environment path doesn't work, we could try moving the blast folder into /usr/bin/ per the developer's suggestion; looks like you have to do that on the command line as I coudn't figure out how to get the finder window to go to /usr/bin/-->"
]
},
{
"cell_type": "markdown",
"id": "945d9de7",
"metadata": {},
"source": [
"The following software is provided for you on the server.\n",
"\n",
"+ **vg** v1.54.0\n",
" + https://github.com/vgteam/vg\n",
" + https://www.nature.com/articles/nbt.4227\n",
"+ **minigraph** v0.20\n",
" + https://github.com/lh3/minigraph\n",
" + https://link.springer.com/article/10.1186/s13059-020-02168-z\n",
"+ **cactus** v2.7.1\n",
" + https://github.com/ComparativeGenomicsToolkit/cactus\n",
" + https://www.nature.com/articles/s41586-020-2871-y\n",
"+ **pggb** v0.5.4\n",
" + https://github.com/pangenome/pggb\n",
" + https://www.biorxiv.org/content/10.1101/2023.04.05.535718v1\n",
"+ **gfatools** v0.5\n",
" + https://github.com/lh3/gfatools\n",
"+ **samtools** v1.19.2\n",
" + http://www.htslib.org/\n",
"+ **cuttlefish** v2.2.0\n",
" + https://github.com/COMBINE-lab/cuttlefish\n",
" + https://genomebiology.biomedcentral.com/articles/10.1186/s13059-022-02743-6\n",
"\n",
"## Configuring Conda\n",
"\n",
"Some software on the server is installed via [Conda](https://docs.conda.io/en/latest/).\n",
"To use Conda, you need to initialize your shell to work with Conda.\n",
"To initialize your shell, run the following command after logging into the server:\n",
"```\n",
"conda init\n",
"conda config --set auto_activate_base false\n",
"```\n",
"Then log out and back into the server.\n",
"You should now be able to use Conda environments on the server.\n",
" "
]
}
],
"metadata": {
"jupytext": {
"cell_metadata_filter": "-all",
"main_language": "python",
"notebook_metadata_filter": "-all"
}
},
"nbformat": 4,
"nbformat_minor": 5
}
114 changes: 114 additions & 0 deletions 02-agenda.ipynb
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
{
"cells": [
{
"cell_type": "markdown",
"id": "80b83ea5",
"metadata": {},
"source": [
"# Agenda\n",
"\n",
"Zoom link: https://us06web.zoom.us/j/85702851907?pwd=Udt2roZaEWgED88kw8cfAsKdaudxHD.1\n",
"\n",
"Sessions are from 9-12 and 1-4 mountain time (M-F). Please let us know ([email protected] or during the workshop) if you have to miss part of a day.\n",
"\n",
"Zoom recordings: https://docs.google.com/document/d/1_4jZuVnxGiGkeiUgewhs3zkqOZEKd58-Cnij1PuiOT0/edit?usp=sharing\n",
"\n",
"**Please do not share the zoom recordings (see the Wrap Up chapter for more information).**\n",
"\n",
"_____\n",
"\n",
"**Monday**\n",
"\n",
"<span style=\"color: lightgray;\">MORNING</span>\\\n",
"\n",
"Introductions\\\n",
"<span style=\"color: forestgreen;\">Linux</span> (Ethan)\n",
"\n",
"<span style=\"color: lightgray;\">AFTERNOON</span>\\\n",
"\n",
"<span style=\"color: forestgreen;\">Linux</span> (cont) (Ethan)"
]
},
{
"cell_type": "markdown",
"id": "5f7973c6",
"metadata": {},
"source": [
"_____\n",
"\n",
"**Tuesday**\n",
"\n",
"<span style=\"color: lightgray;\">MORNING</span>\\\n",
"\n",
"<span style=\"color: darkblue;\">Introduction to Pangenomics</span> (Alan)\\\n",
"\n",
"<span style=\"color: lightgray;\">AFTERNOON</span>\\\n",
"\n",
"<span style=\"color: forestgreen;\">Visualizing Pangenomes</span> (Alan)\\\n",
"\n",
"<span style=\"color: forestgreen;\">Reference Graphs with VG</span> (Alan)\\\n",
"\n",
"_____\n",
"\n",
"**Wednesday**\n",
"\n",
"<span style=\"color: lightgray;\">MORNING</span>\\\n",
"\n",
"<span style=\"color: forestgreen;\">Reference Graphs with VG (cont)</span> (Alan)\\\n",
"\n",
"<span style=\"color: darkblue;\">Draft Human Pangenome Reference</span> (Joann)\\\n",
"\n",
"<span style=\"color: lightgray;\">AFTERNOON</span>\\\n",
"\n",
"<span style=\"color: forestgreen;\">Incremental Graphs with Minigraph</span> (Joann)\\\n",
"\n",
"_____\n",
"\n",
"**Thursday**\n",
"\n",
"<span style=\"color: lightgray;\">MORNING</span>\\\n",
"\n",
"<span style=\"color: forestgreen;\">Incremental Graphs with Minigraph (cont)</span> (Joann)\\\n",
"\n",
"<span style=\"color: lightgray;\">AFTERNOON</span>\\\n",
"\n",
"<span style=\"color: forestgreen;\">Reference-Free Graphs with pggb</span> (Alan)\\"
]
},
{
"cell_type": "markdown",
"id": "4bee5647",
"metadata": {},
"source": [
"_____\n",
"\n",
"**Friday**\n",
"\n",
"<span style=\"color: lightgray;\">MORNING</span>\\\n",
"\n",
"<span style=\"color: forestgreen;\">Cuttlefish</span> (Joann)\\\n",
"\n",
"<span style=\"color: forestgreen;\">Graph-specific Analyses</span> (Joann)\\\n",
"\n",
"<span style=\"color: lightgray;\">AFTERNOON</span>\\\n",
"\n",
"<span style=\"color: forestgreen;\">Review and Other Methods</span> (Alan)\\\n",
"\n",
"Survey and Wrap-up (Adam)\n",
"\n",
"_____\n",
"\n",
"<span style=\"color: forestgreen;\">Green</span> text indicates hands-on sessions. <span style=\"color: darkblue;\">Blue</span> text indicates presentations. Please note that the timing might shift slightly.\n"
]
}
],
"metadata": {
"jupytext": {
"cell_metadata_filter": "-all",
"main_language": "python",
"notebook_metadata_filter": "-all"
}
},
"nbformat": 4,
"nbformat_minor": 5
}
Loading

0 comments on commit 82430d9

Please sign in to comment.