README.md 1.77 KB
Newer Older
Philipp Schubert's avatar
Philipp Schubert committed
1
# SyConn v2
Philipp Schubert's avatar
Philipp Schubert committed
2
Refactored (still an early stage construction) version of SyConn for automated synaptic connectivity inference based on dense EM segmentation data.
Philipp Schubert's avatar
Philipp Schubert committed
3
For v0.1 see the SyConn branch [dorkenwald2017nm](https://github.com/StructuralNeurobiologyLab/SyConn/tree/dorkenwald2017nm).
4

Philipp Schubert's avatar
Philipp Schubert committed
5
Version 0.2 currently features:
Philipp Schubert's avatar
Philipp Schubert committed
6
7
8
- introduction of supervoxel and agglomerated supervoxel classes
- added support for (sub-) cellular compartment (spines, axon/dendrite/soma) and cell type classification with [skeleton](https://www.nature.com/articles/nmeth.4206)- and [multiview-based](https://www.biorxiv.org/content/early/2018/07/06/364034) approaches
- cell organelle prediction, extraction and mesh generation
9
- [glia identification and splitting](https://www.biorxiv.org/content/early/2018/07/06/364034)
Philipp Schubert's avatar
Philipp Schubert committed
10
11
- generation of connectivity matrix

Philipp Schubert's avatar
Philipp Schubert committed
12
## System requirements & installation
13
14
* Python 3.5
* The whole pipeline was designed and tested on Linux systems (CentOS, Arch)
Philipp Schubert's avatar
Philipp Schubert committed
15
* SyConn is based on the packages [elektronn](http://elektronn.org), [knossos-utils](https://github.com/knossos-project/knossos_utils)
Philipp Schubert's avatar
Philipp Schubert committed
16
 is used for visualization and annotation of 3D EM data sets.
17
18
19
20
21
22
23
24
25
26
* [VIGRA](https://ukoethe.github.io/vigra/), e.g. ``conda install -c ukoethe vigra``
* osmesa, e.g.: ``conda install -c menpo osmesa``

You can install SyConn using  ``git`` and  ``pip``:

    git clone https://github.com/SyConn
    cd SyConn
    pip install -r requirements.txt
    pip install .

Philipp Schubert's avatar
Philipp Schubert committed
27
## Tutorials & documentation
Philipp Schubert's avatar
Philipp Schubert committed
28

Philipp Schubert's avatar
Philipp Schubert committed
29
For the SyConn documentation see [here](docs/doc.md).
Philipp Schubert's avatar
Philipp Schubert committed
30

Philipp Schubert's avatar
Philipp Schubert committed
31
To build the API documentation run `make html` in the `docs` folder.
Philipp Schubert's avatar
Philipp Schubert committed
32
33
34

# The Team
The Synaptic connectivity inference toolkit developed is developed at Max-Planck-Institute of Neurobiology, Munich.
35

Philipp Schubert's avatar
Philipp Schubert committed
36
Authors: Philipp Schubert, Sven Dorkenwald, Rangoli Saxena, Joergen Kornfeld