[](https://github.com/ComputationalPhysiology/simcardems/actions/workflows/main.yml)
[](https://badge.fury.io/py/simcardems)
[](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/finsberg/a7290de789564f03eb6b1ee122fce423/raw/simcardems-coverage.json)
[](https://github.com/ComputationalPhysiology/simcardems/actions/workflows/github-pages.yml)
[](https://results.pre-commit.ci/latest/github/ComputationalPhysiology/simcardems/main)
[](https://github.com/psf/black)
[](https://www.gnu.org/licenses/lgpl-2.1)
[](https://zenodo.org/badge/latestdoi/409220068)
[](https://joss.theoj.org/papers/28986461c27b8a76c8ac5a43dc57e8dc)
# Simula Cardiac Electro-Mechanics Solver
`simcardems` is a FEniCS-based cardiac electro-mechanics solver and is developed as a part of the [SimCardio Test project](https://www.simcardiotest.eu/wordpress/). The solver depends on [`pulse`](https://github.com/ComputationalPhysiology/pulse) and [`cbcbeat`](https://github.com/ComputationalPhysiology/cbcbeat).
## Installation
See [Installation instructions](https://computationalphysiology.github.io/simcardems/install.html)
## Getting started
See [the demos](https://computationalphysiology.github.io/simcardems/simple_demo.html)
## Documentation
Documentation is hosted at http://computationalphysiology.github.io/simcardems.
## Automated test
Tests are provided in the folder [tests](https://github.com/ComputationalPhysiology/simcardems/tree/main/tests). You can run the tests with pytest
```
python3 -m pytest tests -vv
```
## Contributing
See [the contributing section](https://computationalphysiology.github.io/simcardems/CONTRIBUTING.html)
## Citing
If you use `simcardems` in your research, please cite it as follows
```
@article{Finsberg2023,
doi = {10.21105/joss.04753},
url = {https://doi.org/10.21105/joss.04753},
year = {2023},
publisher = {The Open Journal},
volume = {8},
number = {81},
pages = {4753},
author = {Henrik Nicolay Topnes Finsberg and Ilsbeth Gerarda Maria van Herck and Cécile Daversin-Catty and Hermenegild Arevalo and Samuel Wall},
title = {simcardems: A FEniCS-based cardiac electro-mechanics solver},
journal = {Journal of Open Source Software}
}
```
## Known issues
- Issue with h5py, see https://github.com/ComputationalPhysiology/pulse#known-issues
## Authors
- Henrik Finsberg (henriknf@simula.no)
- Ilsbeth van Herck (ilse@simula.no)
- Cécile Daversin-Catty (cecile@simula.no)
Raw data
{
"_id": null,
"home_page": "https://github.com/ComputationalPhysiology/simcardems",
"name": "simcardems",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "action potential,cardiac mechanics,electrophysiology,electromechanics",
"author": "Henrik Finsberg, Ilsbeth van Herck, C\u00e9cile Daversin-Catty",
"author_email": "henriknf@simula.no",
"download_url": "https://files.pythonhosted.org/packages/72/85/d4618106e2bdd554ad4631c733ab68c58c0025823e59a63a67351d30439a/simcardems-2023.7.1.tar.gz",
"platform": null,
"description": "[](https://github.com/ComputationalPhysiology/simcardems/actions/workflows/main.yml)\n[](https://badge.fury.io/py/simcardems)\n[](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/finsberg/a7290de789564f03eb6b1ee122fce423/raw/simcardems-coverage.json)\n[](https://github.com/ComputationalPhysiology/simcardems/actions/workflows/github-pages.yml)\n[](https://results.pre-commit.ci/latest/github/ComputationalPhysiology/simcardems/main)\n[](https://github.com/psf/black)\n[](https://www.gnu.org/licenses/lgpl-2.1)\n[](https://zenodo.org/badge/latestdoi/409220068)\n[](https://joss.theoj.org/papers/28986461c27b8a76c8ac5a43dc57e8dc)\n\n# Simula Cardiac Electro-Mechanics Solver\n\n`simcardems` is a FEniCS-based cardiac electro-mechanics solver and is developed as a part of the [SimCardio Test project](https://www.simcardiotest.eu/wordpress/). The solver depends on [`pulse`](https://github.com/ComputationalPhysiology/pulse) and [`cbcbeat`](https://github.com/ComputationalPhysiology/cbcbeat).\n\n\n## Installation\n\nSee [Installation instructions](https://computationalphysiology.github.io/simcardems/install.html)\n\n## Getting started\n\nSee [the demos](https://computationalphysiology.github.io/simcardems/simple_demo.html)\n\n## Documentation\n\nDocumentation is hosted at http://computationalphysiology.github.io/simcardems.\n\n## Automated test\n\nTests are provided in the folder [tests](https://github.com/ComputationalPhysiology/simcardems/tree/main/tests). You can run the tests with pytest\n\n```\npython3 -m pytest tests -vv\n```\n\n## Contributing\nSee [the contributing section](https://computationalphysiology.github.io/simcardems/CONTRIBUTING.html)\n\n## Citing\nIf you use `simcardems` in your research, please cite it as follows\n```\n@article{Finsberg2023,\n doi = {10.21105/joss.04753},\n url = {https://doi.org/10.21105/joss.04753},\n year = {2023},\n publisher = {The Open Journal},\n volume = {8},\n number = {81},\n pages = {4753},\n author = {Henrik Nicolay Topnes Finsberg and Ilsbeth Gerarda Maria van Herck and C\u00e9cile Daversin-Catty and Hermenegild Arevalo and Samuel Wall},\n title = {simcardems: A FEniCS-based cardiac electro-mechanics solver},\n journal = {Journal of Open Source Software}\n }\n```\n\n## Known issues\n\n- Issue with h5py, see https://github.com/ComputationalPhysiology/pulse#known-issues\n\n\n## Authors\n- Henrik Finsberg (henriknf@simula.no)\n- Ilsbeth van Herck (ilse@simula.no)\n- C\u00e9cile Daversin-Catty (cecile@simula.no)\n",
"bugtrack_url": null,
"license": "LGPL-2.1",
"summary": "Simula Cardiac electromechanics solver",
"version": "2023.7.1",
"project_urls": {
"Homepage": "https://github.com/ComputationalPhysiology/simcardems"
},
"split_keywords": [
"action potential",
"cardiac mechanics",
"electrophysiology",
"electromechanics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7f3211b06772a6d75f5b0e382e3483c76b7851b4d08f91df747247a25f756e1a",
"md5": "930457bf54cf81c8fe1e7984a335a59e",
"sha256": "ae7fcb6b6a2639e220d1d5d0460c2b7337e6b60e0702f8ae55fdf9fe5bfcd545"
},
"downloads": -1,
"filename": "simcardems-2023.7.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "930457bf54cf81c8fe1e7984a335a59e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 126788,
"upload_time": "2023-10-26T10:14:15",
"upload_time_iso_8601": "2023-10-26T10:14:15.040592Z",
"url": "https://files.pythonhosted.org/packages/7f/32/11b06772a6d75f5b0e382e3483c76b7851b4d08f91df747247a25f756e1a/simcardems-2023.7.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7285d4618106e2bdd554ad4631c733ab68c58c0025823e59a63a67351d30439a",
"md5": "114e04a389d22563bfbe5786ccfd9c06",
"sha256": "9b1c321eeab8f5b514e6e10df7e3c6abcec549c1c9778a18dba6b33c0c3a9aec"
},
"downloads": -1,
"filename": "simcardems-2023.7.1.tar.gz",
"has_sig": false,
"md5_digest": "114e04a389d22563bfbe5786ccfd9c06",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 120356,
"upload_time": "2023-10-26T10:14:16",
"upload_time_iso_8601": "2023-10-26T10:14:16.675681Z",
"url": "https://files.pythonhosted.org/packages/72/85/d4618106e2bdd554ad4631c733ab68c58c0025823e59a63a67351d30439a/simcardems-2023.7.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-26 10:14:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ComputationalPhysiology",
"github_project": "simcardems",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "simcardems"
}
JSON
