Science Score: 67.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
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.9%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: hittheant
  • License: mit
  • Language: Jupyter Notebook
  • Default Branch: main
  • Size: 22.4 MB
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 2 years ago · Last pushed over 2 years ago
Metadata Files
Readme License Citation

README.md

ffian: Fluid Flow In Astrocyte Networks

The role of astrocyte networks in brain volume homeostasis and waste clearance has not received enough attention from the neuroscience community. However, recent research efforts indicate that glial cells are crucial for fluid flow through brain tissue, contributing to clearance and maintenance of brain volume. We examine the role of various glial cotransporters in the spatial and temporal changes of the intra- and extracellular volume fractions and fluid dynamics via computational modelling. The model is incorporated within the Kirchhoff-Nernst- Planck electrodiffusive framework and takes into account ionic electrodiffusion and fluid dynamics. Our research shows that all model configurations demonstrate similar fluid fluxes, except those involving HCO− 3 dynamics. The model configuration that included the NBC cotransporter was observed to have the greatest intracellular total volume-weighted fluid velocity of 16 μm/s.

ffian is an implementation of the KNP continuity equations for a one-dimensional system containing two compartments: one representing an astrocyte network (ICS) and one representing the extracellular space (ECS). ffian.project_flow_models takes transmembrane- and compartmental fluid flow into account and predicts the evolution in time and distribution in space of the volume fractions, ion concentrations (Na+, K+, Cl-), electrical potentials, and hydrostatic pressures in the ICS and ECS. Each model in the projectflowmodels package includes a different combination of cotransporters, with the 'model_base' representing only leak channels. The fluid model is presented in Sætra et al. 2023, Neural activity induces strongly coupled electro-chemo-mechanical interactions and fluid flow in astrocyte networks and extracellular space – a computational study.

Previous code

This code has been adapted from the repository at https://martejulie.github.io/fluid-flow-in-astrocyte-networks.

Installation

Conda

Warning If you want to run the examples, and use conda to install ffian, you need to have texlive-core installed on your system.

Start by cloning into the repository:

console $ git clone https://github.com/martejulie/fluid-flow-in-astrocyte-networks.git $ cd ffian

Then, using the environment.yml file in the root of the repository, you can call:

console $ conda env update --file environment.yml --name your_environment

Next, you can now activate your environment by running::

console $ conda activate your_environment

Finally, install ffian inside your conda environment using pip:

console $ python3 -m pip install .

Source

To install the ffian-library from source, navigate to the root of the repository and run the following commands from the command line: bash python3 -m pip install python/. --upgrade

ffian requires fenics-dolfin, numpy, and matplotlib.

Run simulations

The example folder includes code showing how to run the simulations. Use project_simulation.py to run simulations with models with expanded cotransporters. To reproduce the results in the paper, see 'Plot Simulation Data' jupyter notebook.

Owner

  • Login: hittheant
  • Kind: user

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: >-
  Neural activity induces strongly coupled
  electro-chemo-mechanical interactions and fluid flow in
  astrocyte networks and extracellular space – a
  computational study
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Marte J.
    family-names: Sætra
  - given-names: Ada J.
    family-names: Ellingsrud
  - given-names: Marie E.
    family-names: Rognes
identifiers:
  - type: doi
    value: 10.1101/2023.03.06.531247
repository-code: >-
  https://github.com/martejulie/fluid-flow-in-astrocyte-networks
url: >-
  https://www.biorxiv.org/content/10.1101/2023.03.06.531247v1
license: MIT
version: 0.2.0
date-released: '2023-03-08'

GitHub Events

Total
Last Year

Dependencies

.github/workflows/build_docker.yml actions
  • actions/checkout v3 composite
  • docker/build-push-action v3 composite
  • docker/login-action v2 composite
  • docker/metadata-action v4 composite
  • docker/setup-buildx-action v2 composite
  • docker/setup-qemu-action v2 composite
.github/workflows/build_docs.yml actions
  • actions/checkout v3 composite
  • actions/configure-pages v2 composite
  • actions/deploy-pages v1 composite
  • actions/upload-pages-artifact v1 composite
.github/workflows/test_package.yml actions
  • actions/checkout v3 composite
docker/Dockerfile docker
  • condaforge/mambaforge latest build
pyproject.toml pypi
  • fenics-dolfin *
  • matplotlib *
  • numpy *
environment.yml conda
  • fenics-dolfin
  • numpy
  • python 3.10.*