
=====================
pydicom documentation
=====================

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Getting started

   tutorials/installation

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Documentation

   guides/user/index
   tutorials/index
   guides/index
   reference/index

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Examples

   auto_examples/index

.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: Additional Information

   tutorials/contributing
   faq/index
   release_notes/index


Getting Started
===============
If you're new to *pydicom* then start here:

* :doc:`Installation<tutorials/installation>` |
  :doc:`Plugins for Pixel Data</guides/plugin_table>` |
  :doc:`What Python types do I use for each VR<guides/element_value_types>`
* **Basics**: :doc:`Dataset: read, access, modify, write</tutorials/dataset_basics>`
* **Intermediate**:
  :doc:`Waveform decoding and encoding</tutorials/waveforms>` |
  :doc:`DICOM File-sets and DICOMDIR</tutorials/filesets>`
* **Pixel Data**:
  :doc:`Introduction & accessing</tutorials/pixel_data/introduction>` |
  :doc:`Creating new Pixel Data</tutorials/pixel_data/creation>` |
  :doc:`Compression and decompression</tutorials/pixel_data/compressing>`


:doc:`User Guide <guides/user/index>`
==========================================

The main documentation. This contains an in-depth description of all
core elements of *pydicom* and how to use them.


:doc:`Examples <auto_examples/index>`
=====================================

A set of examples illustrating the use of the different core elements. It
complements the :doc:`User Guide <guides/user/index>`.


:doc:`API Reference <reference/index>`
======================================

The API Reference provides technical documentation for the *pydicom* API's
functions, variables and classes.
