Python package implementing the 1D blood flow equations using the Lax-Wendroff method.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
data
docs
paper
tests
vampy
.gitignore
LICENSE.rst
README.md
VaMpy_logo.png
VaMpy_logo.svg
bifurcation.cfg
bifurcation_example.py
plot_example.py
setup.cfg
setup.py
vampy.yml

README.md

VaMpy logo

An implementation of finite difference methods (FDM) to solve partial differential equations (PDE).

The first method to be implemented is Richtmyer's 2 step Lax-Wendroff method.

This is the README file for the project.


Journal paper

A paper on the VaMpy Python package has been published in the Journal of Open Research Software. Whenever using VaMpy for your research, please cite it as

Diem AK, Bressloff NW (2017) VaMpy: A Python Package to Solve 1D Blood Flow Problems. Journal of Open Research Software 5: 17, http://doi.org/10.5334/jors.159


Installation

The package is available on Github. To clone the package run

git clone https://github.com/akdiem/VaMpy.git

To ensure all package dependencies are met it is easiest to set up a new Anaconda environment for VaMpy. This step is optional. The file vampy.yml can be used for this by calling

conda env create -f vampy.yml
source activate vampy

The first command creates the Anaconda environment vampy which contains all required packages, whilst the second command sets the current terminal to use this environment. To install VaMpy run

python setup.py install

Running the example files

To execute one of the example files run

python bifurcation_example.py bifurcation.cfg

To plot the data created from the example run

python plot_example.py bifurcation.cfg

Issues fixed and features added since latest release


Module Documentation

The module documentation can be found on

http://akdiem.github.io/vampy/


Artery setup walkthrough

The module documentation also contains a section on setting up an artery simulation, explaining parameters in the configuration file and code used to set up a simulation.