Harreman
Harreman is an algorithm and open-source software for inference of metabolic exchanges in tissues using spatial transcriptomics. Harreman employs a series of spatial correlation statistics to enable multiscale insight: from stratification of tissues into regions with different metabolic characteristics, to inference of which metabolites are exchanged within each region, and to identification of the specific subsets of cells that are exchanging these metabolites (through import and export reactions).
Resources
- Tutorials, user guide, API reference, installation guide, and release notes are available in the Documentation.
Installation
We suggest using a package manager like conda or mamba to install the package.
conda create -n harreman-env python=3.12
conda activate harreman-env
pip install harreman
Tutorials
- For tutorials on how to run the PyTorch version of Hotspot with Harreman, visit the Hotspot tutorials.
- To get familiar with the Harreman pipeline on the case studies used in the manuscript, visit the Harreman tutorials.
Test statistics
All test statistics available in the Harreman pipeline are described in the User guide. Currently implemented test statistics are:
- Test statistic 1: Is gene a spatially autocorrelated?
- Test statistic 2: Are genes a and b spatially co-localized (or interacting with each other)?
- Test statistic 3: Is metabolite m spatially autocorrelated?
- Test statistic 4: Are metabolites $m_1$ and $m_2$ spatially co-localized?
- Test statistic 5: Do genes a and b interact when expressed by cell types t and u, respectively?
- Test statistic 6: Is metabolite m exchanged by cell types t and u?
- Test statistic 7: Do genes a and b interact when a is expressed by cell i and b by spatially nearby cells?
- Test statistic 8: Is metabolite m exchanged by cell i and other spatially proximal cells?
- Test statistic 9: Do genes a and b interact when a is expressed by cell i (that belongs to cell type t) and b by spatially nearby cells (that belong to cell type u)?
- Test statistic 10: Is metabolite m exchanged by cell i (that belongs to cell type t) and other spatially proximal cells (that belong to cell type u)?
Reference
- Metabolic zonation and characterization of tissue slices with spatial transcriptomics. bioRxiv, 2025. https://doi.org/10.1101/2025.11.11.687271
Metadata
Release files for harreman 0.1.4
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 | |
|---|---|---|---|---|
| harreman-0.1.4.tar.gz | 509.2 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| harreman-0.1.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.1 MB
Release files / harreman-0.1.4.tar.gz
| Download URL | harreman-0.1.4.tar.gz |
|---|---|
| Size | 509.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
12f42bd4252327312bd4f804ed5bd10232f65dd64984f274ac082484c505eabf
|
|
BLAKE2b-256 checksum How to use checksums |
a51ba18c24682b6b91b5cb9a8d92cfc79c4448bc24f47b50e1986a19bd8d8745
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
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 May 11, 2026.
Transparency logRelease files / harreman-0.1.4-py3-none-any.whl
| Download URL | harreman-0.1.4-py3-none-any.whl |
|---|---|
| Size | 540.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
59666873e7e1c52a4b7317e1f652d98abeda87c26eb19d845ef230e146811102
|
|
BLAKE2b-256 checksum How to use checksums |
720e88410736122173e71bac938a5717922bf5a1656858a1e45f49d2292f834b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
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 May 11, 2026.
Transparency logSecurity for harreman 0.1.4
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 harreman-0.1.4.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 May 11, 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.