Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
akhanf committed Jan 30, 2025
1 parent b6a6a15 commit e7aedfe
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 @@ -9,6 +9,13 @@ A Snakemake workflow for pre-processing single plane illumination microscopy (SP

Takes TIF images (tiled or prestitched) and outputs a validated BIDS Microscopy dataset, with a multi-channel multi-scale OME-Zarr file for each scan, along with downsampled nifti images (in a derivatives folder).

## Supported inputs:

SPIMprep supports a range of inputs, with the type of acquisition specified by including
the short-hand name (in bold below) as a substring in the acquisition tag.
- **`blaze`**: Raw Ultramicroscope Blaze OME TIFF files, either as 2D or 3D TIFF files
- **`prestitched`**: Prestitched images, as a stack of 2D TIF files (e.g. from LifeCanvas)
- **`imaris`**: Prestitched into a single Imaris (.ims) file.


## Requirements
Expand All @@ -17,10 +24,6 @@ Takes TIF images (tiled or prestitched) and outputs a validated BIDS Microscopy
- (Note: container will be automatically pulled when you run the workflow)
- Python >= 3.11
- Lightsheet data:
- Raw Ultramicroscope Blaze OME TIFF files (include `blaze` in the acquisition tag)
- can be 2D or 3D TIFF files
- Prestitched TIFF files (include `prestitched` in the acquisition tag)


## Usage

Expand Down

0 comments on commit e7aedfe

Please sign in to comment.