.. dicomselect documentation master file, created by
   sphinx-quickstart on Thu Feb 15 10:29:28 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to **dicomselect**'s documentation!
===========================================

**dicomselect** is a Python tool that simplifies the process of creating `SQLite`_ databases from directories containing `.dcm` files or from `.zip` archives containing `.dcm` files at the root of the zip file. Once the database is created, you can easily perform SQL-like queries on the data directly within Python.

Additionally, **dicomselect** allows you to convert query results into various file formats supported by `SimpleITK`_, providing flexibility in working with your DICOM data.

Installation
------------

**Python 3.10 or higher.** You can install this project using `pip`. If you haven't already, it's recommended to create a virtual environment to isolate project dependencies.

.. code-block:: console

    pip install dicomselect

`GitHub ↗`_
--------------------

Contents
--------

.. _GitHub ↗: https://github.com/DIAGNijmegen/dicomselect
.. _SQLite: https://www.sqlite.org/
.. _SimpleITK: https://simpleitk.org/

.. toctree::
   :maxdepth: 2

   started
   database
   query
   convert
   tags