Skip to content

Commit

Permalink
docs: remove obsolete parts in installation guide
Browse files Browse the repository at this point in the history
  • Loading branch information
qin-yu committed Oct 7, 2024
1 parent 69a62c5 commit da661a5
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 16 deletions.
17 changes: 3 additions & 14 deletions docs/chapters/getting_started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@ PlantSeg can be installed directly by executing in the terminal (or PowerShell o
mamba create -n plant-seg -c pytorch -c nvidia -c conda-forge pytorch cpuonly plant-seg --no-channel-priority
```


=== "Windows"

* NVIDIA GPU version, CUDA=12.x
Expand All @@ -82,7 +81,7 @@ PlantSeg can be installed directly by executing in the terminal (or PowerShell o
* Apple silicon version

```bash
mamba create -n plant-seg -c pytorch -c conda-forge python=3.11 pytorch::pytorch pyqt plant-seg --no-channel-priority
mamba create -n plant-seg -c pytorch -c conda-forge python=3.11 pytorch::pytorch plant-seg --no-channel-priority
```

If you used older versions of PlantSeg, please delete the old config files in `~/.plantseg_models/configs/` after installing new PlantSeg.
Expand All @@ -93,24 +92,14 @@ Please refer to the [PyTorch](https://pytorch.org/get-started/locally/) website

## Optional dependencies

If you want to use the headless mode of PlantSeg, you need to install `dask[distributed]`:

```bash
conda activate plant-seg
mamba install dask distributed
```

Some types of compressed tiff files require an additional package to be load correctly (e.g.: Zlib, ZSTD, LZMA, ...).
To run PlantSeg on those stacks, you need to install `imagecodecs`.
In the terminal:
Certain compressed TIFF files (e.g., Zlib, ZSTD, LZMA formats) require additional codecs to be processed correctly by PlantSeg. To handle such files, install the `imagecodecs` package:

```bash
conda activate plant-seg
pip install imagecodecs
```

Experimental support for SimpleITK watershed segmentation has been added to PlantSeg version 1.1.8.
These features can be used only after installing the SimpleITK package:
If you plan to use SimpleITK-based watershed segmentation, you will need to install `SimpleITK` as an additional dependency:

```bash
conda activate plant-seg
Expand Down
3 changes: 1 addition & 2 deletions environment-elife.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: plant_seg
name: plant-seg-elife
channels:
- pytorch
- cpape
Expand Down Expand Up @@ -136,4 +136,3 @@ dependencies:
- werkzeug==0.16.0
- wrapt==1.11.2
prefix: /home/lcerrone_local/miniconda3/envs/plant_seg

1 change: 1 addition & 0 deletions environment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ dependencies:
- scikit-image
- bioimageio.core>=0.6.5
# GUI
- pyqt
- napari
# Other
- requests
Expand Down

0 comments on commit da661a5

Please sign in to comment.