Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Install docs #93

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 16 additions & 23 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,39 @@
# Installation

It is advisable but not required that you install Napari Lattice packages inside a conda environment.
This is because conda makes it much easier to install system complex dependencies.
## Recommended Installation

To install the core package, which includes the Python library and command line interface:
First, create a new conda environment:

```bash
pip install lls-core
conda create -n napari-lattice -c conda-forge 'python==3.11.*' uv pycudadecon
```

To install the Napari plugin:
!!! info

```bash
pip install napari-lattice
```

## CUDA Deconvolution
We include `pycudadecon` to enable GPU accelerated 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
!!! info

To install the development version of `lls-core`:
`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
```
10 changes: 10 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,16 @@ markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.superfences
- admonition
- pymdownx.details

nav:
- index.md
- installation.md
- cli.md
- api.md
- workflow.md
- development.md

plugins:
- search
Expand Down
Loading