Metadata-Version: 2.1
Name: brainglobe
Version: 1.2.0
Summary: Python-based tools for computational neuroanatomy.
Author-email: BrainGlobe Developers <hello@brainglobe.info>
License: BSD-3-Clause
Project-URL: homepage, https://brainglobe.info
Project-URL: bug_tracker, https://github.com/brainglobe/brainglobe-meta/issues
Project-URL: documentation, https://docs.brainglobe.info
Project-URL: source_code, https://github.com/brainglobe/brainglobe-meta
Project-URL: user_support, https://forum.image.sc/tag/brainglobe
Project-URL: twitter, https://twitter.com/brain_globe
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: BSD License
Requires-Python: >=3.10.0
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: brainglobe-atlasapi<3,>=2.0.6
Requires-Dist: brainglobe-heatmap<1,>=0.5.3
Requires-Dist: brainglobe-napari-io<1,>=0.3.4
Requires-Dist: brainglobe-segmentation<2,>=1.2.4
Requires-Dist: brainglobe-space<2,>=1.0.2
Requires-Dist: brainglobe-utils<1,>=0.5.0
Requires-Dist: brainreg[napari]<2,>=1.0.9
Requires-Dist: brainrender-napari<1,>=0.0.3
Requires-Dist: brainrender<3,>=2.1.9
Requires-Dist: cellfinder[napari]<2,>=1.3.0
Requires-Dist: napari[all]
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: coverage; extra == "dev"
Requires-Dist: tox; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: setuptools_scm; extra == "dev"

[![PyPI version](https://badge.fury.io/py/brainglobe.svg)](https://badge.fury.io/py/brainglobe)
[![Website](https://img.shields.io/website?up_message=online&url=https%3A%2F%2Fbrainglobe.info)](https://brainglobe.info)
[![Twitter](https://img.shields.io/twitter/follow/brain_globe?style=social)](https://twitter.com/brain_globe)

[![Brainglobe logo](https://brainglobe.info/_static/brainglobe.png)](https://brainglobe.info)

# BrainGlobe

This package provides all [BrainGlobe](https://brainglobe.info) tools in one place, installable [in a single command](#installing-and-updating).
Installing this package will provide you with the complete suite of BrainGlobe tools, without needing to worry about dependency resolution.
A complete list of the tools provided by this package [is provided on our website](https://brainglobe.info/documentation/index.html#individual-tool-documentation), and you can also read more about these tools there too.

If you are interested in running some of our analysis workflows, you might want to head over to [`brainglobe-workflows`](https://github.com/brainglobe/brainglobe-workflows) and install the analysis pipelines offered by that package too.

## Installing and Updating

See the [installation instructions over on the BrainGlobe website](https://brainglobe.info/documentation/index.html#installing-brainglobe) for full information.
But the TLDR is;

```bash
pip install brainglobe
```

and to update,

```bash
pip install brainglobe --update
```

## Contributing

**Contributors to BrainGlobe are absolutely encouraged**, whether to fix a bug, develop a new feature, or add a new atlas.
If you would like to contribute, please take a look at our [developer documentation](https://brainglobe.info/developers/index.html).

---

# The Brainglobe Initiative

The BrainGlobe Initiative exists to facilitate the development of interoperable Python-based tools for computational neuroanatomy.

We have three aims:

- Develop specialist software for specific analysis and visualisation needs, such as [cellfinder](https://github.com/brainglobe/cellfinder) and [brainrender](https://github.com/brainglobe/brainrender).
- Develop core tools to facilitate others to build interoperable tools in Python, e.g. the [BrainGlobe Atlas API](https://github.com/brainglobe/bg-atlasapi).
- Build a community of neuroscientists and developers to share knowledge, build software and engage with the scientific, and open-source community (e.g. by organising hackathons).

## [Funding](https://brainglobe.info/funders.html#funders) Information

The BrainGlobe project is only possible due to grant funding and the generous support of host institutions, whose information [can be found on this website](https://brainglobe.info/funders.html#funders).
