https://github.com/kvslab/vampy
A collection of tools for pre-processing, simulating, and post-processing vascular morphologies.
https://github.com/kvslab/vampy
computational-fluid-dynamics post-processing pre-processing vascular
Last synced: about 1 month ago
JSON representation
A collection of tools for pre-processing, simulating, and post-processing vascular morphologies.
- Host: GitHub
- URL: https://github.com/kvslab/vampy
- Owner: KVSlab
- License: other
- Created: 2018-07-10T11:19:15.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-03-25T22:18:17.000Z (10 months ago)
- Last Synced: 2025-10-24T01:16:41.719Z (3 months ago)
- Topics: computational-fluid-dynamics, post-processing, pre-processing, vascular
- Language: Python
- Homepage: https://kvslab.github.io/VaMPy
- Size: 153 MB
- Stars: 18
- Watchers: 7
- Forks: 11
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: COPYING
- Citation: CITATION.cff
Awesome Lists containing this project
README
# VaMPy - Vascular Modeling Pypeline
_________________
[](LICENSE)
[](https://codecov.io/gh/KVSlab/VaMPy)
[](https://github.com/kvslab/vampy/actions/workflows/check_and_test_package.yml)
[](https://github.com/kvslab/vampy/actions/workflows/deploy_pages.yml)
[](https://doi.org/10.21105/joss.05278)
[](https://doi.org/10.5281/zenodo.7950605)
_________________
Pre-processed and simulated artery model. From left to right: A variable density volumetric mesh, zoomed in view of an outlet showing the four boundary layers, corresponding inlet flow rate, outlet flow split, and probes for velocity and pressure sampling. From the simulation results, we have shown the velocity field represented by vectors, and the time averaged wall shear stress (TAWSS) as one of the many hemodynamic indices computed by the post-processing scripts.
Description
-----------
The Vascular Modeling Pypeline (VaMPy) is a collection of fully automated scripts used to prepare, run, and analyze
cardiac and atrial morphologies. This includes pre-processing scripts for meshing and probe sampling,
two [Oasis](https://github.com/mikaem/Oasis) problem files for simulating flow in
the [internal carotid artery](https://en.wikipedia.org/wiki/Internal_carotid_artery) and
the [left atrium](https://en.wikipedia.org/wiki/Atrium_(heart)), and a variety of post-processing scripts for computing
WSS-based metrics, more advanced turbulence metrics, and a variety of morphological parameters in patient-specific
geometries.
Installation
------------
VaMPy is a Python package for Python >= 3.8, with main dependencies to [morphMan](https://github.com/KVSlab/morphMan) and [Oasis](https://github.com/mikaem/Oasis). VaMPy and its dependencies can be installed with `conda` on n Linux and
macOS using the following command:
```
conda create -n your_environment -c conda-forge vampy
```
More details on installation via `conda` can be found [here](https://kvslab.github.io/VaMPy/conda.html). The package can also be installed and run through its latest `Docker` image supported by Windows, Linux, and macOS, and explained [here](https://kvslab.github.io/VaMPy/docker.html).
Documentation
-------------
VaMPy's documentation is hosted [here](https://kvslab.github.io/VaMPy). This includes
two [tutorials](https://kvslab.github.io/VaMPy/tutorials.html), meant to guide the user through the basic steps of
performing a computational fluid dynamic simulation in a vascular body.
Licence
-------
VaMPy is licensed under the GNU GPL, version 3 or (at your option) any later version.
VaMPy is Copyright (2018-2023) by the authors.
Authors
-------
VaMPy has been developed by
* [Aslak W. Bergersen](https://github.com/aslakbergersen)
* [Henrik A. Kjeldsberg](https://github.com/HKjeldsberg)
Issues
------
Please report bugs and other issues through the issue tracker at:
https://github.com/KVSlab/VaMPy/issues