Skip to main content

zea logo

zea

A Toolbox for Cognitive Ultrasound Imaging

PyPI version Python versions Tests Documentation Status Coverage License JOSS arXiv Hugging Face GitHub stars

Documentation · Getting Started · Examples · Models · Datasets

zea is a Python library for ultrasound signal processing, image reconstruction, and deep learning. It is built on Keras 3, so everything runs on JAX, PyTorch, or TensorFlow.

Animated tour of the zea modules: Pipeline, models, Parameters and Probe, and File, Dataset and Dataloader

Installation

pip install zea

Additionally, zea needs one of the Keras backends installed: JAX (recommended), PyTorch, or TensorFlow. See the installation guide for details regarding more advanced installation options, such as GPU support.

Quick start

zea offers many models and tooling for advanced ultrasound processing. But in the most basic sense it offers a fast and flexible ultrasound processing pipeline implemented in a deep learning framework for easy integration with state-of-the-art models. The following example streams an in-vivo recording from Hugging Face, beamforms it, and saves the B-mode image:

import zea

zea.init_device()

config = zea.Config.from_path("hf://zeahub/picmus/config_iq.yaml")
path = (
    "hf://zeahub/picmus/in_vivo/carotid_cross/"
    "carotid_cross_expe_dataset_iq/carotid_cross_expe_dataset_iq.hdf5"
)

with zea.File(path) as file:
    data = file.data.raw_data[0]
    parameters = file.load_parameters()

parameters.update(**config.parameters)

pipeline = zea.Pipeline.from_config(config, with_batch_dim=False)
inputs = pipeline.prepare_parameters(parameters)
image = pipeline(data=data, **inputs, return_numpy=True)["data"]

image = zea.display.to_8bit(image)
image.save("bmode.png")

The Getting Started guide walks through this example step by step, and the Examples page has many more notebooks you can open in Colab.

Core modules

🔧 Pipeline Flexible, differentiable signal processing and image reconstruction, written in your favorite deep learning framework.
💾 Data Loading tools for ultrasound data and acquisition parameters, designed for deep learning workflows. Datasets on Hugging Face are streamed, so only the frames you read are fetched.
🧠 Models Pretrained models for ultrasound image and signal processing, hosted on Hugging Face.
🎯 Agent Action selection for cognitive ultrasound, with flexible transmit and acquisition design: an action decides what to acquire next, such as which scan lines to fire.

Read the About page for the motivation behind zea and the research it supports.

Contributing

Questions and suggestions are welcome as an issue on GitHub. If you want to contribute, see the Contributing guide.

Citation

If zea helps your research, please cite our JOSS paper. More citation info is in the docs.

BibTeX
@article{stevens2026zea,
    author       = {Stevens, Tristan S.W. and van Nierop, Wessel L. and Luijten, Ben and van de Schaft, Vincent and Nolan, Oisín and Federici, Beatrice and van Harten, Louis D. and Penninga, Simon W. and Schueler, Noortje I.P. and van Sloun, Ruud J.G.},
    title        = {{zea}: A Toolbox for Cognitive Ultrasound Imaging},
    year         = 2026,
    journal      = {Journal of Open Source Software},
    publisher    = {The Open Journal},
    volume       = 11,
    number       = 121,
    pages        = 9881,
    doi          = {10.21105/joss.09881},
}

Metadata

Release files for zea 0.1.9

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

Source distribution (sdist)

Source distribution for zea 0.1.9
File Size Uploaded Provenance Actions
zea-0.1.9.tar.gz 761.3 kB With provenance Details for zea-0.1.9.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for zea 0.1.9
File Interpreter ABI Platform Actions
zea-0.1.9-py3-none-any.whl Python 3 none any Details for zea-0.1.9-py3-none-any.whl

Total release size: 1.6 MB

Release files / zea-0.1.9.tar.gz

Download URL zea-0.1.9.tar.gz
Size 761.3 kB
Tags Source
SHA-256 checksum
How to use checksums
95aae9c816740724f824ff09f591b5598d17f01084da2e9d76b534a009f8f8ee
BLAKE2b-256 checksum
How to use checksums
593be11a19ee3d07d2dca0f8888ee13a3b5c9d4fe5d947597bd2f9793ee72d6c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 Nov 10, 2026.

Transparency log

Release files / zea-0.1.9-py3-none-any.whl

Download URL zea-0.1.9-py3-none-any.whl
Size 833.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
06755c967c48ffcd6b6b8d99579bc42819267cca0afbc1499aba7e933f9dd1c5
BLAKE2b-256 checksum
How to use checksums
19165199b5fc0a02f352d2f928c2f0faaa51485bb0c8004486abc95dd068c703
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 Nov 10, 2026.

Transparency log

Security for zea 0.1.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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for zea-0.1.9.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 Nov 10, 2026.

Transparency log

A 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.

Release history Release notifications | RSS feed

This release

0.1.9 This release

2 release files Full provenance

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