Metadata-Version: 2.4
Name: myocardial-mesh
Version: 0.1.1
Summary: Ventricular myocardial mesh construction for ECG and FIM simulation
Author-email: Ricardo García Ramírez <rgr.5882@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/ricardogr07/purkinje-learning-myocardial-mesh
Project-URL: Repository, https://github.com/ricardogr07/purkinje-learning-myocardial-mesh
Keywords: mesh,myocardial,ECG,FIM,vtk,pyvista,simulation,biomedical
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: vtk
Requires-Dist: pyvista
Requires-Dist: meshio
Requires-Dist: fim-python
Dynamic: license-file

# purkinje-learning-myocardial-mesh

A Python library for modeling, manipulating, and analyzing Purkinje fiber networks embedded in myocardial meshes — useful in computational cardiology, electrophysiology modeling, and bioengineering research.

---

## Features

- Parse and manipulate myocardial mesh data  
- Integrate Purkinje network geometries  
- Designed for computational simulation environments  
- Structured for maintainability and versioned releases  
- Automated testing with `pytest` and CI-friendly config  

---

## Installation

```bash
pip install myocardial-mesh
```

For development:

```bash
pip install -e ".[dev]"
```

Dependencies and development requirements are managed via `pyproject.toml`.

---

## Usage

Here’s a basic example (assumes functional API in `myocardial_mesh` or similar module):

```python
from myocardial_mesh import load_mesh, attach_purkinje_network

mesh = load_mesh("data/mesh.vtk")
network = attach_purkinje_network(mesh)
network.simulate()
```

---

## Versioning & Release

This project uses `release-please` to automate versioning and changelog generation.  
Follow [Conventional Commits](https://www.conventionalcommits.org/) to trigger releases.

Example commit:

```csharp
feat: add new Purkinje-mesh attachment algorithm
```

---

## License

This project is licensed under the terms of the MIT license.
