Skip to content

Commit ed393af

Browse files
Merge pull request #143 from AllenNeuralDynamics/seanfite-alleninstitute-patch-1
Update README.md
2 parents 8e53a92 + 23dfcbf commit ed393af

1 file changed

Lines changed: 22 additions & 8 deletions

File tree

README.md

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Rhapso
22

3-
This is the code base for **Rhapso**, a modular Python toolkit for the alignment and stitching of large-scale microscopy datasets.
3+
This is the official code base for **Rhapso**, a modular Python toolkit for the alignment and stitching of large-scale microscopy datasets.
44

55
[![License](https://img.shields.io/badge/license-MIT-brightgreen)](LICENSE)
66
[![Python Version](https://img.shields.io/badge/python-3.10-blue.svg)](https://www.python.org/downloads/release/python-3100/)
@@ -18,6 +18,8 @@ This is the code base for **Rhapso**, a modular Python toolkit for the alignment
1818
- [Performance](#performance)
1919
- [Layout](#layout)
2020
- [Installation](#installation)
21+
- [How To Start](#how-to-start)
22+
- [Try Rhapso on Sample Data](#try-rhapso-on-sample-data)
2123
- [Ray](#ray)
2224
- [Run Locally w/ Ray](#run-locally-with-ray)
2325
- [Run on AWS Cluster w/ Ray](#run-on-aws-cluster-with-ray)
@@ -42,13 +44,7 @@ Rhapso is still loading... and while we wrap up development, a couple things to
4244
## Summary
4345
Rhapso is a set of Python components used to register, align, and stitch large-scale, overlapping, tile-based, multiscale microscopy datasets. Its stateless components can run on a single machine or scale out across cloud-based clusters.
4446

45-
Rhapso is published on PyPI and can be installed with:
46-
47-
```bash
48-
pip install Rhapso
49-
```
50-
51-
<br>
47+
Rhapso is published on PyPI.
5248

5349
Rhapso was developed by the Allen Institute for Neural Dynamics.
5450

@@ -167,6 +163,24 @@ A good way to get started:
167163

168164
<br>
169165

166+
## Try Rhapso on Sample Data
167+
168+
The quickest way to get familiar with Rhapso is to run it on a real dataset. We have a small (10GB) Z1 example hosted in a public S3 bucket, so you can access it without special permissions. It’s a good starting point to copy and adapt for your own alignment workflows.
169+
170+
XML (input)
171+
- s3://aind-open-data/HCR_802704_2025-08-30_02-00-00_processed_2025-10-01_21-09-24/image_tile_alignment/single_channel_xmls/channel_488.xml
172+
173+
Image prefix (referenced by the XML)
174+
- s3://aind-open-data/HCR_802704_2025-08-30_02-00-00_processed_2025-10-01_21-09-24/image_radial_correction/
175+
176+
<br>
177+
178+
**Note:** Occasionally we clean up our aind-open-data bucket. If you find this dataset does not exist, please create an issue and we will replace it.
179+
180+
---
181+
182+
<br>
183+
170184
## High Level Approach to Registration, Alignment, and Fusion
171185

172186
This process has a lot of knobs and variations, and when used correctly, can work for a broad range of datasets.

0 commit comments

Comments
 (0)