Skip to content

Commit dee0935

Browse files
Add video links to README and documentation
1 parent 3ab9a8d commit dee0935

File tree

3 files changed

+6
-3
lines changed

3 files changed

+6
-3
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
SynapseNet is a tool for segmentation and analysis of synapses in electron microscopy.
44

5-
To learn how to use SynapseNet, check out [the documentation](https://computational-cell-analytics.github.io/synapse-net/).
5+
To learn how to use SynapseNet, check out [the documentation](https://computational-cell-analytics.github.io/synapse-net/) and [the tutorial video](https://youtu.be/7n8Oq1uAByE).
66
To learn more about how it works, check out [our preprint](https://www.biorxiv.org/content/10.1101/2024.12.02.626387v1).
77

88
See an example reconstruction of a mossy fibre synapse with SynapseNet.

doc/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
video/

doc/start_page.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ It provides deep neural networks for:
1010

1111
It also offers functionality for quantifying synaptic ultrastructure based on segmentation results, for example by measuring vesicle or structure morphology, measuring distances between vesicles and structures, or assigning vesicles into different pools.
1212
SynapseNet mainly targets electron tomography, but can also be appled to other types of electron microscopy,
13-
especially throught the [domain adaptation](domain-adaptation) functionality.
13+
especially throught the [domain adaptation](#domain-adaptation) functionality.
1414

15-
SynapseNet offers a [napari plugin](napari-plugin), [command line interface](command-line-interface), and [python library](python-library).
15+
SynapseNet offers a [napari plugin](#napari-plugin), [command line interface](#command-line-interface), and [python library](#python-library).
1616
Please cite our [bioRxiv preprint](https://www.biorxiv.org/content/10.1101/2024.12.02.626387v1) if you use it in your research.
1717

1818

@@ -72,6 +72,8 @@ We currently offer seven different models for segmenting synaptic structures:
7272

7373
## Napari Plugin
7474

75+
You can find a video tutorial for the SynapseNet napari plugin [on YouTube](https://youtu.be/7n8Oq1uAByE). Below, we explain the different plugin components with screenshots.
76+
7577
After installing SynapseNet you can start napari by activating the `synapse-net` environment (or another environment you installed it in) and executing the `napari` command.
7678
Once napari is opened, you can load a tomogram (or other image data), by drag'n'dropping the corresponding mrc file onto the napari window.
7779

0 commit comments

Comments
 (0)