.. dcm-classifier documentation master file, created by
   sphinx-quickstart on Tue Apr 16 12:11:06 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Overview
==========================================

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

Welcome to dcm-classifier’s documentation! This package is a simple tool to classify DICOM files based on their metadata. It is designed to be used in a research context, where the user has a collection of DICOM files and wants to classify them based on their metadata. The package is designed to be simple to use and to provide a simple interface to the user.

Index
=====

* :ref:`genindex`

Installation
==========================================

.. toctree::
   :maxdepth: 2
   :caption: Getting Started

   installation/index

Documentation
==========================================

.. toctree::
   :maxdepth: 2
   :caption: API Reference

   modules