Skip to content

Shared general purpose tools for the BrainGlobe project

License

Notifications You must be signed in to change notification settings

brainglobe/brainglobe-utils

Repository files navigation

brainglobe-utils

Shared general purpose tools for the BrainGlobe project, including citation generation.

Installation

pip install brainglobe-utils

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

pip install brainglobe-utils[qt]

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

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.

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 on the documentation website.