Metadata-Version: 2.1
Name: brainglobe-utils
Version: 0.6.1
Summary: Shared general purpose tools for the BrainGlobe project
Author-email: Adam Tyson <code@adamltyson.com>
License: MIT License
        
        Copyright (c) 2020 Adam Tyson
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: homepage, https://brainglobe.info
Project-URL: bug_tracker, https://github.com/brainglobe/brainglobe-utils/issues
Project-URL: source_code, https://github.com/brainglobe/brainglobe-utils
Project-URL: user_support, https://github.com/brainglobe/brainglobe-utils/issues
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: napari
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
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
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: brainglobe-atlasapi>=2.0.1
Requires-Dist: brainglobe-space
Requires-Dist: configobj
Requires-Dist: natsort
Requires-Dist: nibabel>=2.1.0
Requires-Dist: numba
Requires-Dist: numpy
Requires-Dist: dask
Requires-Dist: pandas
Requires-Dist: psutil
Requires-Dist: pyarrow
Requires-Dist: PyYAML
Requires-Dist: scikit-image
Requires-Dist: scipy
Requires-Dist: slurmio
Requires-Dist: tifffile
Requires-Dist: tqdm
Provides-Extra: qt
Requires-Dist: qtpy; extra == "qt"
Requires-Dist: superqt; extra == "qt"
Provides-Extra: napari
Requires-Dist: brainglobe-utils[qt]; extra == "napari"
Requires-Dist: napari[all]; extra == "napari"
Provides-Extra: dev
Requires-Dist: black; extra == "dev"
Requires-Dist: coverage; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: pyqt5; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pytest-qt; extra == "dev"
Requires-Dist: pytest-mock; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: scikit-image; extra == "dev"
Requires-Dist: setuptools_scm; extra == "dev"
Requires-Dist: tox; extra == "dev"
Requires-Dist: pooch; extra == "dev"
Requires-Dist: brainglobe-utils[napari]; extra == "dev"

# brainglobe-utils

Shared general purpose tools for the BrainGlobe project, including [citation generation](#citations-for-brainglobe-tools).

## Installation

```bash
pip install brainglobe-utils
```

To also include the dependencies required for Qt widgets, use:

```bash
pip install brainglobe-utils[qt]
```

For development, clone this repository and install the dependencies with:

```bash
pip install -e .[dev]
```

## Seeking help or contributing
We are always happy to help users of our tools, and welcome any contributions. If you would like to get in contact with us for any reason, please see the [contact page of our website](https://brainglobe.info/contact.html).

## Citations for BrainGlobe tools

`brainglobe-utils` comes with the `cite-brainglobe` command line tool, to write citations for BrainGlobe tools for you so you don't need to worry about fetching the data yourself.
You can read about [how to use the tool](https://brainglobe.info/documentation/brainglobe-utils/citation-module.html) on the documentation website.
