Skip to main content

A collection of end-to-end data analysis workflows executed using BrainGlobe tools.

Project description

Python Version PyPI Downloads Wheel Development Status Tests codecov Code style: black Imports: isort pre-commit Contributions Website Twitter

BrainGlobe Workflows

brainglobe-workflows is a package that provides users with a number of out-of-the-box data analysis workflows employed in neuroscience, implemented using BrainGlobe tools. You can view the full documentation for each workflow online. You can also find the documentation for the backend BrainGlobe tools these workflows use on our website.

At present, the package offers the following workflows:

  • cellfinder: Whole-brain detection, registration, and analysis.

Installation

If you want to install BrainGlobe workflows as a standalone tool, you can run pip install in your desired environment:

pip install brainglobe-workflows

brainglobe-workflows is built using BrainGlobe tools, and it will automatically fetch the tools that it needs and install them into your environment. Once BrainGlobe version 1 is available, this package will fetch all BrainGlobe tools and handle their install into your environment, to prevent potential conflicts from partial-installs.

Contributing

Contributions to BrainGlobe are more than welcome. Please see the developers guide.

Citing brainglobe-workflows

If you use any tools in the brainglobe suite, please let us know, and we'd be happy to promote your paper/talk etc.

If you find cellfinder useful, and use it in your research, please cite the paper outlining the cell detection algorithm:

Tyson, A. L., Rousseau, C. V., Niedworok, C. J., Keshavarzi, S., Tsitoura, C., Cossell, L., Strom, M. and Margrie, T. W. (2021) “A deep learning algorithm for 3D cell detection in whole mouse brain image datasets’ PLOS Computational Biology, 17(5), e1009074 https://doi.org/10.1371/journal.pcbi.1009074

If you use any of the image registration functions in cellfinder, please also cite brainreg.


Cellfinder

Whole-brain cell detection, registration and analysis.

If you want to just use the cell detection part of cellfinder, please see the standalone cellfinder-core package, or the cellfinder plugin for napari.

cellfinder is a collection of tools developed by Adam Tyson, Charly Rousseau and Christian Niedworok in the Margrie Lab, generously supported by the Sainsbury Wellcome Centre.

cellfinder is a designed for the analysis of whole-brain imaging data such as serial-section imaging and lightsheet imaging in cleared tissue. The aim is to provide a single solution for:

  • Cell detection (initial cell candidate detection and refinement using deep learning) (using cellfinder-core),
  • Atlas registration (using brainreg),
  • Analysis of cell positions in a common space.

Basic usage:

cellfinder -s signal_images -b background_images -o output_dir --metadata metadata

Full documentation can be found here.

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

brainglobe-workflows-1.0.0.tar.gz (32.0 kB view details)

Uploaded Source

Built Distribution

brainglobe_workflows-1.0.0-py3-none-any.whl (33.4 kB view details)

Uploaded Python 3

File details

Details for the file brainglobe-workflows-1.0.0.tar.gz.

File metadata

  • Download URL: brainglobe-workflows-1.0.0.tar.gz
  • Upload date:
  • Size: 32.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.12

File hashes

Hashes for brainglobe-workflows-1.0.0.tar.gz
Algorithm Hash digest
SHA256 3e51d2dba9073cf4a2d4179c20a372688fbbadef5f8d54a15805dec9fa68c671
MD5 320bdcadb3e88a0c01ae840933ef7340
BLAKE2b-256 86ff7475753a7ca5ced322da02ae703996835522e454697fda6be04040de6f3b

See more details on using hashes here.

File details

Details for the file brainglobe_workflows-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for brainglobe_workflows-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8bd660513c8a9a0905a7f17298a9d59f2abd45a4dc5a9957b646e21885169b57
MD5 c60c8f46f04f33267769e7956b43753c
BLAKE2b-256 fd3d3ba19433653c5f8e4e1fefb3453ff6c6fb161c65970589784ad8d493dfc4

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