-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1fe9ce7
commit 137dd04
Showing
1 changed file
with
38 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,69 +1,70 @@ | ||
| # napari hub | ||
|
|
||
| This repository contains the source code for the _napari hub_, a place to find, evaluate, and install _napari_ plugins, built by the Imaging Team at the Chan Zuckerberg Initiative. | ||
| [](https://github.com/chanzuckerberg/napari-hub/releases/latest) | ||
| [](https://github.com/chanzuckerberg/napari-hub/actions/workflows/frontend-tests.yml?query=branch%3Amain) | ||
| [](https://github.com/chanzuckerberg/napari-hub/actions/workflows/backend-tests.yml?query=branch%3Amain) | ||
|
|
||
| ## What we're building now | ||
|
|
||
| For our first _alpha/v0_ release in June 2021, the _napari hub_ will focus on making it easy for [Research Biologists, Imaging Scientists, and Bioimage Analysts](https://cziscience.medium.com/user-experience-research-in-the-imaging-field-6bb89e592bb9) to find, evaluate, and install _napari_ plugins distributed through PyPI. | ||
| The [napari hub](https://www.napari-hub.org) lets [napari](https://napari.org) users find community-built plugins that solve their analysis needs. It hosts a growing ecosystem of plugins for segmentation, tracking, detection, registration, file loading, and more. | ||
|
|
||
| After talking with users about the challenges and needs in finding analysis solutions to bioimaging problems, we focused on a handful of critical features for our first release, including... | ||
| ## Our goal | ||
|
|
||
| - _global search bar_ which returns results from multiple metadata sources (title, author, summary, description, etc.) | ||
| - _napari-specific metadata_, such as author(s), links to external docs, support channels, etc., that plugin developers can easily define in PyPI metadata or Github config files | ||
| - _napari-specific description_ supports both napari-specific description specified in their Github repo or default to PyPI description if plugin developer does not use napari-specific description. | ||
| - _install “call-to-action”_ button for each plugin with plugin-specific instructions on how to install | ||
| - _filter/sort_ available plugins based on limited selection of metadata (2-3 filters, 1-2 sorts) that can be handled client side | ||
| - _mailing list_ sign up for announcements and updates for the _napari hub_ | ||
| We seek to support the napari community by seeding and growing a healthy ecosystem of napari plugins that enable the imaging community to perform advanced analysis of imaging and microscopy data sets within napari’s rich interactive interface. To do make this happen, we need to | ||
|
|
||
| ## How we're building now | ||
| 1. enable the **bioimaging analysis community** to easily build, share and maintain napari plugins | ||
| 2. make it easy for **biology researchers** and **imaging scientists** to find, evaluate, and install these plugins | ||
| 3. make sure that **plugin developers** can get feedback for improvement and credit for their work | ||
|
|
||
| The imaging team is comprised of product managers, user experience researchers, designers and engineers that learn with and from the community to build out the napari hub. Our process involves weekly syncs to track progress across disiplines, review and share assets. Just as our product is open source, we want our process to be as well. You can learn more by exploring: | ||
| ## **What are we building now?** | ||
|
|
||
| - [product](https://github.com/chanzuckerberg/napari-hub/wiki#product) strategy documents that inform how we'll make the napari hub a reality | ||
| - [user experience research](https://github.com/chanzuckerberg/napari-hub/wiki#uxr) findings that help us understand the community's challenges and how the napari hub can help | ||
| - [design](https://github.com/chanzuckerberg/napari-hub/wiki#design) sketches and prototypes that bring napari hub features to life | ||
| - [engineering](https://github.com/chanzuckerberg/napari-hub/wiki#engineering) specs and diagrams that help us understand how the napari hub works behind the scenes | ||
| Over the second half of 2021, we are committed to... | ||
|
|
||
| ## What we're building next | ||
| * **Improve** the process of finding, evaluating, and installing napari plugins | ||
| * **Lower barriers** for plugin developers to build, share, and maintain their plugins | ||
| * **Learn** more about what metrics give plugin users signal about quality and give plugin developers actionable feedback | ||
|
|
||
| After our _alpha_ launch, we're very excited to keep iterating and building new features that are of value to the imaging community, supporting current and future _napari_ users and developers. | ||
| You can find our roadmap and other insights into our process (UXR studies, tech specs, designs, and more) by visiting the [napari hub’s wiki.](https://github.com/chanzuckerberg/napari-hub/wiki) | ||
|
|
||
| We have a host of ideas for ways that we can help scientists learn if a plugin is right for them, for imaging scientists to share their knowledge with core facility users and collaborators, and ways to help lower barriers for image analysts in creating, maintaining, and supporting their plugins. | ||
| If you want to share your own ideas on what we should improve or add, we'd love you to submit a [feature request](https://github.com/chanzuckerberg/napari-hub/issues)! This will help us ensure the experience functions as intended for the community. | ||
| ## How can you help? | ||
|
|
||
| We’ll be using this feedback from the community, along with [User Experience Research](https://cziscience.medium.com/product-design-user-experience-research-to-accelerate-science-f9fbbb0d0a06), and consultation with the napari project to prioritize which features we decide to build. | ||
| Interested in helping us grow a thriving community of plugins for napari? There are a few ways you can get involved. | ||
|
|
||
| When we have a clearer idea of our roadmap beyond our June release, we'll share it here. | ||
| ### Join a UXR session | ||
|
|
||
| ## About | ||
| We rely heavily on User Experience Research to understand the needs and challenges of the bioimaging community, identify opportunities for solutions to these challenges, and get feedback on our work. Whether you’re a bench scientist, work at an imaging core, or develop computational methods, sign up here and we’ll reach out when there’s an interview, focus group, or workshop that matches your background. | ||
|
|
||
| The _napari hub_ is built, maintained, and governed by the [Imaging team at the Chan Zuckerberg Initiative](https://chanzuckerberg.com/science/programs-resources/imaging/) as a free service for the napari community. | ||
| ### Share your ideas | ||
|
|
||
| [_napari_](https://napari.org) is a consensus-based community project and an open source tool that enables high performance visualization and exploration of a broad range of imaging data, including microscopy, medical imaging, geospatial data, and more, with clearly defined governance model, mission, and values. | ||
| At CZI, we support the development of open source and community run tools like _napari_, as part of our mission to accelerate biomedical research and help every scientist make progress faster. | ||
| Do you have ideas for new features that would help make the napari hub even better? [Join the discussion](https://github.com/chanzuckerberg/napari-hub/discussions), add [your ideas](https://github.com/chanzuckerberg/napari-hub/discussions/categories/ideas), and give feedback on other’s ideas. | ||
|
|
||
| The [CZI Imaging Team](https://chanzuckerberg.com/science/programs-resources/imaging/) seeks to remove barriers in the analysis of imaging and microscopy data and make it easier for biologists to access emerging methods for bioimage analysis that leverage machine learning. | ||
| CZI sees promise in _napari_ and seeks to assist its development by providing resources not always available to the open source community, including dedicated user research, design, and engineering support. | ||
| CZI is proud to collaborate with the science community to accelerate research and enable open science for all. | ||
| ### Report any bugs | ||
|
|
||
| ### Team | ||
| Bugs happen. If something isn’t working right for you on the hub, please let us know by [submitting an issue](https://github.com/chanzuckerberg/napari-hub/issues). | ||
|
|
||
| ### Help with open issues | ||
|
|
||
| Are you savvy with web development and want to contribute code? We’d love your help tackling some of the “[good first issues](https://github.com/chanzuckerberg/napari-hub/contribute)” we’ve tagged. | ||
|
|
||
|
|
||
| ### Get involved in the napari community | ||
|
|
||
| There are lots of opportunities to get involved with our partners in the napari project. | ||
|
|
||
| ## Team | ||
|
|
||
| We're a cross-functional product team in the [Imaging Program at the Chan Zuckerberg Initiative](https://chanzuckerberg.com/science/programs-resources/imaging/). | ||
|
|
||
| - Jeremy Asuncion, Engineering ([@codemonkey800](https://github.com/codemonkey800)) | ||
| - Draga Doncila Pop, Engineering ([@DragaDoncila](https://github.com/DragaDoncila)) | ||
| - Kira Evans, Engineering ([@kne42](https://github.com/kne42)) | ||
| - Justin Kiggins, Product ([@neuromusic](https://github.com/neuromusic)) | ||
| - Kevin Lai, Engineering ([@klai95](ttps://github.com/klai95)) | ||
| - Justine Larsen, Engineering ([@justinelarsen](https://github.com/justinelarsen)) | ||
| - Ziyang Liu, Engineering ([@ziyangczi](https://github.com/ziyangczi)) | ||
| - Lucy Obus, User Experience ([@LCObus](https://github.com/LCObus)) | ||
| - Lia Prins, Design ([@liaprins-czi](https://github.com/liaprins-czi)) | ||
| - Nicholas Sofroniew, Product ([@sofroniewn](https://github.com/sofroniewn)) | ||
|
|
||
| ## Source Code | ||
|
|
||
| We're building the napari hub out in the open, so if you want to contribute, please take a look at: | ||
|
|
||
| - [napari hub backend](./backend/) | ||
| - [napari hub frontend](./frontend/) | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| This project adheres to the Contributor Covenant [code of conduct](https://github.com/chanzuckerberg/.github/blob/master/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [[email protected]](mailto:[email protected]). |