=====================
pydicom documentation
=====================
.. toctree::
:maxdepth: 2
:hidden:
:caption: Getting started
tutorials/installation
old/getting_started
.. toctree::
:maxdepth: 2
:hidden:
:caption: Documentation
old/pydicom_user_guide
old/ref_guide
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` |
:doc:`Introduction to pydicom` |
:doc:`What Python types do I use for each VR`
* **Basics**: :doc:`Read, access, modify, write`
* **Intermediate**:
:doc:`Compressing Pixel Data ` |
:doc:`Waveform decoding and encoding ` |
:doc:`DICOM File-sets and DICOMDIR`
:doc:`User Guide `
==========================================
The main documentation. This contains an in-depth description of all
core elements of *pydicom* and how to use them.
:doc:`Examples `
=====================================
A set of examples illustrating the use of the different core elements. It
complements the :doc:`User Guide `.
:doc:`API Reference `
======================================
The API Reference provides technical documentation for the *pydicom* API's
functions, variables and classes.