Metadata-Version: 2.4
Name: cardiac-geometriesx
Version: 0.5.4
Summary: A python library for cardiac geometries
Author-email: Henrik Finsberg <henriknf@simula.no>
License: MIT
Project-URL: Homepage, https://github.com/finsberg/cardiac-geometriesx
Keywords: cardiac,geometry
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: fenics-dolfinx>=0.8.0
Requires-Dist: structlog
Requires-Dist: cardiac-geometries-core
Requires-Dist: rich-click
Requires-Dist: adios4dolfinx
Requires-Dist: scifem
Provides-Extra: dev
Requires-Dist: bump-my-version; extra == "dev"
Requires-Dist: ipython; extra == "dev"
Requires-Dist: pdbpp; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: wheel; extra == "dev"
Provides-Extra: docs
Requires-Dist: jupyter-book; extra == "docs"
Requires-Dist: jupytext; extra == "docs"
Requires-Dist: jupyter; extra == "docs"
Requires-Dist: pyvista[all]>=0.43.0; extra == "docs"
Requires-Dist: trame-vuetify; extra == "docs"
Requires-Dist: ipywidgets; extra == "docs"
Requires-Dist: fenicsx-ldrb; extra == "docs"
Requires-Dist: ukb-atlas; extra == "docs"
Provides-Extra: test
Requires-Dist: pre-commit; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: ukb-atlas[pyvista]; extra == "test"
Requires-Dist: fenicsx-ldrb; extra == "test"
Provides-Extra: gui
Requires-Dist: streamlit; extra == "gui"
Requires-Dist: stpyvista; extra == "gui"
Requires-Dist: pyvista[all]>=0.43.0; extra == "gui"
Requires-Dist: trame-vuetify; extra == "gui"
Requires-Dist: ipywidgets; extra == "gui"
Requires-Dist: fenicsx-ldrb; extra == "gui"
Dynamic: license-file

![_](docs/_static/logo.png)

[![Create and publish a Docker image](https://github.com/ComputationalPhysiology/cardiac-geometriesx/actions/workflows/docker-image.yml/badge.svg)](https://github.com/ComputationalPhysiology/cardiac-geometriesx/actions/workflows/docker-image.yml)
[![Test package](https://github.com/ComputationalPhysiology/cardiac-geometriesx/actions/workflows/test.yml/badge.svg)](https://github.com/ComputationalPhysiology/cardiac-geometriesx/actions/workflows/test.yml)
[![Test package MPI](https://github.com/ComputationalPhysiology/cardiac-geometriesx/actions/workflows/test-mpi.yml/badge.svg)](https://github.com/ComputationalPhysiology/cardiac-geometriesx/actions/workflows/test-mpi.yml)
[![Pre-commit](https://github.com/ComputationalPhysiology/cardiac-geometriesx/actions/workflows/pre-commit.yml/badge.svg)](https://github.com/ComputationalPhysiology/cardiac-geometriesx/actions/workflows/pre-commit.yml)
[![PyPI version](https://badge.fury.io/py/cardiac-geometriesx.svg)](https://badge.fury.io/py/cardiac-geometriesx)

# Cardiac geometries

Cardiac geometries is a software package built on top of [`cariac-geometries-core`](https://github.com/ComputationalPhysiology/cardiac-geometries-core) that adds support for creating idealized cardiac geometries for dolfinx.

There are two ways you can use `cardiac-geomtries`, either using the command line interface, e.g
```
geox lv-ellipsoid --create-fibers lv-mesh --fiber-space P_2
```

or using the python API e.g
```python
geo =  cardiac_geometries.mesh.lv_ellipsoid(outdir="lv-mesh", create_fibers=True, fiber_space="P_2")
```

## Install

To install the package you can use `pip`
```
python3 -m pip install cardiac-geometriesx
```
however, this assumes that you already have `dolfinx` pre-installed. You can also use `conda`
```
conda install -c conda-forge cardiac-geometriesx
```
or the provided docker image
```
docker pull ghcr.io/computationalphysiology/cardiac-geometriesx:latest
```
To start a new container interactive you can do
```
docker run --name geox -v $PWD:/home/shared -w /home/shared -it ghcr.io/computationalphysiology/cardiac-geometriesx:latest
```
or if you just want to create a mesh and exit you can run the command line interface directly e.g
```
docker run --rm -v $PWD:/home/shared -w /home/shared -it ghcr.io/computationalphysiology/cardiac-geometriesx:latest geox lv-ellipsoid --create-fibers lv-mesh --fiber-space P_2
```

## Authors
Henrik Finsberg (henriknf@simula.no)

## License
MIT

## Contributing
