The ``ansys.health.heart`` library
==================================
.. py:module:: ansys.health.heart
Summary
-------
.. py:currentmodule:: heart
.. tab-set::
.. tab-item:: Subpackages
.. list-table::
:header-rows: 0
:widths: auto
* - :py:obj:`~ansys.health.heart.post`
- Postprocessing subpackage.
* - :py:obj:`~ansys.health.heart.pre`
- Preprocessing subpackage.
* - :py:obj:`~ansys.health.heart.settings`
- Settings subpackage.
* - :py:obj:`~ansys.health.heart.utils`
- Subpackage containing various utilities.
* - :py:obj:`~ansys.health.heart.writer`
- Writer subpackage.
.. tab-item:: Submodules
.. list-table::
:header-rows: 0
:widths: auto
* - :py:obj:`~ansys.health.heart.examples`
- Utility functions to get various examples.
* - :py:obj:`~ansys.health.heart.exceptions`
- Custom exceptions for PyAnsys Heart.
* - :py:obj:`~ansys.health.heart.logger`
- Logging module.
* - :py:obj:`~ansys.health.heart.models`
- Module containing classes for the various heart models.
* - :py:obj:`~ansys.health.heart.models_utils`
- Stateless methods for the heart model.
* - :py:obj:`~ansys.health.heart.objects`
- Module that defines classes used in the heart model.
* - :py:obj:`~ansys.health.heart.simulator`
- Simulator module.
.. tab-item:: Attributes
.. list-table::
:header-rows: 0
:widths: auto
* - :py:obj:`~__version__`
- Version of PyAnsys Heart.
.. tab-item:: Constants
.. list-table::
:header-rows: 0
:widths: auto
* - :py:obj:`~LOG`
-
.. toctree::
:titlesonly:
:maxdepth: 1
:hidden:
post
pre
settings
utils
writer
.. toctree::
:titlesonly:
:maxdepth: 1
:hidden:
examples
exceptions
logger
models
models_utils
objects
simulator
Description
-----------
PyAnsys Heart is a Python framework for heart modeling using Ansys tools.
..
!! processed by numpydoc !!
Module detail
-------------
.. py:data:: LOG
.. py:data:: __version__
Version of PyAnsys Heart.
..
!! processed by numpydoc !!