Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add sopa meta.yaml file #146

Merged
merged 2 commits into from
Jan 5, 2024
Merged

add sopa meta.yaml file #146

merged 2 commits into from
Jan 5, 2024

Conversation

quentinblampey
Copy link
Contributor

@quentinblampey quentinblampey commented Jan 2, 2024

Name of the tool: sopa

Short description: Sopa enables processing and analyses of image-based spatial-omics using a standard data structure and output. We currently support the following technologies: Xenium, MERSCOPE, CosMX, PhenoCycler, MACSIMA, Hyperion. Sopa was designed for generability and low-memory consumption on large images (scales to 1TB+ images). The pipeline outputs contain: (i) Xenium Explorer files for interactive visualization, (ii) a HTML report for quick quality controls, and (iii) a SpatialData .zarr directory for further analyses.

How does the package use scverse data structures (please describe in a few sentences): sopa is built on top of spatialdata, a recent scverse data structure. Sopa also has a great interoperability with packages such as scanpy or squidpy.

  • The code is publicly available under an OSI-approved license
  • The package provides versioned releases
  • The package can be installed from a standard registry (e.g. PyPI, conda-forge, bioconda)
  • The package uses automated software tests and runs them via continuous integration (CI)
  • The package provides API documentation via a website or README
  • The package uses scverse datastructures where appropriate (i.e. AnnData, MuData or SpatialData and their modality-specific extensions)
  • I am an author or maintainer of the tool and agree on listing the package on the scverse website

Recommended

  • Please announce this package on scverse communication channels (zulip, discourse, twitter) -> done on Twitter, see here: https://x.com/QuentinBlampey/status/1742850528898437481?s=20
  • Please tag the author(s) these announcements. Handles (e.g. @scverse_team) to include are:
    • Twitter: QuentinBlampey
    • Zulip: Quentin Blampey
    • Discourse:
    • Mastodon:
  • The package provides tutorials (or "vignettes") that help getting users started quickly -> I will add a few tutorials, but the documentation already contains details for the snakemake pipeline, the CLI, and also the API.
  • The package uses the scverse cookiecutter template.

Copy link
Contributor

@grst grst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks for submitting the package!

@grst grst merged commit 2abfa25 into scverse:main Jan 5, 2024
3 checks passed
@grst
Copy link
Contributor

grst commented Jun 4, 2024

@mikelkou, has this one been announced yet?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants