Skip to content

Commit

Permalink
Update workflow.md
Browse files Browse the repository at this point in the history
  • Loading branch information
akhanf authored Oct 1, 2024
1 parent 590fc4c commit 68d236f
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions docs/workflow.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,32 @@
# Workflow

Under construction!

## Overview

SPIMprep is implemented in Python using the [Snakemake](https://snakemake.github.io/) workflow management system. It performs metadata extraction, flatfield correction (BaSiC), and stitching (BigStitcher), followed by the creation of a final validated BIDS dataset.

## Inputs to SPIMprep




## Installation

The workflow is installed via pip, and the required container dependency is downloaded automatically by Snakemake.

## Configuration

Input datasets are configured using a TSV file, specifying subject identifiers and paths to folders/archives containing the raw TIF files, and a YAML file is used to customize workflow configuration.

## Running Parallelization

The workflow can be executed in parallel on any local, cluster or cloud resources, and each step is also internally parallelized (Dask), taking advantage of the parallelization afforded by the chunked file format.

## Cloud support

The workflow can optionally write directly to cloud storage, facilitating data sharing and interoperability with existing web-based viewers.

## Outputs of SPIMprep


0 comments on commit 68d236f

Please sign in to comment.