diff --git a/DISCOVERY.md b/DISCOVERY.md index 308ccff..be65f76 100644 --- a/DISCOVERY.md +++ b/DISCOVERY.md @@ -6,7 +6,8 @@ - **Description**: Spatial transcript purification for contamination-aware spatial transcriptomics workflows - **License**: GPL-3 - **Repository**: https://github.com/bdsc-tds/SPLIT - +- **Upstream citation**: Bilous et al., *Nature Methods* (2026), https://doi.org/10.1038/s41592-026-03089-8 + ## Existing py- Mirror Check - **py-SPLIT exists in omicverse?**: No - this is a new port. diff --git a/README.md b/README.md index 0a9e411..b23d540 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ # SPLIT-ST -A **pure-Python re-implementation of SPLIT** for spatial transcriptomics purification. +A **pure-Python re-implementation of [SPLIT](https://github.com/bdsc-tds/SPLIT)** for spatial transcriptomics purification. - AnnData-native — works directly with cell x gene spatial matrices - No `rpy2`, no R install, no RCTD/Seurat object dependency @@ -235,8 +235,16 @@ from splitst import ( ## Citation -If you use this package, please cite the original SPLIT work and acknowledge this repository for the Python port. +This package is a Python re-implementation of the original SPLIT method. If you use this package, please cite the original SPLIT publication: + +Bilous, M., Buszta, D., Bac, J., Kang, S., Dong, Y., Tissot, S., Andre, S., Alexandre-Gaveta, M., Voize, C., Peters, S., Homicsko, K. & Gottardo, R. +**Resolving sensitivity, specificity and signal contamination in Xenium spatial transcriptomics.** +*Nature Methods* (2026). https://doi.org/10.1038/s41592-026-03089-8 + +Original SPLIT R package: https://github.com/bdsc-tds/SPLIT + +Please also acknowledge this repository when using the Python port. ## License -GNU GPLv3 — matching the upstream SPLIT license. +GNU GPLv3 — matching the upstream [SPLIT](https://github.com/bdsc-tds/SPLIT) license. diff --git a/examples/split_workflow.ipynb b/examples/split_workflow.ipynb index d9c602f..23f9fcd 100644 --- a/examples/split_workflow.ipynb +++ b/examples/split_workflow.ipynb @@ -8,6 +8,10 @@ "# SPLIT-ST workflow\n", "\n", "This notebook runs the standalone Python SPLIT workflow on a deterministic AnnData fixture." + + Please cite: Bilous et al., **Resolving sensitivity, specificity and signal contamination in Xenium spatial transcriptomics**, *Nature Methods* (2026), https://doi.org/10.1038/s41592-026-03089-8. + + Original SPLIT R package: https://github.com/bdsc-tds/SPLIT ] }, { diff --git a/pyproject.toml b/pyproject.toml index cf8cbac..f570add 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -43,6 +43,8 @@ dev = [ Homepage = "https://github.com/omicverse/py-SPLIT" Repository = "https://github.com/omicverse/py-SPLIT" Issues = "https://github.com/omicverse/py-SPLIT/issues" +Upstream = "https://github.com/bdsc-tds/SPLIT" +Paper = "https://doi.org/10.1038/s41592-026-03089-8" [tool.setuptools.packages.find] include = ["splitst*"]