Introduction
histolytics is a spatial analysis library for histological whole slide images (WSI). Built upon torch, geopandas and libpysal, the library provides a comprehensive and scalable framework for panoptic segmentation and interpretable panoptic spatial analysis of routine histopathology slides.
Panoptic Segmentation Features
- Fast WSI-level panoptic segmentation. See example.
- Low memory-footprint segmentation results with
__geo_interface__-specification. - Multiple vectorized segmentation output formats (geojson/feather/parquet).
- Several panoptic segmentation model architectures for histological WSIs with flexible backbone support: See example
- Pre-trained models in model-hub. See: histolytics-hub
Spatial Analysis Features
- Fast Spatial Querying of WSI-scale panoptic segmentation maps. See example
- Spatial indexing/partitioning for localized spatial statistics and analysis. See example
- Graph-based neighborhood analysis for local cell neighborhoods. See example
- Plotting utilities for spatial data visualization. See example
- Spatial clustering and cluster centrography metrics. See example
- Large set of morphological, intensity, chromatin distribution, and textural features at nuclear level. See example
- Large set of collagen fiber and intensity based features to characterize stroma and ECM. See example
Example Workflows
- Immuno-oncology Profiling:
- Nuclear Pleomorphism:
- TME Characterization:
- Nuclei Neighborhoods:
Installation
pip install 'histolytics[all]' # Recommended full installation (Linux)
pip install histolytics # CPU spatial/image analysis
pip install 'histolytics[segmentation]' # Models and segmentation workflows
pip install 'histolytics[cucim]' # Retained cuCIM WSI backend (Linux)
pip install 'histolytics[cuda-analysis]' # Existing CUDA analysis (Linux)
These groups apply to Histolytics 0.3.0 and later. Histolytics 0.2.5 retains
its previous installation requirements. Existing model users must select
segmentation or all; to retain all prior capabilities on Linux, install
histolytics[all]. See the
installation guide for
source installation, reader prerequisites, and CPU Torch setup.
Models
- Panoptic HoVer-Net
- Panoptic Cellpose
- Panoptic Stardist
- Panoptic CellVit-SAM
- Panoptic CPP-Net
Contributing
We welcome contributions! To get started:
- Fork the repository and create your branch from
main. - Make your changes with clear commit messages.
- Ensure all tests pass and add new tests as needed.
- Submit a pull request describing your changes.
See contributing guide for detailed guidelines.
Citation
If you use histolytics in your research, please cite:
Lehtonen, O., Nordlund, N., Salloum, S., Kalliala, I., Virtanen, A., & Hautaniemi, S. (2025). Histolytics: A panoptic spatial analysis framework for interpretable histopathology. Computational and Structural Biotechnology Journal, 27, 5135–5147. https://doi.org/10.1016/j.csbj.2025.11.022
@article{2025histolytics,
title={{Histolytics}: A panoptic spatial analysis framework for interpretable histopathology},
author={Lehtonen, Oskari and Nordlund, Niko and Salloum, Shams and Kalliala, Ilkka and Virtanen, Anni and Hautaniemi, Sampsa},
journal={Computational and Structural Biotechnology Journal},
volume={27},
pages={5135--5147},
year={2025},
doi={10.1016/j.csbj.2025.11.022},
url={https://doi.org/10.1016/j.csbj.2025.11.022},
publisher={Elsevier}
}
Metadata
Release files for histolytics 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| histolytics-0.3.0.tar.gz | 39.0 MB | With provenance | Details for histolytics-0.3.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| histolytics-0.3.0-py3-none-any.whl | Python 3 | none | any | Details for histolytics-0.3.0-py3-none-any.whl |
Total release size: 77.7 MB
Release files / histolytics-0.3.0.tar.gz
| Download URL | histolytics-0.3.0.tar.gz |
|---|---|
| Size | 39.0 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bd19085dd749c24f6f68732ab6816ef5cdd7ec4c768b90bfe7468d1a09e1c145
|
|
BLAKE2b-256 checksum How to use checksums |
16a9f03ae5ed531827431da98b7bdfaa18e2a5e8749388ed380fddc15ddcc062
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 19, 2026.
Transparency logRelease files / histolytics-0.3.0-py3-none-any.whl
| Download URL | histolytics-0.3.0-py3-none-any.whl |
|---|---|
| Size | 38.7 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
de2ad5cf6a24f95637b19030c202c4969dc966e851f510418746a5b86b653137
|
|
BLAKE2b-256 checksum How to use checksums |
56b576df295ada72a7fd0ced69e7edd1d573d6d0a18b37fd5b9d049bfd612ddd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 19, 2026.
Transparency logSecurity for histolytics 0.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for histolytics-0.3.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 19, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.