cardiac-geometriesx 0.5.3

A python library for cardiac geometries

Cardiac geometries

Cardiac geometries is a software package built on top of cariac-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

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 ([e-mail])

License

MIT

Contributing