Skip to main content

Methods, workflows, tutorials, and CLI for creating personalized physiological digital twins from 3D medical images

Project description

PhysioTwin4D

A collection of methods, workflows, tutorials, and CLI tools for creating personalized physiological digital twins.

PhysioTwin4D typically begins with a 3D medical image of a subject, extracts anatomic models from that image, and then uses AI surrogates to estimate the subject's physiological processes — initially focusing on cardiac and respiratory motion, and expanding to electrophysiology, blood flow, and organ perfusion. The package provides methods for forming these physiological AI surrogates and for fine-tuning the segmentation and registration AI methods that power them, with special emphasis on statistical shape models: they capture subject-specific characteristics that help determine subject-specific physiological function, and establish correspondence across subjects to aid AI surrogate generalization and simplify the application of traditional solvers.

Not validated for clinical use. PhysioTwin4D is a research toolkit. It is not a medical device and must not be used for diagnosis, treatment planning, or clinical decision-making.

Documentation

https://project-monai.github.io/physiotwin4d/ is the primary entry point for users and contributors. Key sections:

Highlights

  • Personalized digital twins: build subject-specific anatomic models and physiological AI surrogates from 3D/4D medical images
  • Statistical shape models: capture subject-specific anatomy and establish cross-subject correspondence, aiding AI surrogate generalization and simplifying traditional solver setup
  • Simplified workflows on industry-leading open-source tools: ICON and Greedy for registration; MONAI with TotalSegmentator and Simpleware for segmentation; Netgen for meshing (LGPL license); scikit-learn for statistical shape modeling; ITK for image processing; PyVista and OpenUSD/Omniverse for geometry manipulation; CuPy for accelerated computing; and PhysicsNeMo for AI surrogates
  • Extensible class hierarchy: add new segmentation and registration methods, and extend to new data types, organs, and physiological processes, without reworking the workflow layer
  • Physiological motion: cardiac and respiratory motion today, expanding to electrophysiology, blood flow, and organ perfusion
  • NVIDIA Omniverse as the simulation hub: the end goal for simulation — a simulation-information hub and gateway to other engines (e.g., Ansys solvers), interactive simulations for treatment planning (e.g., Isaac Sim, Newton), visualization systems (e.g., AR/VR devices), and physical systems (e.g., robots via ROS)
  • CLI and Python API: installed command-line tools and workflow classes for repeatable, scriptable pipelines

Installation

# CPU-only — works out of the box; a runtime warning points to the GPU extra
pip install physiotwin4d

# CUDA 13 (recommended for production)
uv pip install "physiotwin4d[cuda13]"

See the installation guide for GPU setup, source installs, and optional extras (PhysicsNeMo).

Quick Start

physiotwin4d-convert-image-to-usd cardiac_4d.nrrd --contrast --output-dir ./results
from physiotwin4d import RegisterImagesICON, WorkflowConvertImageToUSD

processor = WorkflowConvertImageToUSD(
    input_filenames=["path/to/cardiac_4d_ct.nrrd"],
    output_directory="./results",
    project_name="cardiac_model",
    registration_method=RegisterImagesICON(),  # or RegisterImagesGreedy()
)
final_usd = processor.process()

See the quickstart and tutorials for full walkthroughs covering segmentation, registration, statistical shape modeling, and USD export.

Contributing

See the contributing guide for code style, testing, IDE setup, and pull request conventions.

License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details.

Note that some optional dependencies carry their own license terms: meshing via Netgen is LGPL-licensed, and NVIDIA Omniverse is distributed under its own customer license, which is free for academic and commercial use. To our knowledge, none of the dependencies carry commercially prohibitive licenses such as GPL, but no guarantees are provided — review the license of each dependency for your own use case.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

physiotwin4d-2026.7.2.tar.gz (216.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

physiotwin4d-2026.7.2-py3-none-any.whl (246.4 kB view details)

Uploaded Python 3

File details

Details for the file physiotwin4d-2026.7.2.tar.gz.

File metadata

  • Download URL: physiotwin4d-2026.7.2.tar.gz
  • Upload date:
  • Size: 216.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for physiotwin4d-2026.7.2.tar.gz
Algorithm Hash digest
SHA256 b63280952cbad32aff621fed36a506e0248724b6e7c69bf7b9a64dc69876390b
MD5 33ef617c164e00c7d754fca2f845456a
BLAKE2b-256 4f75e709bd6bc16dd69dd023bdfc01a4d62bdc95737b0f45f46c14dabf2a7322

See more details on using hashes here.

Provenance

The following attestation bundles were made for physiotwin4d-2026.7.2.tar.gz:

Publisher: release.yml on Project-MONAI/physiotwin4d

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file physiotwin4d-2026.7.2-py3-none-any.whl.

File metadata

  • Download URL: physiotwin4d-2026.7.2-py3-none-any.whl
  • Upload date:
  • Size: 246.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for physiotwin4d-2026.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0915a5d7c902d3fc500c75bbc4c797670cba6034bd3579fb85153ef6692f9c9f
MD5 fe7cba4335a7a7d69c32075a78760f48
BLAKE2b-256 fd0b1dce33528448deab0cacb9cded5be8b81a01bd453f283ac3c1e9e162cab1

See more details on using hashes here.

Provenance

The following attestation bundles were made for physiotwin4d-2026.7.2-py3-none-any.whl:

Publisher: release.yml on Project-MONAI/physiotwin4d

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page