Metadata-Version: 2.4
Name: zea
Version: 0.1.0
Summary: A Toolbox for Cognitive Ultrasound Imaging. Provides a set of tools for processing of ultrasound data, all built in your favorite machine learning framework.
Project-URL: Homepage, https://github.com/tue-bmd/zea/
Project-URL: Repository, https://github.com/tue-bmd/zea/
Author-email: Tristan Stevens <t.s.w.stevens@tue.nl>, Wessel van Nierop <w.l.v.nierop@tue.nl>, Ben Luijten <w.m.b.luijten@tue.nl>, Vincent van de Schaft <v.v.d.schaft@tue.nl>, Oisín Nolan <o.i.nolan@tue.nl>, Beatrice Federici <b.federici@tue.nl>, Louis van Harten <l.d.v.harten@tue.nl>, Simon Penninga <s.w.penninga@tue.nl>, Noortje Schueler <n.i.p.schueler@tue.nl>, Ruud van Sloun <r.j.g.v.sloun@tue.nl>
License-File: LICENSE
Keywords: beamforming,machine learning,ultrasound
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Requires-Dist: decorator>=5
Requires-Dist: grain>=0.2.8
Requires-Dist: h5py>=3.11
Requires-Dist: huggingface-hub>=1.2
Requires-Dist: imageio[ffmpeg]>=2.0
Requires-Dist: keras>=3.12.1
Requires-Dist: matplotlib>=3.10
Requires-Dist: numpy>=1.24
Requires-Dist: pillow>=12.2.0
Requires-Dist: protobuf<6.0.0,>=3.20
Requires-Dist: pyyaml>=6
Requires-Dist: scikit-image>=0.23
Requires-Dist: scikit-learn>=1.4
Requires-Dist: scipy>=1.13
Requires-Dist: tqdm>=4
Requires-Dist: tyro>=0.9
Requires-Dist: wandb>=0.18
Requires-Dist: wget>=3.2
Provides-Extra: app
Requires-Dist: gradio>=6.0; extra == 'app'
Provides-Extra: backends
Requires-Dist: jax>=0.4.35; extra == 'backends'
Requires-Dist: tensorflow>=2.12.1; extra == 'backends'
Requires-Dist: torch>=2.2; extra == 'backends'
Provides-Extra: dev
Requires-Dist: cloudpickle>=3.1.1; extra == 'dev'
Requires-Dist: furo; extra == 'dev'
Requires-Dist: gradio>=6.0; extra == 'dev'
Requires-Dist: ipykernel>=6.29.5; extra == 'dev'
Requires-Dist: ipython; extra == 'dev'
Requires-Dist: ipywidgets; extra == 'dev'
Requires-Dist: myst-parser; extra == 'dev'
Requires-Dist: nbsphinx; extra == 'dev'
Requires-Dist: onnxruntime>=1.15; extra == 'dev'
Requires-Dist: opencv-python-headless>=4; extra == 'dev'
Requires-Dist: papermill>=2.4; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: pybtex>=0.26.1; extra == 'dev'
Requires-Dist: pystemmer; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: pytest>=9.0.3; extra == 'dev'
Requires-Dist: ruff==0.15.16; extra == 'dev'
Requires-Dist: simpleitk>=2.2.1; extra == 'dev'
Requires-Dist: sphinx; extra == 'dev'
Requires-Dist: sphinx-autobuild; extra == 'dev'
Requires-Dist: sphinx-autodoc-typehints; extra == 'dev'
Requires-Dist: sphinx-copybutton; extra == 'dev'
Requires-Dist: sphinx-design; extra == 'dev'
Requires-Dist: sphinx-reredirects; extra == 'dev'
Requires-Dist: sphinxcontrib-autoprogram; extra == 'dev'
Requires-Dist: sphinxcontrib-bibtex>=2.6.5; extra == 'dev'
Requires-Dist: ty==0.0.49; extra == 'dev'
Provides-Extra: display
Requires-Dist: opencv-python>=4; extra == 'display'
Provides-Extra: display-headless
Requires-Dist: opencv-python-headless>=4; extra == 'display-headless'
Provides-Extra: docs
Requires-Dist: furo; extra == 'docs'
Requires-Dist: ipython; extra == 'docs'
Requires-Dist: myst-parser; extra == 'docs'
Requires-Dist: nbsphinx; extra == 'docs'
Requires-Dist: pybtex>=0.26.1; extra == 'docs'
Requires-Dist: pystemmer; extra == 'docs'
Requires-Dist: sphinx; extra == 'docs'
Requires-Dist: sphinx-autobuild; extra == 'docs'
Requires-Dist: sphinx-autodoc-typehints; extra == 'docs'
Requires-Dist: sphinx-copybutton; extra == 'docs'
Requires-Dist: sphinx-design; extra == 'docs'
Requires-Dist: sphinx-reredirects; extra == 'docs'
Requires-Dist: sphinxcontrib-autoprogram; extra == 'docs'
Requires-Dist: sphinxcontrib-bibtex>=2.6.5; extra == 'docs'
Provides-Extra: jax
Requires-Dist: jax[cuda12]>=0.4.35; extra == 'jax'
Provides-Extra: models
Requires-Dist: onnxruntime>=1.15; extra == 'models'
Provides-Extra: tests
Requires-Dist: cloudpickle>=3.1.1; extra == 'tests'
Requires-Dist: gradio>=6.0; extra == 'tests'
Requires-Dist: ipykernel>=6.29.5; extra == 'tests'
Requires-Dist: ipywidgets; extra == 'tests'
Requires-Dist: papermill>=2.4; extra == 'tests'
Requires-Dist: pre-commit; extra == 'tests'
Requires-Dist: pytest-cov; extra == 'tests'
Requires-Dist: pytest>=9.0.3; extra == 'tests'
Requires-Dist: ruff==0.15.16; extra == 'tests'
Requires-Dist: simpleitk>=2.2.1; extra == 'tests'
Requires-Dist: ty==0.0.49; extra == 'tests'
Description-Content-Type: text/markdown

