README.md

napari-proofread-brainbow

https://github.com/LaboratoryOpticsBiosciences/napari-proofread-brainbow

Proofreading Brainbow images with napari

---

Important

This repository has been migrated to LaboratoryOpticsBiosciences/napari-proofread-brainbow since v0.3.1.

This napari plugin was generated with copier using the napari-plugin-template.

Installation

You can install napari-proofread-brainbow via pip:

pip install napari-proofread-brainbow

Developer Setup

After cloning the repository, you can set up a development environment with conda:

pip

Step 1: Create and activate the corresponding conda environment

conda create -n napari-proofread-brainbow -c conda-forge python=3.11 napari pyqt pytest pytest-qt tox -y
conda activate napari-proofread-brainbow

Step 2: Install requirements with pip

cd napari-proofread-brainbow
pip install -e .

Step 3: Test the plugin by running napari

napari

The plugin should appear under Plugins > Proofread Brainbow

With uv

uv sync --extra testing
uv run napari

Contributing

Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.

License

Distributed under the terms of the MIT license, "napari-proofread-brainbow" is free and open source software

Issues

If you encounter any problems, please [file an issue] along with a detailed description.