Metadata-Version: 2.4
Name: gd-ellipsoid
Version: 0.0.post13
Requires-Python: ==3.12.*
Description-Content-Type: text/markdown
Requires-Dist: gd-py-utils
Requires-Dist: gd-mesh-utils
Requires-Dist: fractal-tree
Requires-Dist: scikit-fem
Requires-Dist: cyclopts
Provides-Extra: docs
Requires-Dist: mkdocs; extra == "docs"
Requires-Dist: mkdocs-material; extra == "docs"
Requires-Dist: mkdocs-mermaid2-plugin; extra == "docs"
Requires-Dist: mkdocs-snippets; extra == "docs"
Requires-Dist: mkdocs-exclude; extra == "docs"
Requires-Dist: mkdocstrings-python; extra == "docs"

# [**gdellipsoid**](https://gd-ellipsoid-42bbb6.gitlabpages.inria.fr/)

Build an ellipsoidal cardiac geometry: tetrahedral mesh, endo/epicardial surfaces, transmural fibers, and a Purkinje network.

![overview](overview.png)

## Install

```bash
pip install gd-ellipsoid
```

## CLI / uvx

Run the whole pipeline or any single step without installing, straight from `uvx`:

```bash
# Full pipeline (generate -> fibers -> purkinje -> plot) into ./out
uvx --from gd-ellipsoid gdellipsoid all --out ./out

# Individual steps
uvx --from gd-ellipsoid gdellipsoid generate --out ./out --h 2.0
uvx --from gd-ellipsoid gdellipsoid fibers   --out ./out --endo-angle 80 --epi-angle -80
uvx --from gd-ellipsoid gdellipsoid purkinje --out ./out
uvx --from gd-ellipsoid gdellipsoid plot     --out ./out
```

Running `gdellipsoid` with no subcommand is equivalent to `gdellipsoid all`.
The output directory defaults to `./out` and is created on demand. See
`gdellipsoid --help` for all commands and options.

## Docs

See [docs]([docs/index.md](https://gd-ellipsoid-42bbb6.gitlabpages.inria.fr/)) for the API and more details.
