Skip to content

Commit 659f310

Browse files
Update installation instructions
1 parent 535a846 commit 659f310

1 file changed

Lines changed: 17 additions & 2 deletions

File tree

doc/start_page.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,25 @@ Please cite our [bioRxiv preprint](https://www.biorxiv.org/content/10.1101/2024.
2020

2121
SynapseNet was tested on all operating systems (Linux, Mac, Windows).
2222
SynapseNet requires a GPU or a Macbook with M chipset for the segmentation of 3D volumes.
23+
It can be installed via [conda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html)
24+
(or [mamba](https://mamba.readthedocs.io/en/latest/installation/mamba-installation.html)) and `pip`.
25+
26+
To install in an existing Python environment follow these steps:
27+
- First, download the SynapseNet repository via
28+
```bash
29+
git clone https://github.com/computational-cell-analytics/synapse-net
30+
```
31+
- Then, enter the `synapse-net` folder:
32+
```bash
33+
cd synapse-net
34+
```
35+
- Then, install the `synapse-net` via pip:
36+
```bash
37+
pip install -e .
38+
```
2339

24-
You need a [conda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html) or [mamba](https://mamba.readthedocs.io/en/latest/installation/mamba-installation.html) installation. Follow the instruction at the respective links if you have installed neither. We assume you have `conda` for the rest of the instructions. After installing it, you can use the `conda` command.
2540

26-
To install it you should follow these steps:
41+
To install it in a new conda environment follow these steps:
2742
- First, download the SynapseNet repository via
2843
```bash
2944
git clone https://github.com/computational-cell-analytics/synapse-net

0 commit comments

Comments
 (0)