========
DXchange
========

`DXchange <https://github.com/data-exchange/DXchange>`_ provides an interface with
`TomoPy <http://tomopy.readthedocs.org/>`_ :cite:`Gursoy:14b` and raw tomographic
data collected at different synchrotron facilities including the Data Exchange
file format (`DXfile <http://dxfile.readthedocs.org/>`_) :cite:`DeCarlo:14a`,
currently in use at the Advanced Photon Source beamline 2-BM and 32-ID,
at the Swiss Light Source Tomcat beamline and at the Elettra SYRMEP beamline :cite:`Elettra:01`.

.. warning:: DXchange will drop support for Python 2 before 1 January 2020. For more information, visit https://python3statement.org/.

Features
--------

* Scientific Data Exchange file format.
* Readers for tomographic data files collected at different facilities.
* Writers for different file formats.

Highlights
----------
* Based on Hierarchical Data Format 5 (HDF5).
* Focuses on technique rather than instrument descriptions.
* Provenance tracking for understanding analysis steps and results.
* Ease of readability.

Contribute
----------

* Documentation: https://github.com/data-exchange/dxchange/tree/master/doc
* Issue Tracker: https://github.com/data-exchange/dxchange/issues
* Source Code: https://github.com/data-exchange/dxchange

.. toctree::
   :hidden:
   :maxdepth: 1

   source/install
   source/api
   source/demo
   source/credits
