Skip to content

ComputationalPhysiology/pulse_adjoint

Repository files navigation

CircleCI Documentation Status codecov

Pulse-Adjoint

Pulse-Adjoint is an extension of the pulse library for doing data assimilation for cardiac mechanics applications.

Note

This is a full rewriting of the code in the following repo. Note that the version in this repo is experimental and might contain several bugs. If you encounter bugs we would appreciate if you could file an issue.

Installation

Before installing pulse-adjoint you need to install FEniCS See https://pulse-adjoint.readthedocs.io/en/latest/installation.html

Documentation

Documentation can be found at https://pulse-adjoint.readthedocs.io/ You can create documentation yourselves by typing make docs in the root directory.

Getting started

Check out the demos in the demo folder.

Automated test

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

python -m pytest tests -vv

You can also type

make test

which with run the test and generate a coverage report. You can have a look at the coverage report if you type

make coverage

Tests are run in continuous integration using circle ci and a coverage report is automatically generated

Licence

LGPL version 3 or later

Credits

This package was created with Cookiecutter and the finsberg/cookiecutter-pypackage project template.