From 68155172404c20d3fe6397ab16d1e5e1046efb0c Mon Sep 17 00:00:00 2001 From: Jeremy Zucker Date: Wed, 18 Nov 2020 10:00:11 -0800 Subject: [PATCH] Instructions for generating a personal access token --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 451490a..3f4045c 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,14 @@ You can reach us at [AllenCenterCovertLab](mailto:allencentercovertlab@gmail.com See [docs/README.md](docs/README.md) for more info on setting up and running the model. -In short, there are two alternative setups to run the model: inside a Docker container vs. in a manually constructed `pyenv` virtual environment. With Docker, you can start running a simulation with three commands: +In short, there are two alternative setups to run the model: inside a Docker container vs. in a manually constructed `pyenv` virtual environment. With Docker, you can start running a simulation with these steps: +1. Create a [github personal access token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token) with at least the `read:packages` permission selected. +1. Place the token in `github_personal_access_token.txt`. +1. Log in to `docker.pkg.github.com`: + ```bash + cat github_personal_access_token.txt | docker login https://docker.pkg.github.com -u USERNAME --password-stdin + ``` + You should see an output message like `Login Succeeded` 1. Pull the Docker image: ```shell script docker pull docker.pkg.github.com/covertlab/wholecellecolirelease/wcm-full:latest @@ -23,6 +30,7 @@ In short, there are two alternative setups to run the model: inside a Docker con python runscripts/manual/runSim.py ``` + ## Quick start When running this code, prepare with these steps (the wcm-full Docker container already prepares this for you):