Welcome to the purkinje-uv documentation!

Contents:

• Welcome
• Architecture
  • Class diagram
  • Relationships (at a glance)
  • Workflow overview
  • Object lifecycle (short)
  • Assumptions & invariants
  • API reference
• Theory & Algorithms
  • 2D Fundamentals
  • Projection to the Heart Surface
• Usage
  • Quickstart
  • Backend selection (CPU/GPU)
  • Workflow
• Anatomical Seeding
  • Goal
  • Interfaces
  • Common strategies
  • Mapping to parameters
  • Example
  • Validation checklist
• Developer Notes
  • Data Model Invariants
  • Performance
  • Reproducibility
• References
• purkinje_uv
  • purkinje_uv package

Examples

• Examples

Introduction

purkinje-uv is a Python library for generating Purkinje networks using fractal trees mapped onto cardiac mesh surfaces. It includes geometric tools, network generation logic, and activation solvers.

Mermaid Example

        graph TD
    Start --> Mesh[Create Mesh]
    Mesh --> Tree[Generate FractalTree]
    Tree --> Network[Build PurkinjeTree]
    Network --> Sim[Run Activation Solver]