.. bio-volumentations documentation master file, created by sphinx-quickstart 2025.

Welcome to Bio-Volumentations' documentation!
==============================================

`Bio-Volumentations` is an image augmentation and preprocessing package for 3D, 4D, and 5D biomedical images.

The library offers a wide range of efficiently implemented transforms for multidimensional images with annotations, an easy-to-use API,
and this neat Getting Started guide. The library can be used to manipulate your image data in any context
and with any major deep learning library.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   intro
   examples
   modules
   contributions

The source codes and more details are also available
`at the project's GitLab page <https://gitlab.fi.muni.cz/cbia/bio-volumentations/-/tree/1.3.2?ref_type=tags>`_,
code release is available from the project's
`GitHub <https://github.com/xluciadh/bio-volumentations/releases>`_
and from `PyPI <https://pypi.org/project/bio-volumentations/>`_.

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`