Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add video to readme #41

Merged
merged 3 commits into from
Apr 6, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 18 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,71 +1,50 @@
<!--[![Downloads](https://pepy.tech/badge/napari-arboretum)](https://pepy.tech/project/napari-arboretum)-->
[![License](https://img.shields.io/pypi/l/napari-arboretum.svg?color=green)](https://github.com/quantumjot/napari-arboretum/raw/master/LICENSE)
[![License](https://img.shields.io/pypi/l/napari-arboretum.svg?color=green)](https://github.com/lowe-lab-ucl/napari-arboretum/raw/master/LICENSE)
[![PyPI](https://img.shields.io/pypi/v/napari-arboretum.svg?color=green)](https://pypi.org/project/napari-arboretum)
[![Python Version](https://img.shields.io/pypi/pyversions/napari-arboretum.svg?color=green)](https://python.org)
[![tests](https://github.com/quantumjot/arboretum/workflows/tests/badge.svg)](https://github.com/quantumjot/arboretum/actions)
[![tests](https://github.com/lowe-lab-ucl/arboretum/workflows/tests/badge.svg)](https://github.com/quantumjot/arboretum/actions)
[![codecov](https://codecov.io/gh/lowe-lab-ucl/arboretum/branch/master/graph/badge.svg?token=2M2HhM60op)](https://codecov.io/gh/lowe-lab-ucl/arboretum)

# Arboretum


![](https://raw.githubusercontent.com/lowe-lab-ucl/arboretum/master/examples/arboretum.gif)
*Automated cell tracking and lineage tree reconstruction*.

### Overview

A dockable widget for [Napari](https://github.com/napari) for visualizing cell lineage trees.


Features:
+ Lineage tree plot widget
+ Integration with [btrack](https://github.com/quantumjot/BayesianTracker)

This project has changed considerably. The `Tracks` layer, originally developed for this plugin, is now an official layer type in napari. Read the napari documentation here:
https://napari.org/api/stable/napari.layers.Tracks.html#napari.layers.Tracks


To view the legacy version of this plugin, visit the legacy branch:
https://github.com/quantumjot/arboretum/tree/v1-legacy

[![LineageTree](https://raw.githubusercontent.com/quantumjot/arboretum/master/examples/arboretum.png)]()
*Automated cell tracking and lineage tree reconstruction*.

---

### Usage

Once installed, Arboretum will be visible in the `Plugins > Add Dock Widget > napari-arboretum` menu in napari. To visualize a lineage tree, click on one of the tracks in a napari `Tracks` layer.



### Installation

We recommend that you first install napari. Detailed instructions are here: https://github.com/napari/napari.

```sh
pip install 'napari[all]'
```

You can install arboretum directly from napari (using the `Plugins > Install/Uninstall Packages(s)...` menu) and searching for `napari-arboretum`.
### Examples

Alternatively, you can install directly from source:
You can use the example script to display some sample tracking data in napari and load the arboretum tree viewer:

```sh
git clone https://github.com/quantumjot/arboretum.git
cd arboretum
pip install -e .
python ./examples/show_sample_data.py
```

### Usage

Once installed, Arboretum will be visible in the `Plugins > Add Dock Widget > napari-arboretum` menu in napari. To visualize a lineage tree, click on one of the tracks in a napari `Tracks` layer.

You can use *btrack* to generate tracks from your image data. See the example notebook here:
https://github.com/quantumjot/BayesianTracker/blob/master/examples/segmentation_to_btrack_to_napari.ipynb


Alternatively, you can use *btrack* to generate tracks from your image data. See the example notebook here:
https://github.com/quantumjot/BayesianTracker/blob/master/examples

---

#### TODO:
+ [ ] Highlight cells in the viewer from the lineage tree view
+ [ ] Visualize merges
+ [ ] Color trees by properties
### History

This project has changed considerably. The `Tracks` layer, originally developed for this plugin, is now an official layer type in napari. Read the napari documentation here:
https://napari.org/api/stable/napari.layers.Tracks.html#napari.layers.Tracks

---

To view the legacy version of this plugin, visit the legacy branch:
https://github.com/quantumjot/arboretum/tree/v1-legacy
Binary file added examples/arboretum.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed examples/napari.png
Binary file not shown.
Binary file removed examples/track_layer.jpeg
Binary file not shown.