Skip to content
This repository was archived by the owner on Apr 14, 2026. It is now read-only.

Commit be796bd

Browse files
committed
Update readme
1 parent e75adef commit be796bd

1 file changed

Lines changed: 4 additions & 9 deletions

File tree

README.md

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,8 @@ pip install styxsingularity
2323
from styxdefs import set_global_runner
2424
from styxsingularity import SingularityRunner
2525

26-
# Initialize the SingularityRunner with your container images
27-
runner = SingularityRunner(
28-
images={
29-
"ubuntu:20.04": "/path/to/ubuntu_20.04.sif",
30-
"python:3.9": "/path/to/python_3.9.sif"
31-
}
32-
)
26+
# Initialize the SingularityRunner
27+
runner = SingularityRunner()
3328

3429
# Set the global runner for Styx
3530
set_global_runner(runner)
@@ -41,7 +36,7 @@ set_global_runner(runner)
4136

4237
The `SingularityRunner` class accepts several parameters for advanced configuration:
4338

44-
- `images`: A dictionary mapping container image tags to their local paths
39+
- `image_overrides`: A dictionary to override container image tags
4540
- `singularity_executable`: Path to the Singularity executable (default: `"singularity"`)
4641
- `data_dir`: Directory for temporary data storage
4742
- `environ`: Environment variables to set in the container
@@ -50,7 +45,7 @@ Example:
5045

5146
```python
5247
runner = SingularityRunner(
53-
images={"ubuntu:20.04": "/path/to/ubuntu_20.04.sif"},
48+
image_overrides={"python:3.9": "my-custom-python:3.9"},
5449
singularity_executable="/usr/local/bin/singularity",
5550
data_dir="/tmp/styx_data",
5651
environ={"PYTHONPATH": "/app/lib"}

0 commit comments

Comments
 (0)