| Name | cardiac-geometriesx JSON |
| Version |
0.4.4
JSON |
| download |
| home_page | None |
| Summary | A python library for cardiac geometries |
| upload_time | 2024-11-24 15:52:17 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT |
| keywords |
cardiac
geometry
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://github.com/ComputationalPhysiology/cardiac-geometriesx/actions/workflows/docker-image.yml)
[](https://github.com/ComputationalPhysiology/cardiac-geometriesx/actions/workflows/test.yml)
[](https://github.com/ComputationalPhysiology/cardiac-geometriesx/actions/workflows/test-mpi.yml)
[](https://github.com/ComputationalPhysiology/cardiac-geometriesx/actions/workflows/pre-commit.yml)
[](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 the provided docker image e.g
```
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
Raw data
{
"_id": null,
"home_page": null,
"name": "cardiac-geometriesx",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "cardiac, geometry",
"author": null,
"author_email": "Henrik Finsberg <henriknf@simula.no>",
"download_url": "https://files.pythonhosted.org/packages/3f/dd/55da8a5f1532244819f5b1a39d1f26f5a429caf866ec7058edec1876afd7/cardiac_geometriesx-0.4.4.tar.gz",
"platform": null,
"description": "\n\n[](https://github.com/ComputationalPhysiology/cardiac-geometriesx/actions/workflows/docker-image.yml)\n[](https://github.com/ComputationalPhysiology/cardiac-geometriesx/actions/workflows/test.yml)\n[](https://github.com/ComputationalPhysiology/cardiac-geometriesx/actions/workflows/test-mpi.yml)\n[](https://github.com/ComputationalPhysiology/cardiac-geometriesx/actions/workflows/pre-commit.yml)\n[](https://badge.fury.io/py/cardiac-geometriesx)\n\n# Cardiac geometries\n\nCardiac 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.\n\nThere are two ways you can use `cardiac-geomtries`, either using the command line interface, e.g\n```\ngeox lv-ellipsoid --create-fibers lv-mesh --fiber-space P_2\n```\n\nor using the python API e.g\n```python\ngeo = cardiac_geometries.mesh.lv_ellipsoid(outdir=\"lv-mesh\", create_fibers=True, fiber_space=\"P_2\")\n```\n\n## Install\n\nTo install the package you can use `pip`\n```\npython3 -m pip install cardiac-geometriesx\n```\nhowever, this assumes that you already have `dolfinx` pre-installed. You can also use the provided docker image e.g\n```\ndocker pull ghcr.io/computationalphysiology/cardiac-geometriesx:latest\n```\nTo start a new container interactive you can do\n```\ndocker run --name geox -v $PWD:/home/shared -w /home/shared -it ghcr.io/computationalphysiology/cardiac-geometriesx:latest\n```\nor if you just want to create a mesh and exit you can run the command line interface directly e.g\n```\ndocker 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\n```\n\n## Authors\nHenrik Finsberg (henriknf@simula.no)\n\n## License\nMIT\n\n## Contributing\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A python library for cardiac geometries",
"version": "0.4.4",
"project_urls": {
"Homepage": "https://github.com/finsberg/cardiac-geometriesx"
},
"split_keywords": [
"cardiac",
" geometry"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "404c24eb49de6432bbfedd661fa694b1f32349872000688302c5d3007ff440b7",
"md5": "c5dfe4ad695e0518dad1bfce3070cf74",
"sha256": "c182a0c7abb4ecaa427101146fe5cc13a097bd3ec5f76401b68d0464083e759b"
},
"downloads": -1,
"filename": "cardiac_geometriesx-0.4.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c5dfe4ad695e0518dad1bfce3070cf74",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 24687,
"upload_time": "2024-11-24T15:52:15",
"upload_time_iso_8601": "2024-11-24T15:52:15.195572Z",
"url": "https://files.pythonhosted.org/packages/40/4c/24eb49de6432bbfedd661fa694b1f32349872000688302c5d3007ff440b7/cardiac_geometriesx-0.4.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3fdd55da8a5f1532244819f5b1a39d1f26f5a429caf866ec7058edec1876afd7",
"md5": "e1c3dca82a4c9bff8a043abf575e2068",
"sha256": "9a895953ae635757210650159f995cac5551eff722fcc98ed211032234b4a037"
},
"downloads": -1,
"filename": "cardiac_geometriesx-0.4.4.tar.gz",
"has_sig": false,
"md5_digest": "e1c3dca82a4c9bff8a043abf575e2068",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 24238,
"upload_time": "2024-11-24T15:52:17",
"upload_time_iso_8601": "2024-11-24T15:52:17.146581Z",
"url": "https://files.pythonhosted.org/packages/3f/dd/55da8a5f1532244819f5b1a39d1f26f5a429caf866ec7058edec1876afd7/cardiac_geometriesx-0.4.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-24 15:52:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "finsberg",
"github_project": "cardiac-geometriesx",
"github_not_found": true,
"lcname": "cardiac-geometriesx"
}
