Skip to content

ansys/pyansys-heart

Repository files navigation

PyAnsys Heart

PyAnsys Python PyPI GH-CI MIT Ruff pre-commit.ci

About

PyAnsys Heart is a Python library developed by the Ansys Healthcare Research team to model the human heart using Ansys LS-DYNA software. Designed to support advancements in cardiovascular research, this tool enables detailed, patient-specific simulations of heart function, capturing complex interactions like fluid-structure-electrophysiology interaction (FSEI). These simulations replicate hard-to-measure features such as structural stress, electrical activity, muscle fiber orientation, and even account for anatomical elements like the pericardium, valves, and atria.

Installation

Ensure you have all the necessary prerequisites before installing this software. Then, refer to the installation guidelines for detailed instructions on how to install PyAnsys Heart in your system.

Documentation

Documentation for the latest stable release of PyAnsys Heart is hosted at PyAnsys Heart documentation.

In the upper right corner of the documentation's title bar, there is an option for switching from viewing the documentation for the latest stable release to viewing the documentation for the development version or previously released versions.

Descriptions follow for each documentation section:

  • Getting started: Provides an overview of key techniques in cardiac modeling, package prerequisites, and installation information.
  • User guide: Provides an overview of the capabilities of PyAnsys Heart, explaining the key concept of preprocessor, simulator, and postprocessor.
  • API reference: Describes PyAnsys Heart endpoints, their capabilities, and how to interact with them programmatically.
  • Examples: Shows how to use the Preprocessor, Postprocessor, and Simulator modules to preprocess, consume, and analyze heart models.
  • Contribute: Provides guidelines and instructions on how to contribute based on your role in the project.
  • Release notes: Provides a summary of notable changes for each version of PyAnsys Heart. It helps you keep track of updates, bug fixes, new features, and improvements made to the project over time.

On the PyAnsys Heart Issues page, you can create issues to report bugs and request new features. On the PyAnsys Heart Discussions page or the Discussions page on the Ansys Developer portal, you can post questions, share ideas, and get community feedback. To reach the project support team, email pyansys.core@ansys.com.

About

Python framework for heart modeling using Ansys tools

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Contributors 17

Languages