Skip to content

Commit

Permalink
Use a hybrid conda+uv installation
Browse files Browse the repository at this point in the history
  • Loading branch information
multimeric committed Nov 19, 2024
1 parent ede4ff0 commit 4ebe948
Showing 1 changed file with 13 additions and 35 deletions.
48 changes: 13 additions & 35 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,52 +8,30 @@ First, create a new conda environment:
conda create -n napari-lattice -c conda-forge 'python==3.11.*' uv pycudadecon
```

Then use `uv` to quickly install the Napari Lattice suite:

```bash
uv pip install lls-core napari-lattice napari-aicsimageio pyqt5
```

## Faster Installation using `uv`

Installing both `lls-core` and `napari-lattice` takes about 10 minutes using a fast internet connection.
If your connection is slow, or you just don't want to wait this long, you can install it in about 10 seconds using `uv`:

1. Install `uv` following [the instructions here](https://docs.astral.sh/uv/getting-started/installation/)
2. Create a new project using `uv init my-project`
3. `uv add lls-core napari-lattice`

## Recommended Plugins
!!! info
We include `pycudadecon` to enable GPU accelerated deconvolution.

If you are working with `.czi` files, it is recommended that you install the [`napari-aicsimageio`](https://github.com/AllenCellModeling/napari-aicsimageio) plugin for Napari.
`napari-lattice` does not depend on this plugin, so you will have to install it separately, either using the Napari plugin manager, or using `pip install napari-aicsimageio`.

## CUDA Deconvolution

If you have access to a CUDA-compatible GPU, you can enable deconvolution using `pycudadecon`.

If you're using conda (or micromamba etc), you can run the following:
Activate that environment:

```bash
conda install -c conda-forge pycudadecon
conda activate napari-lattice
```

Otherwise, you will have to manually ensure the systems dependencies are installed, and then:
Then use `uv` to quickly install the Napari Lattice suite:

```bash
pip install lls-core[deconvolution]
uv pip install lls-core napari-lattice napari-aicsimageio pyqt5
```

## Development Versions

To install the development version of `lls-core`:
!!! info
`napari-aicsimageio` isn't a dependency of the Lattice suite, but is required for loading the `.czi` files generated by the Lightsheet

```bash
pip install git+https://github.com/BioimageAnalysisCoreWEHI/napari_lattice.git#subdirectory=core
```
## Development Installation

For `napari-lattice`:
To install the development version of `lls-core`, create the `napari-lattice` environment as above, but instead of installing from pip in the last step:

```bash
pip install git+https://github.com/BioimageAnalysisCoreWEHI/napari_lattice.git#subdirectory=plugin
git clone https://github.com/BioimageAnalysisCoreWEHI/napari_lattice.git
cd napari_lattice
uv pip install -e core -e plugin napari-aicsimageio pyqt5
```

0 comments on commit 4ebe948

Please sign in to comment.