Skip to content

Conversation

psl-schaefer
Copy link
Contributor

Mandatory

Name of the tool: ParTIpy (partipy)

Short description: Implements Pareto task inference and archetypal analysis for analyzing functional trade-offs in single-cell and spatial omics data.

How does the package use scverse data structures (please describe in a few sentences): Uses anndata as primary data structure.

  • 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)
  • Automated tests cover essential functions of the package and a reasonable range of inputs and conditions 1
  • Continuous integration (CI) automatically executes these tests on each push or pull request 2
  • The package provides API documentation via a website or README3
  • 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)

  • Please tag the author(s) these announcements. Handles (e.g. @scverse_team) to include are:

    • Zulip: Philipp (937099)
    • Discourse:
    • Mastodon:
    • Bluesky: psl-schaefer
    • Twitter: psl_schaefer
  • The package provides tutorials (or "vignettes") that help getting users started quickly

  • The package uses the scverse cookiecutter template.

Footnotes

  1. We recommend thtat tests cover at least all user facing (public) functions. Minimal tests ensure that the function does not fail on an example data set. Ideally, tests also ensure the correctness of the results, e.g. by comparing against a snapshot.

  2. Continuous integration means that software tests are automatically executed on every push to the git repository. This guarantees they are always run and that they are run in a clean environment. Scverse ecosystem packages most commonly use GitHub Actions for CI. For an example, check out our cookiecutter template.

  3. By API documentation, we mean an overview of all public functions provided a package, with documentation of their parameters. For an example, see the Scanpy documentation. In simple cases, this can be done manually in a README file. For anything more complex, we recommend the Sphinx Autodoc plugin

Copy link
Collaborator

@mikkelnrasmussen mikkelnrasmussen left a comment

Choose a reason for hiding this comment

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

Hi @psl-schaefer,

Thanks for submitting this awesome package! Everything looks good to me - great API documentation, great tutorials, great test coverage!

Best,
Mikkel

@mikkelnrasmussen mikkelnrasmussen merged commit 737908c into scverse:main Aug 7, 2025
3 checks passed
@psl-schaefer
Copy link
Contributor Author

Thanks a lot @mikkelnrasmussen!

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