| Name | cardiac-geometries JSON |
| Version |
1.1.3
JSON |
| download |
| home_page | None |
| Summary | A python library for cardiac geometries |
| upload_time | 2024-04-17 06:26:50 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.6 |
| license | MIT |
| keywords |
cardiac
geometry
mesh
gmsh
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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
Raw data
{
"_id": null,
"home_page": null,
"name": "cardiac-geometries",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "cardiac, geometry, mesh, gmsh",
"author": null,
"author_email": "Henrik Finsberg <henriknf@simula.no>",
"download_url": "https://files.pythonhosted.org/packages/4a/a8/c0f25d5d985726983d4937fbef733b91e2f7a346d364c1a0b321f8892ded/cardiac_geometries-1.1.3.tar.gz",
"platform": null,
"description": "# Cardiac Geometries\n\nThis is a library for creating idealized cardiac geometries in FEniCS using `gmsh`.\nCurrently 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.\n\n\nThis package can also output analytic fiber orientations for LV and Slab and integrated with the [ldrb](https://github.com/finsberg/ldrb) algorithm BiV geometries.\n\n## Install\nUser are encourage to use the the [provided docker image](https://github.com/ComputationalPhysiology/cardiac_geometries/pkgs/container/cardiac_geometries)\n```\ndocker pull ghcr.io/computationalphysiology/cardiac_geometries:latest\n```\nwhich comes pre-installed with FEniCs and gmsh.\n\nYou can also install `cardiac-geometries` using `pip`\n```\npython3 -m pip install cardiac-geometries\n```\nbut this requires FEniCS and gmsh to be installed in other ways. See more at https://computationalphysiology.github.io/cardiac_geometries/install.html\n\n## Getting started\n`cardiac-geometries` comes with a command-line interface, and to e.g create an LV mesh you can do\n```\ncardiac-geometries create-lv-ellipsoid lv-mesh\n```\nThe same functionality can be accessed through the Python API, e.g\n```python\nimport cardiac_geometries\n\ngeo = cardiac_geometries.mesh.create_lv_ellipsoid(outdir=\"lv-mesh\")\n```\nSee https://computationalphysiology.github.io/cardiac_geometries/quickstart.html for more info.\n\n\n## Documentation\nPlease read the documentation at http://computationalphysiology.github.io/cardiac_geometries for more info.\n\n## Contributing\nSee https://computationalphysiology.github.io/cardiac_geometries/CONTRIBUTING.html\n\n## License\nMIT\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A python library for cardiac geometries",
"version": "1.1.3",
"project_urls": {
"Homepage": "https://github.com/ComputationalPhysiology/cardiac_geometries"
},
"split_keywords": [
"cardiac",
" geometry",
" mesh",
" gmsh"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6e745b4f2eed4454e05b2da478d4bf65f305b6994e356982be5a0ae0a8895ca9",
"md5": "b4ca8decd45ccc7539492c7f1f0af0ce",
"sha256": "39e9792261a4eafca70da5e9f7982f29ea50ee132f2910cb6400e871b6c03a3b"
},
"downloads": -1,
"filename": "cardiac_geometries-1.1.3-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "b4ca8decd45ccc7539492c7f1f0af0ce",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6",
"size": 30598,
"upload_time": "2024-04-17T06:26:46",
"upload_time_iso_8601": "2024-04-17T06:26:46.855667Z",
"url": "https://files.pythonhosted.org/packages/6e/74/5b4f2eed4454e05b2da478d4bf65f305b6994e356982be5a0ae0a8895ca9/cardiac_geometries-1.1.3-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4aa8c0f25d5d985726983d4937fbef733b91e2f7a346d364c1a0b321f8892ded",
"md5": "257087df49d126a013bff818d00309c5",
"sha256": "bd1395e08abd07224dd57882063aab5e9762ef171635adc11cafebed82b2d6b1"
},
"downloads": -1,
"filename": "cardiac_geometries-1.1.3.tar.gz",
"has_sig": false,
"md5_digest": "257087df49d126a013bff818d00309c5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 27199,
"upload_time": "2024-04-17T06:26:50",
"upload_time_iso_8601": "2024-04-17T06:26:50.349123Z",
"url": "https://files.pythonhosted.org/packages/4a/a8/c0f25d5d985726983d4937fbef733b91e2f7a346d364c1a0b321f8892ded/cardiac_geometries-1.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-17 06:26:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ComputationalPhysiology",
"github_project": "cardiac_geometries",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cardiac-geometries"
}
