https://github.com/bluebrain/astrovascpy

Vasculature blood flow computation and impact of astrocytic endfeet on vessels

https://github.com/bluebrain/astrovascpy

Science Score: 75.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 1 DOI reference(s) in README
  • Academic publication links
    Links to: biorxiv.org
  • Academic email domains
  • Institutional organization owner
    Organization bluebrain has institutional domain (portal.bluebrain.epfl.ch)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.6%) to scientific vocabulary

Keywords

bloodflow circuit experiment simulation
Last synced: 5 months ago · JSON representation ·

Repository

Vasculature blood flow computation and impact of astrocytic endfeet on vessels

Basic Info
  • Host: GitHub
  • Owner: BlueBrain
  • License: apache-2.0
  • Language: Python
  • Default Branch: main
  • Homepage: https://astrovascpy.rtfd.io
  • Size: 709 KB
Statistics
  • Stars: 11
  • Watchers: 9
  • Forks: 4
  • Open Issues: 2
  • Releases: 2
Archived
Topics
bloodflow circuit experiment simulation
Created over 2 years ago · Last pushed 12 months ago
Metadata Files
Readme Changelog Contributing License Citation Authors

README.md

[!WARNING] The Blue Brain Project concluded in December 2024, so development has ceased under the BlueBrain GitHub organization. Future development will take place at: https://github.com/openbraininstitute/AstroVascPy

AstroVascPy Logo

AstroVascPy

AstroVascPy is a Python library for computing the blood pressure and flow through the vasculature (whole cortical column). AstroVascPy incorporates the effect of astrocytic endfeet on the blood vessel radii. In particular, AstroVascPy replicates the dynamics of the radius of a vessel due to vasodilation.

AstroVascPy uses vascpy Point Graph representation to access the vasculature database stored in h5 file (sonata format).

vascpy standardizes the api for the vasculature datasets. PointVasculature (PointGraph) representation is basically a composition of two pandas data frames, one for node properties (x, y, z, radius, other...) and one for edge properties (startnode, endnode, other...).

Inputs

  • pointgraph vasculature
  • endfeet locations with corresponding ids
  • radius of vessels at endfeet locations (possibly depending on simulation time)

Outputs

  • blood pressure at each node of the vasculature (node vector)
  • blood flow at each segment (edge vector)

Installation (Linux & MacOS)

AstroVascPy can be git cloned here:

https://github.com/BlueBrain/astrovascpy

Either locally or in BB5, one can run:

source setup.sh

to install the AstroVascPy solver (+ all its dependencies) and set the environment. For the local installation (workstation), please install conda before running the command above. Remark: Run this command every time before using the solver in order to set the environment correctly.

Backend Solvers: export BACKEND_SOLVER_BFS='petsc' or export BACKEND_SOLVER_BFS='scipy', the user can choose the backend solver for the linear systems. Remark: PETSc is inherently parallel, while SciPy is not. Therefore, running the Blood Flow Solver with MPI makes sense only while using petsc!

Blood Flow Solver (BFS) debugging: By typing export DEBUG_BFS=1, we run both PETSc & SciPy, and we compare their results. To disable this behavior please type export DEBUG_BFS=0 (default behavior).

Usage

The code can be run using

python3 compute_static_flow_pressure.py

Load Archngv graph

An archngv graph can be loaded and converted to a pickle binary format, using the script load_graph_archngv.py inside the folder examples. Run the script as

python3 load_graph_archngv.py --filename_ngv "path_to_ngv_circuit" --output_graph "output_graph_name.bin"

Sonata reports

Structure of the reports: This is a particular type of compartment report for the vasculature. We get a set of 3 reports at each time-step storing the blood flow, the blood pressure and, the radius at each segment of the vasculature. Here are the units of these entities: -flow (µm^3.s^-1) -pressure (g.µm^-1.s^-2) -radius (µm)

Authors

Stéphanie Battini, Nicola Cantarutti, Christos Kotsalos and Tristan Carel

Link to the article on Bio-arxiv

Funding and Acknowledgements

The development of this software was supported by funding to the Blue Brain Project, a research center of the École polytechnique fédérale de Lausanne (EPFL), from the Swiss government’s ETH Board of the Swiss Federal Institutes of Technology.

We would like to thank Alessandro Cattabiani, Thomas Delemontex and Eleftherios Zisis for reviewing the code and the engineering support.

Copyright (c) 2023-2023 Blue Brain Project/EPFL

Owner

  • Name: The Blue Brain Project
  • Login: BlueBrain
  • Kind: organization
  • Email: bbp.opensource@epfl.ch
  • Location: Geneva, Switzerland

Open Source Software produced and used by the Blue Brain Project

Citation (CITATION.cff)

cff-version: 1.2.0
title: AstroVascPy
message: '"If you use this software, please cite it as below."'
type: software
authors:
  - given-names: >-
      Stéphanie Battini, Nicola Cantarutti, Christos
      Kotsalos and Tristan Carel
    affiliation: Blue Brain Project (EPFL)
repository-code: 'https://github.com/BlueBrain/AstroVascPy'
date-released: 2023-06-26

GitHub Events

Total
  • Watch event: 3
  • Delete event: 1
  • Issue comment event: 3
  • Push event: 3
  • Pull request review event: 2
  • Pull request event: 3
  • Fork event: 2
  • Create event: 2
Last Year
  • Watch event: 3
  • Delete event: 1
  • Issue comment event: 3
  • Push event: 3
  • Pull request review event: 2
  • Pull request event: 3
  • Fork event: 2
  • Create event: 2

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 7
  • Total pull requests: 36
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 6 days
  • Total issue authors: 3
  • Total pull request authors: 5
  • Average comments per issue: 1.0
  • Average comments per pull request: 3.78
  • Merged pull requests: 32
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 5
  • Average time to close issues: N/A
  • Average time to close pull requests: 4 days
  • Issue authors: 0
  • Pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.4
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • nico-canta (5)
  • penguinpee (1)
  • tristan0x (1)
Pull Request Authors
  • tristan0x (24)
  • nico-canta (23)
  • StephLisa (2)
  • ASVG (2)
  • penguinpee (1)
  • kotsaloscv (1)
Top Labels
Issue Labels
enhancement (1)
Pull Request Labels
enhancement (2)

Dependencies

package.json npm
pyproject.toml pypi
setup.py pypi