haesleinhuepf / napari-hub-collections

collections of plugins for the napari hub

napari hub collections

This repository contains the content for plugin Collections on the napari hub.

Plugin Collections are sets of plugins from the napari hub curated by fellow community members. A collection might be:

• A protocol or recipe that shows how to use a set of plugins to complete an image analysis workflow
• A toolkit or pack that helps a napari user get started within a research domain
• An assortment that is defined by another central theme that connects the plugins

Have an idea for a Collection you'd like to share with the napari community? Curate your own Collection following the directions below.

How to Submit a Collection

Collections can be submitted directly to this repo via a pull request. Download the collection-template.yml file from the the napari-hub-collections repository and fill out the fields detailed below for your Collection before making a pull request to add your unique file to the collections folder.

NOTE: If you aren't comfortable with Github, email Dannielle McCarthy so that she can facilitate your Collection submission.

• title: Human-readable descriptive name of the Collection contents. (e.g. Reader Plugins, Electron Microscopy Toolkit, Cell Segmentation Workflow, etc.) You may use the name to specify if the Collection is a grouping of plugins or an ordered list of plugins for a certain task.

• updated_date: The date the Collection was submitted or last updated. This must be in ISO-8601 format within double quotes (e.g. "2022-05-24").

• summary: One-sentence overview of the Collection, displayed on the Collection card, to give napari users insight into what the Collection contains and how it will help them. (Max length: 75 characters with spaces)

• description: Longer description of the Collection, displayed at the top of the Collection page, to give napari users more background and context on the Collection, what the plugins do, and why it matters. (Max length: 500 characters with spaces)

• cover_image: A large image the top of your Collection. Optimal size is >1400px. Field must be populated with the full file name with the extension (e.g. national-cancer-institute-lsxKuARrQXI-unsplash.jpg) of an image in the images folder. Browse the available images or upload your own.

• plugins: List of plugins in the Collection with each plugin's PyPI name (e.g. napari-sim-processor) and an optional comment about the plugin to let users know why this plugin matters.

• curator information: Information on you to share who created this Collection to the community. You can share your name, title, institution, website, ORCID ID, and links to twitter, GitHub and other relevant websites.

Mockups

Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [e-mail].

Reporting Security Issues

If you believe you have found a security issue, please responsibly disclose by contacting us at [e-mail].