Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 3.15 KB

File metadata and controls

39 lines (26 loc) · 3.15 KB

Test and Docs create bioimage.io index check compatibility

collection

This repository is used to add information to the resources displayed on [bioimage.io][https://bioimage.io]. Primarily it adds information about software compatibility of bioimage.io community partners.

Maintaining the bioimage.io Collection

Current reviewers are listed in [bioimageio_collection_config.json][review-config], under section reviewers. Resource upload and review are handled by bioimage.io.

Reviewer Onboarding

  1. Open a pull request, adding a person to the [list of reviewers][review-config], see #75 for an example.
    • one public email address is required
    • github id can be found using https://api.github.com/users/<github_username>
  2. For the changes to be applied, the service needs to be restarted manually. Reach out to the team or leave an issue.
  3. Once the pull request has been merged and the respective Hypha service has been restarted, the new reviewer can
    • accept resource drafts
    • request changes on resource drafts
    • upload a new version for any resource

Software Compatibility Checks

Resource published on bioimage.io are automatically tested for compatibility with registered bioimage.io community partner tools.

Add community partner

To link yourself as a community partner, please create a PR to insert relevant metadata into bioimageio_collection_config.json under "partners". Checkout ilastik partner entry for an example.

Add community partner compatibility checks

Any community partner is invited to add a GitHub Actions workflow in this repo (please make a PR) that generates reports on its software compatibility with new and updated resources in the bioimage.io collection. See ilastik compatibility checks workflow for an example.

If you are not familiar with GitHub Actions workflows, we can help you to set this up analog to our existing community partner compatibility checks. Ideally you can provide a script to create a compatibility report (a relativley simple json file) for a given resource description. see this Python script as an example.