pupster90/10kimmunomes repository overview

⁠10k Immunomes Docker Tutorial

This tutorial is for people interested in the 10k Immunomes⁠ project. We explain how to run the website locally so that you can make changes to the code. Docker⁠ is by far the easiest way to work on this project. Docker has quickly become one of the most popular ways to share code, because it makes it easy to run any code on any computer.

⁠Step 1: Install Docker

You can quickly run 10k Immunomes code on Linux/Mac/Windows using docker. install docker here⁠. We recommend watching a docker tutorial and installation video on youtube⁠.

⁠Step 2: Download and Run 10k Immunomes Image

Once you have docker, open your computer terminal and run the following code to download the 10k Immunomes project:

docker pull pupster90/10kimmunomes

The above code installs the 10k Immunomes docker image on to your computer. Run this next line to start Jupyter⁠ in your browser:

docker run -d -p 80:80 -p 8888:8888 --name 10k --user root pupster90/10kimmunomes password 10kimmunomes

⁠Step 3: Run 10k Immunomes Locally

Open an internet browser (chrome, safari,...) go to the url localhost. You will be asked to sign into Jupyter. Type the password 10kimmunomes. You now have access to the Jupyter environment where you can run 10k Immunomes code.

Go to the folder /Public/10k_Immunomes. You will see all of the source code in the 10k Immunomes Github⁠ repository. Open the file 10k Immunomes Source Code .ipynb, then, in the toolbar, click Cell->Run All, to start running the 10k Immunomes website locally. Go to localhost:8888 to view the website. 10k Immunomes was built using a customized version of Jupyter called io. To learn more about the io environment watch this tutorial series⁠.

⁠Step 4: Contact Us

If you are another lab interested in 10k Immunomes, we are happy to have you reach out to Atul Butte's lab⁠. Sanchita Bhattacharya is the senior scientist and manager of this project (email: [email protected]⁠). If you are a programmer with technical questions please reach out to the senior programmer of 10k Immunomes, Matthew Elliott (email: [email protected]⁠). We look forward to hearing from you!