Skip to content
1D blood flow model
Julia Python Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
src
test
.gitignore
.travis.yml
CONTRIBUTING.md
LICENSE
LICENSE-3RD-PARTY
README.md
REQUIRE
appveyor.yml
main.jl

README.md

openBF

TUoS INSIGNEO CompBioMed

License Mentioned in Awesome Julia.jl

DOI

Build Status Build status codecov

openBF is an open-source 1D blood flow solver based on MUSCL finite-volume numerical scheme, written in Julia and released under Apache 2.0 free software license.

Docs

  • openBF ≦v0.6.3 check this website for documentation and tutorials.
  • openBF v0.7+ docs can be built as julia make.jl inside the docs/ folder (this requires Documenter package).

Installation

Provided you already have a Julia v1.0 installation (all platforms download and Windows instructions), you can add openBF as

julia> ]
(v1.0) pkg> add https://github.com/INSIGNEO/openBF

test it as

julia> ]
(v1.0) pkg> test openBF

and use it as

julia> using openBF
julia> openBF.runSimulation("<input file name>.yml")

You can also create (MacOSX/Linux only) an openBF alias as

$ echo "alias openBF='cp ~/.julia/v0.6/openBF/main.jl ./main.jl && julia main.jl $1'" >> ~/.bashrc
$ source ~/.bashrc
$ openBF -h
usage: main.jl [-v] [-f] [-h] input_filename

positional arguments:
  input_filename   .yml input file name

optional arguments:
  -v, --verbose    Print STDOUT - default false
  -f, --out_files  Save complete results story rather than only the
                   last cardiac cycle
  -h, --help       show this help message and exit

Ecosystem

  • A collection of 1D networks (from literature) solved by means of openBF can be found in the openBF-hub repository.
  • The scripts to generate a virtual population of ADAN56s can be found in openBF-db repository.
  • openBF badge openBF

Publications

openBF has been used in the following works:

Have you used openBF for your research? Let us know!

Citation

@misc{melis_2018, title={openBF: Julia software for 1D blood flow modelling}, url={https://figshare.com/articles/openBF_Julia_software_for_1D_blood_flow_modelling/7166183/1}, DOI={10.15131/shef.data.7166183}, abstractNote={
openBF is an open-source 1D blood flow solver based on MUSCL finite-volume numerical scheme, written in Julia and released under Apache 2.0 free software license.

See https://github.com/INSIGNEO/openBF for the git repository and https://insigneo.github.io/openBF/ for the documentation.
}, publisher={figshare}, author={Melis, Alessandro}, year={2018}, month={Oct}}
You can’t perform that action at this time.