simcardems 2022.0.0

Simula Cardiac electromechanics solver

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. The solver depends on pulse and cbcbeat.

Installation

See Installation instructions

Getting started

See Quickstart guide

Documentation

Documentation is hosted at http://computationalphysiology.github.io/simcardems.

To build the documentation locally should should first install the documentation requirements

python -m pip install ".[docs]"

Then should should run the sphinx-apidoc command (from the root directory)

sphinx-apidoc -o docs/source src/simcardems

and finally build the html

cd docs
make html

Now open docs/build/html/index.html to see the documentation.

Automated test

Tests are provided in the folder tests. You can run the tests with pytest

python3 -m pytest tests -vv

Contributing

See CONTRIBUTING.md

Known issues

• Issue with h5py, see https://github.com/ComputationalPhysiology/pulse#known-issues

Authors

• Henrik Finsberg ([e-mail])
• Ilsbeth van Herck ([e-mail])
• Cécile Daversin-Catty ([e-mail])