Skip to main content
https://raw.githubusercontent.com/lycosystem/lymph/main/github-social-card.png https://img.shields.io/badge/license-MIT-blue.svg?style=flat https://img.shields.io/badge/GitHub-lycosystem%2Flymph-blue.svg?style=flat https://img.shields.io/badge/DOI-10.1038%2Fs41598--021--91544--1-success.svg?style=flat https://github.com/lycosystem/lymph/actions/workflows/tests.yml/badge.svg?style=flat https://github.com/lycosystem/lymph/actions/workflows/release.yml/badge.svg?style=flat https://codecov.io/gh/lycosystem/lymph/branch/main/graph/badge.svg?token=LPXQPK5K78 https://readthedocs.org/projects/lymph-model/badge

A Python package for statistical modelling of lymphatic metastatic spread in head & neck squamous cell carcinoma (HNSCC).

Motivation

HNSCC spreads though the lymphatic system of the neck and forms metastases in regional lymph nodes. Macroscopic metastases can be detected with imaging modalities like MRI, PET and CT scans. They are then consequently included in the target volume, when radiotherapy is chosen as part of the treatment. However, microscopic metastases are too small be diagnosed with current imaging techniques.

To account for this microscopic involvement, parts of the lymphatic system are often irradiated electively to increase tumor control. Which parts are included in this elective clinical target volume is currently decided based on guidelines [1] [2] [3] [4]. These in turn are derived from reports of the prevalence of involvement per lymph node level (LNL), i.e. the portion of patients that were diagnosed with metastases in any given LNL, stratified by primary tumor location. It is recommended to include a LNL in the elective target volume if 10 - 15% of patients showed involvement in that particular level.

However, while the prevalence of involvement has been reported in the literature [5] [6], and the general lymph drainage pathways are understood well, the detailed progression patterns of HNSCC remain poorly quantified. We believe that the risk for microscopic involvement in an LNL depends highly on the specific diagnosis of a particular patient and their treatment can hence be personalized if the progression patterns were better quantified.

Our Goal

With this Python package we want to provide a framework to accurately predict the risk for microscopic metastases in any lymph node level for the specific diagnosis a particular patient presents with.

The implemented model is highly interpretable and was developed together with clinicians to accurately represent the anatomy of the lymphatic drainage. It can be trained with data that reports the patterns of lymphatic progression in detail, like the dataset(s) we collected at our institution, the University Hospital Zurich (USZ).

The mathematical details of the models can be found in in our earlier publications [7] [8].

Get started

To learn how to use this package, head over to our documentation where we explain the API of the package and also provide a quickstart guide.

The implementation is pure-python and has only a few dependencies. However, it is intended to be used with powerful inference algorithms, e.g. the great sampling package emcee, which we used for our results.

Attribution

If you use this code in you work you may either attribute use by citing our paper [8] or by using the CITATION.cff file in this repository, which specifically cites the software.

See also

The dataset(s)

A large and detailed dataset containing the patterns of lymphatic progression of patients treated at the USZ are available in this repo on GitHub. We have also published a paper on the dataset and our interface (described below) in Radiotherapy & Oncology [9]. A preprint is available on medRxiv [10].

This data may be used to train the model.

LyProX interface

The above mentioned data can also be explored interactively using our online interface LyProX (GitHub repo).

References

Metadata

Release files for lymph-model 1.3.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for lymph-model 1.3.6
File Size Uploaded
lymph_model-1.3.6.tar.gz 313.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for lymph-model 1.3.6
File Interpreter ABI Platform
lymph_model-1.3.6-py3-none-any.whl Python 3 none any Details

Total release size: 377.7 kB

Release files / lymph_model-1.3.6.tar.gz

Download URL lymph_model-1.3.6.tar.gz
Size 313.4 kB
Tags Source
SHA-256 checksum
How to use checksums
104c8323fedb76cd023b06d0dfcba507f4a006cf545a2d7f50c009052c821033
BLAKE2b-256 checksum
How to use checksums
960660cafd45d7c4de4a7b168ddcbb9301711185e0bf9d77864399ef84ecbdcb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

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 Jun 30, 2025.

Transparency log

Release files / lymph_model-1.3.6-py3-none-any.whl

Download URL lymph_model-1.3.6-py3-none-any.whl
Size 64.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e302497d2c98812676467e36f43f728350582cadcde876e687d5fec53995be51
BLAKE2b-256 checksum
How to use checksums
e49435f07ff97c114dceaccce4a577227b08dd4e12a70e81e18db07e5add88dc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

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 Jun 30, 2025.

Transparency log
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page