# zea <img src="https://raw.githubusercontent.com/tue-bmd/zea/main/docs/_static/zea-logo.png" width="120" height="120" align="right" alt="zea Logo" />


[![PyPI version](https://img.shields.io/pypi/v/zea)](https://pypi.org/project/zea/)
[![Continuous integration](https://github.com/tue-bmd/zea/actions/workflows/tests.yaml/badge.svg)](https://github.com/tue-bmd/zea/actions/workflows/tests.yaml)
[![Documentation Status](https://readthedocs.org/projects/zea/badge/?version=latest)](https://zea.readthedocs.io/en/latest/?badge=latest)
[![License](https://img.shields.io/github/license/tue-bmd/zea)](https://github.com/tue-bmd/zea/blob/main/LICENSE)
[![codecov](https://codecov.io/gh/tue-bmd/zea/branch/main/graph/badge.svg)](https://codecov.io/gh/tue-bmd/zea)
[![status](https://joss.theoj.org/papers/fa923917ca41761fe0623ca6c350017d/status.svg)](https://joss.theoj.org/papers/fa923917ca41761fe0623ca6c350017d)
[![arXiv](https://img.shields.io/badge/arXiv-B31B1B?style=flat&logo=arXiv&logoColor=white)](https://arxiv.org/abs/2512.01433)
[![Hugging Face](https://img.shields.io/badge/Hugging%20Face-FFD21E?logo=huggingface&logoColor=black)](https://huggingface.co/zeahub)
[![GitHub stars](https://img.shields.io/github/stars/tue-bmd/zea?style=social)](https://github.com/tue-bmd/zea/stargazers)

Welcome to the `zea` package: *A Toolbox for Cognitive Ultrasound Imaging.*

- 📚 Full documentation: [zea.readthedocs.io](https://zea.readthedocs.io)
- 🔬 Try hands-on examples (with Colab): [Examples & Tutorials](https://zea.readthedocs.io/en/latest/examples.html)
- ⚙️ Installation guide: [Installation](https://zea.readthedocs.io/en/latest/installation.html)

`zea` is a Python library that offers ultrasound signal processing, image reconstruction, and deep learning. Currently, `zea` offers:

- A flexible ultrasound signal processing and image reconstruction [Pipeline](https://zea.readthedocs.io/en/latest/pipeline.html) written in your favorite deep learning framework.
- A complete set of [Data](https://zea.readthedocs.io/en/latest/data-acquisition.html) loading tools for ultrasound data and acquisition parameters, designed for deep learning workflows.
- A collection of pretrained [Models](https://zea.readthedocs.io/en/latest/models.html) for ultrasound image and signal processing.
- A set of action selection functions for cognitive ultrasound in the [Agent](https://zea.readthedocs.io/en/latest/agent.html) module.
- **Multi-Backend Support via [Keras3](https://keras.io/keras_3/):** You can use [PyTorch](https://github.com/pytorch/pytorch), [TensorFlow](https://github.com/tensorflow/tensorflow), or [JAX](https://github.com/google/jax).

Check out the [About](https://zea.readthedocs.io/en/latest/about.html) page for more information and the motivation behind `zea`. For any questions or suggestions, please feel free to open an [issue on GitHub](https://github.com/tue-bmd/zea/issues). If you want to contribute, check out the [Contributing](https://zea.readthedocs.io/en/latest/contributing.html) guide.

> [!WARNING]
> **Beta!**
> This package is under active development. It is mainly used to support [our research](https://zea.readthedocs.io/en/latest/about.html#papers). That being said, we are happy to share it with the ultrasound community and hope it will be useful for your research as well.

> [!NOTE]
> 📖 Please cite `zea` in your publications if it helps your research. You can find citation info [here](https://zea.readthedocs.io/en/latest/getting-started.html#citation).
