Metadata-Version: 2.1
Name: brainglobe
Version: 0.1.0
Summary: Python-based tools for computational neuroanatomy.
Author-email: BrainGlobe <code@adamltyson.com>
License: BSD-3-Clause
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: BSD License
Requires-Python: >=3.8.0
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: napari[all]
Requires-Dist: bg-space (>=0.5.0)
Requires-Dist: cellfinder-core (>=0.3)
Requires-Dist: imio
Requires-Dist: bg-atlasapi (>=1.0.0)
Requires-Dist: brainglobe-napari-io
Requires-Dist: cellfinder-napari
Requires-Dist: brainreg-segment (>=0.0.2)
Requires-Dist: brainreg
Requires-Dist: brainreg-napari
Provides-Extra: cellfinder
Requires-Dist: cellfinder ; extra == 'cellfinder'
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'
Provides-Extra: morphapi
Requires-Dist: morphapi (>=0.1.3.0) ; extra == 'morphapi'

[![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

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

---

## Installation

The `brainglobe` package can be installed from [PyPI](https://pypi.org/project/brainglobe/) into a Python environment by running
```sh
pip install brainglobe
```

If you want to install the additional packages `morphapi` and `cellfinder`, you can specify them as optional dependencies:
```sh
pip install brainglobe[morphapi] # Include morphapi
pip install brainglobe[cellfinder] # Include cellfinder
pip install brainglobe[morphapi,cellfinder] # Include both morphapi and cellfinder
```

Alternatively, you can download the source from [PyPI here](https://pypi.org/project/brainglobe/#files).

## 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).
