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
brainways ui

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 modules. 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

napari_brainways-0.1.13.tar.gz (6.4 MB view details)

Uploaded Source

Built Distribution

napari_brainways-0.1.13-py3-none-any.whl (523.3 kB view details)

Uploaded Python 3

File details

Details for the file napari_brainways-0.1.13.tar.gz.

File metadata

  • Download URL: napari_brainways-0.1.13.tar.gz
  • Upload date:
  • Size: 6.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for napari_brainways-0.1.13.tar.gz
Algorithm Hash digest
SHA256 1d8d2077027460d5116080fd64229b10487932c09e12ac6be4cccfc284562695
MD5 8c7e0a8b2b62358d2fd09b19861509fa
BLAKE2b-256 f8f96f62e1772f0c8e98b643e7e5097761976d6623eddd77cb1dbd249d0875d8

See more details on using hashes here.

File details

Details for the file napari_brainways-0.1.13-py3-none-any.whl.

File metadata

File hashes

Hashes for napari_brainways-0.1.13-py3-none-any.whl
Algorithm Hash digest
SHA256 c1416a75cac17db81902f1b4c28626a0fbdefdd00c9157ff5960a1fd43000b88
MD5 311cadc4cc8f9eefdccd71b59f154894
BLAKE2b-256 d9932e6165f1bfe4c3a69ff732cc5ced58c3d2da6cbaaae251671c9d65541b0f

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