Skip to content

Commit b073237

Browse files
author
Leander Lauenburg
committed
docs: update README for replicability stamp and add quick start setup instructions
1 parent ea8a673 commit b073237

2 files changed

Lines changed: 33 additions & 7 deletions

File tree

README.md

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,16 @@ For the full functionality and configuration options of SynAnno, try the complet
1818

1919
**Accepted at IEEE VIS 2025** | **Preprint:** [bioRxiv](https://www.biorxiv.org/content/10.1101/2025.08.09.669342v1.full.pdf)
2020

21-
## Replicability Stamp <img src="./replicabilitystamp/replicibility_logo.png" alt="Replicability Stamp" width="40" style="margin-left: 10px; vertical-align: middle;">
21+
## Replicability Stamp <img src="./replicabilitystamp/replicibility_logo.png" alt="Replicability Stamp" width="40">
2222

2323
SynAnno has received the [Replicability Stamp](https://www.replicabilitystamp.org/index.html#https-github-com-pytorchconnectomics-synanno) from the Graphics Replicability Stamp Initiative (GRSI), recognizing the reproducibility of our results and our commitment to open science.
2424

2525
---
2626

2727
## Table of Contents
2828

29+
- [Publication](#publication)
30+
- [Replicability Stamp](#replicability-stamp)
2931
- [Key Components and Subjects](#key-components-and-subjects)
3032
- [H01](#h01)
3133
- [Direction of Information Flow](#direction-of-information-flow)
@@ -43,9 +45,11 @@ SynAnno has received the [Replicability Stamp](https://www.replicabilitystamp.or
4345
- [Error Categorization](#error-categorization)
4446
- [Error Correction](#error-correction)
4547
- [Setup](#setup)
46-
- [Docker](#docker)
47-
- [Local Installation](#local-installation)
48-
- [Example Data](#example-data-h01)
48+
- [Quick Start (Automated Setup)](#quick-start-automated-setup)
49+
- [Manual Setup](#manual-setup)
50+
- [Docker](#docker)
51+
- [Local Installation](#local-installation)
52+
- [Example Data](#example-data)
4953
- [Contributing](#contributing)
5054

5155
## Key Components and Subjects
@@ -288,9 +292,31 @@ In this view, you can download the JSON file containing the instances' metadata
288292

289293
## Setup
290294

295+
### Quick Start (Automated Setup)
296+
297+
For the fastest way to try SynAnno, use our automated setup script from the replicability stamp submission:
298+
299+
```bash
300+
curl -O https://raw.githubusercontent.com/PytorchConnectomics/SynAnno/main/replicabilitystamp/setup_synanno.sh
301+
bash setup_synanno.sh
302+
```
303+
304+
This script will:
305+
- Clone the SynAnno repository
306+
- Build the Docker image automatically
307+
- Run the application on port 80
308+
- Open your browser to the demo at `http://localhost/demo`
309+
310+
To clean up afterwards:
311+
```bash
312+
bash setup_synanno.sh cleanup
313+
```
314+
315+
### Manual Setup
316+
291317
Download SynAnno and unzip it into a folder of your choice. For the following we assume you've unzipped the folder under `/home/user/SynAnno`. You can either run SynAnno in a Docker container or set up a local environment.
292318

293-
### Docker
319+
#### Docker
294320

295321
Repository includes a Dockerfile that enables you to build and run the application in a Docker container to isolate it from your local setup. It ensures a consistent environment across different machines, simplifying deployment and avoiding potential configuration issues.
296322

@@ -387,7 +413,7 @@ Why Use `uv`?
387413
source .venv/bin/activate
388414
```
389415

390-
5. Install Dependencies:
416+
5. **Install Dependencies:**
391417

392418
```bash
393419
uv pip install -e ."[seg,dev]"
@@ -404,7 +430,7 @@ SynAnno can be configured via environment variables or the `.env` file.
404430

405431
### Start up SynAnno
406432

407-
From with in the repository (e.g. `/home/user/SynAnno`) start SynAnno using the following command:
433+
From within the repository (e.g. `/home/user/SynAnno`) start SynAnno using the following command:
408434

409435
```python
410436
python run.py
15.8 KB
Loading

0 commit comments

Comments
 (0)