Skip to main content

Brainways

Project description

Brainways

DOI License GNU GPL v3.0 PyPI Python Version tests codecov Documentation Status napari hub

What Is Brainways?

Brainways is an AI-based tool for automated registration, quantification and generation of brain-wide activity networks based on fluorescence in coronal slices.

Brainways UI

Why Brainways?

Coronal slice registration, cell quantification and whole-brain contrast analysis between experimental conditions should be made easily accessible from a single software, without requiring programming experience. Customization should be made easy by having a highly flexible pythonic backend.

Getting Started

To install and run brainways, run the following in your python environment:

pip install napari-brainways
napari -w napari-brainways

Follow our getting started guide for more details.

How it works

Brainways allows users to register, quantify and provide statistical contrast analysis by following several simple steps:

  1. Rigid registration of coronal slices to a 3D atlas.
  2. Non-rigid registration of coronal slices to a 3D atlas, to account for individual difference and imperfections in acquisition procedure.
  3. Cell detection (using StarDist).
  4. Quantification of cell counts per brain region.
  5. Statistical analysis:
    • ANOVA contrast analysis.
    • PLS (Partial Least Square) analysis.
    • Network graph creation.

Architecture

Brainways is implemented as three python packages. napari-brainways contains the GUI implementation as a napari plugin. napari-brainways is using brainways as its backend. All of the functionality is implemented in the brainways package. This separation was done to guarantee that brainways is a GUI-agnostic software, and can be fully accessed and manipulated through python code to allow custom complex usage scenarios. The code that was used to train, evaluate and run the automatic registration model resides in brainways-reg-model.

Development Status

Brainways is being actively developed by Ben Kantor of Bartal lab, Tel Aviv University, Israel. Our releases can be found here.

Citation

If you use brainways, please cite Kantor and Bartal (2023):

@article{kantor2023brainways,
  title={Brainways: An Open-Source AI-based Software For Registration and Analysis of Fluorescent   Markers on Coronal Brain Slices},
  author={Kantor, Ben and Ben-Ami Bartal, Inbal},
  journal={bioRxiv},
  pages={2023--05},
  year={2023},
  publisher={Cold Spring Harbor Laboratory}
}

License

Distributed under the terms of the GNU GPL v3.0 license, "napari-brainways" is free and open source software

Issues

If you encounter any problems, please file an issue along with a detailed description.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

brainways-0.1.10.1.tar.gz (2.3 MB view details)

Uploaded Source

Built Distribution

brainways-0.1.10.1-py3-none-any.whl (198.0 kB view details)

Uploaded Python 3

File details

Details for the file brainways-0.1.10.1.tar.gz.

File metadata

  • Download URL: brainways-0.1.10.1.tar.gz
  • Upload date:
  • Size: 2.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.1

File hashes

Hashes for brainways-0.1.10.1.tar.gz
Algorithm Hash digest
SHA256 04a05441829d770cf00316307de849e24aa72d18de52614bbbed69a1d68f996c
MD5 f962481d071ef2681978aa8d5c7f2fe1
BLAKE2b-256 a2e82c798e5519c37d534fdc1d0300e115f6e4a08f0b1d0e42443fe74a51b268

See more details on using hashes here.

File details

Details for the file brainways-0.1.10.1-py3-none-any.whl.

File metadata

  • Download URL: brainways-0.1.10.1-py3-none-any.whl
  • Upload date:
  • Size: 198.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.1

File hashes

Hashes for brainways-0.1.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e163cbb2934c10707bf793fb25797ea4e2c3bb841719189ecbd009714eb5df87
MD5 db5cfec8e315350210be6ca75f0d64c1
BLAKE2b-256 42ea058f83fdcd06913b97ee0c69af4d2a9210394bf265cb60f0d87cc7706f8e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page