Skip to content

Commit

Permalink
docs(docker): #57 Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexAxthelm committed Feb 26, 2024
1 parent cac36ee commit 8d81c33
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,17 @@ The goal of `workflow.prepare.pacta.indices` is to run indices through PACTA,
and format them for the Transition Monitor webtool.

## Running Prepare PACTA Indices workflow

### Required input

The index preparation Dockerfile uses the `transitionmonitordockerregistry/rmi_pacta` docker image as a base image. Pulling this image requires access to the Azure docker registry `transitionmonitordockerregistry`.
The index preparation Dockerfile uses the `ghcr.io/rmi-pacta/workflow.transition.monitor` docker image as a base image.
Although the image is public, pullang public images ffrom GHCR requires authentication.

You can authenticate to GHCR with any valid GitHub Personal Access token

You can log-in to this registry by calling:
``` bash
az acr login --name transitionmonitordockerregistry
```
echo $GITHUB_PAT | docker login ghcr.io -u <USERNAME> --password-stdin
```

### Running in Docker
The simplest way to run the data preparation process is by using docker.
Expand Down

0 comments on commit 8d81c33

Please sign in to comment.