Skip to content

Commit

Permalink
Merge pull request #30 from joshmoore/under-the-hood
Browse files Browse the repository at this point in the history
Update README with under-the-hood details
  • Loading branch information
joshmoore authored Aug 20, 2024
2 parents 7f63225 + 0eb9e93 commit 53cdf2b
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,22 +138,33 @@ $ ome2024-ngff-challenge --input-bucket=bia-integrator-data --input-endpoint=htt

## Converting your data

### Getting started
The `ome2024-ngff-challenge` tool can be used to convert an OME-Zarr 0.4 dataset
that is based on Zarr v2. The input data will **not be modified** in any way and
a full copy of the data will be created at the chosen location.

The `ome2024-ngff-challenge` script can be used to convert an OME-Zarr 0.4
dataset that is based on Zarr v2:
### Getting started

```
ome2024-ngff-challenge input.zarr output.zarr
```

If you would like to re-run the script with different parameters, you can
additionally set `--output-overwrite` to ignore a previous conversion:
is the most basic invocation of the tool. If you would like to re-run the script
with different parameters, you can additionally set `--output-overwrite` to
ignore a previous conversion:

```
ome2024-ngff-challenge input.zarr output.zarr --output-overwrite
```

### Writing in parallel

By default, 16 chunks of data will be processed simultaneously in order to bound
memory usage. You can increase this number based on your local resources:

```
ome2024-ngff-challenge input.zarr output.zarr --output-threads=128
```

### Reading/writing remotely

If you would like to avoid downloading and/or upload the Zarr datasets, you can
Expand Down

0 comments on commit 53cdf2b

Please sign in to comment.