2022 CZI napari Plugin Accelerator Grant Workshop Series
The Chan Zuckerberg Initiative’s napari Plugin Accelerator Grant program aims to support napari plugin ecosystem development, with the goal of providing easy access to reproducible, quantitative bioimage analysis tools to biologists. This workshop series was intended to support napari plugin developers, covering topics for making quality napari plugins, from building and testing napari plugins, designing accessible user interfaces, developing user-friendly documentation, and sharing plugins on the napari hub.
SPEAKER(s)
Draga Doncila Pop, napari core developer
Talley Lambert, Harvard Medical School
DESCRIPTION
Overview:
- General introduction to building and testing napari plugins in python
- Specific case examples of testing napari plugins (e.g. reader/writer, widget)
- Running tests on GitHub actions
- Quick review of best practices for building napari plugins
- Intro to pre-commit
SPEAKER(S)
Andy Sweet, Chan Zuckerberg Initiative
Lucy Obus, Chan Zuckerberg Initiative
DESCRIPTION
Overview:
Part 1 – Core Concepts
- napari core concepts: viewer, layers, data, events
- Plugin core concepts: contribution types, interacting with napari layers
- Development support: forums
Part 2 – User Experience Research You Can Do Today
- What is UXR: Low effort, high impact help
- How it works: Observe, Reflect, Make
- Examples
SPEAKER(S)
Lucy Obus, Chan Zuckerberg Initiative
Justin Kiggins, Chan Zuckerberg Initiative
DESCRIPTION
Overview:
Part 1 – Improving the overall quality of the napari plugin ecosystem
- Motivation for improvement
- Learnings from users regarding useful quality signals
Part 2 – Specifics of quality checklists
- How can these items can be implemented
- What’s coming on the napari hub to help developers achieve high-quality plugin development
- Ways to let users find high-quality plugins more easily
SPEAKER(S)
Chi-Li Chiu, Chan Zuckerberg Initiative
DESCRIPTION
Overview:
This workshop covers ways to enhance a plugin’s reach from two aspects: plugin design and the user’s learning experience. By making plugins more modular and generalizable, plugin developers could maximize potential use cases and integrate better with the broader plugin ecosystem. By providing an intuitive plugin interface and clear documentation, users would be able to learn how to use the plugin efficiently, thus maximizing the impact of the plugins.
SPEAKER(S)
Melissa Weber Mendonca, Quansight
Lia Prins, Chan Zuckerberg Initiative
Isabela Presedo-Floyd, Quansight Labs
DESCRIPTION
Overview:
Part 1 – The role and importance of documentation for napari plugins
- Types of documentation (Diátaxis framework)
- Tooling
- Sphinx
- Jupyter notebooks
- Reproducibility
Part 2 – A quick overview of the napari design process / “design thinking” / how to solve your user’s needs
- GUI layout + organization
- When to use different components
Part 3 – Design considerations for non-designers with napari plugin examples
- Consistency
- Accessibility