.. image:: _static/bids_atlas_logo.png
   :align: center
   :width: 400px

.. centered:: A small python package to access publicly available brain atlases in a `BIDS <https://bids.neuroimaging.io/>`_-Atlas compliant manner.



.. image:: https://github.com/PeerHerholz/bids_atlas/actions/workflows/docs.yml/badge.svg
        :target: https://github.com/PeerHerholz/bids_atlas/actions/workflows/docs.yml


.. image:: https://img.shields.io/pypi/v/bids_atlas.svg
        :target: https://pypi.python.org/pypi/bids_atlas

.. image:: https://img.shields.io/docker/pulls/peerherholz/bids_atlas
    :alt: Dockerpulls
    :target: https://cloud.docker.com/u/peerherholz/repository/docker/peerherholz/bids_atlas

.. image:: https://img.shields.io/github/repo-size/PeerHerholz/bids_atlas.svg
        :target: https://github.com/PeerHerholz/bids_atlas.zip

.. image:: https://img.shields.io/github/issues/PeerHerholz/bids_atlas.svg
        :target: https://github.com/PeerHerholz/bids_atlas/issues

.. image:: https://img.shields.io/github/issues-pr/PeerHerholz/bids_atlas.svg
        :target: https://github.com/PeerHerholz/bids_atlas/pulls

.. image:: https://img.shields.io/github/license/PeerHerholz/bids_atlas.svg
        :target: https://github.com/PeerHerholz/bids_atlas




|


Introduction
============

``bids_atlas`` aims to provide a set of tools for working with
`BIDS Atlas`, specifically access to commonly used publicly available atlas and their conversion to `BIDS Atlas` compliant files. 

This documentation showcases the respective functionality and provides details concerning
its application and modules.
If you still have questions after going through provided here you can refer to 
the :ref:`api_ref` or ask a question on `GitHub <https://github.com/PeerHerholz/bids_atlas/issues>`_.


Contents
========
.. toctree::
   :maxdepth: 1

   installation
   usage
   atlases
   auto_examples/index
   api_ref
   release-history
   min_versions