Metadata-Version: 2.1
Name: cardiac_geometries
Version: 1.1.2
Summary: A python library for cardiac geometries
Author-email: Henrik Finsberg <henriknf@simula.no>
License: MIT
Project-URL: Homepage, https://github.com/ComputationalPhysiology/cardiac_geometries
Keywords: cardiac,geometry,mesh,gmsh
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: cardiac-geometries-core >=0.2.1
Requires-Dist: meshio
Requires-Dist: numpy
Requires-Dist: rich-click
Provides-Extra: dev
Requires-Dist: bump2version ; extra == 'dev'
Requires-Dist: ipython ; extra == 'dev'
Requires-Dist: pdbpp ; extra == 'dev'
Requires-Dist: pre-commit ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: jupyter-book ; extra == 'docs'
Requires-Dist: jupytext ; extra == 'docs'
Requires-Dist: sphinxcontrib-bibtex ; extra == 'docs'
Provides-Extra: gmsh
Requires-Dist: gmsh ; extra == 'gmsh'
Provides-Extra: ldrb
Requires-Dist: ldrb ; extra == 'ldrb'
Provides-Extra: pypi
Requires-Dist: build ; extra == 'pypi'
Provides-Extra: test
Requires-Dist: ldrb ; extra == 'test'
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Provides-Extra: viz
Requires-Dist: h5py ; extra == 'viz'

# Cardiac Geometries

This is a library for creating idealized cardiac geometries in FEniCS using `gmsh`.
Currently you can create bi-ventricular (BiV) and left-ventricular (LV) ellipsoidal geometries as well as slab geometries. There is also support for creating bi-ventricular and slab geometries embedded in a torso / bath.


This package can also output analytic fiber orientations for LV and Slab and integrated with the [ldrb](https://github.com/finsberg/ldrb) algorithm BiV geometries.

## Install
User are encourage to use the the [provided docker image](https://github.com/ComputationalPhysiology/cardiac_geometries/pkgs/container/cardiac_geometries)
```
docker pull ghcr.io/computationalphysiology/cardiac_geometries:latest
```
which comes pre-installed with FEniCs and gmsh.

You can also install `cardiac-geometries` using `pip`
```
python3 -m pip install cardiac-geometries
```
but this requires FEniCS and gmsh to be installed in other ways. See more at https://computationalphysiology.github.io/cardiac_geometries/install.html

## Getting started
`cardiac-geometries` comes with a command-line interface, and to e.g create an LV mesh you can do
```
cardiac-geometries create-lv-ellipsoid lv-mesh
```
The same functionality can be accessed through the Python API, e.g
```python
import cardiac_geometries

geo = cardiac_geometries.mesh.create_lv_ellipsoid(outdir="lv-mesh")
```
See https://computationalphysiology.github.io/cardiac_geometries/quickstart.html for more info.


## Documentation
Please read the documentation at http://computationalphysiology.github.io/cardiac_geometries for more info.

## Contributing
See https://computationalphysiology.github.io/cardiac_geometries/CONTRIBUTING.html

## License
MIT
