Skip to content

Commit 7e4cc9e

Browse files
authored
Merge pull request #7 from djinnome/patch-1
Instructions for generating a personal access token
2 parents 457e914 + 6815517 commit 7e4cc9e

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,14 @@ You can reach us at [AllenCenterCovertLab](mailto:[email protected]
99

1010
See [docs/README.md](docs/README.md) for more info on setting up and running the model.
1111

12-
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:
12+
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:
13+
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.
14+
1. Place the token in `github_personal_access_token.txt`.
15+
1. Log in to `docker.pkg.github.com`:
16+
```bash
17+
cat github_personal_access_token.txt | docker login https://docker.pkg.github.com -u USERNAME --password-stdin
18+
```
19+
You should see an output message like `Login Succeeded`
1320
1. Pull the Docker image:
1421
```shell script
1522
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
2330
python runscripts/manual/runSim.py
2431
```
2532

33+
2634
## Quick start
2735

2836
When running this code, prepare with these steps (the wcm-full Docker container already prepares this for you):

0 commit comments

Comments
 (0)