Skip to content

Commit 187e063

Browse files
committed
Update README with docker build instructions
1 parent cbcfa5d commit 187e063

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,43 @@ environment variable:
3333
echo "RSLP_PREFIX=project_data/" > .env
3434

3535

36+
Docker Build
37+
------------
38+
39+
The project includes a multi-stage Docker build for creating containerized environments.
40+
41+
### Prerequisites
42+
43+
- Docker with BuildKit support
44+
- SSH access to the following private repositories:
45+
- `github.com:allenai/rslearn`
46+
- `github.com:allenai/olmoearth_pretrain`
47+
- `github.com:allenai/olmoearth_run`
48+
- Your SSH key should be loaded in your SSH agent
49+
50+
### Building Images
51+
52+
To build all targets:
53+
54+
docker buildx bake
55+
56+
To build a specific target:
57+
58+
docker buildx bake base # Base image with core dependencies
59+
docker buildx bake full # Full image with all tools and rslearn
60+
61+
### Build Targets
62+
63+
- **base**: Core PyTorch environment with rslearn_projects and olmoearth dependencies
64+
- **full**: Includes rslearn, tippecanoe, and additional development tools
65+
66+
### Notes for Local Development
67+
68+
Local developers with a single SSH key that has access to all repositories can build directly
69+
without additional configuration. The multi-key SSH setup is only required in CI/CD environments
70+
where separate deploy keys are used for each repository.
71+
72+
3673
Applications
3774
------------
3875

0 commit comments

Comments
 (0)