Brainways
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.
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:
- Rigid registration of coronal slices to a 3D atlas.
- Non-rigid registration of coronal slices to a 3D atlas, to account for individual difference and imperfections in acquisition procedure.
- Cell detection (using StarDist).
- Quantification of cell counts per brain region.
- 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.
Metadata
Release files for napari-brainways 0.1.14.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| napari_brainways-0.1.14.2.tar.gz | 6.4 MB | Without provenance | Details for napari_brainways-0.1.14.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| napari_brainways-0.1.14.2-py3-none-any.whl | Python 3 | none | any | Details for napari_brainways-0.1.14.2-py3-none-any.whl |
Total release size: 7.0 MB
Release files / napari_brainways-0.1.14.2.tar.gz
| Download URL | napari_brainways-0.1.14.2.tar.gz |
|---|---|
| Size | 6.4 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
966b9e47e0478b5a29d9115f03e0b533824632b139b7b8157b192b0bcb16e95e
|
|
BLAKE2b-256 checksum How to use checksums |
67e12a04c91e4053ef403d1b51e343749ec62649ba8df74672dc21b6cbfce1dc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Release files / napari_brainways-0.1.14.2-py3-none-any.whl
| Download URL | napari_brainways-0.1.14.2-py3-none-any.whl |
|---|---|
| Size | 535.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a5260dd474077b75253563eaaaef1d01d7f244a31e4c406f790f8a9eaee3c26e
|
|
BLAKE2b-256 checksum How to use checksums |
2d06c376641f81f15796d5b0adbf1567874b0a63c4714a61811a1f314fe8133c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Security for napari-brainways 0.1.14.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.