=============
User software
=============

.. |winlogo| image:: _images/windows_logo.png
   :height: 20pt

.. |linuxlogo| image:: _images/linux_logo.png
   :height: 20pt

.. |osxlogo| image:: _images/osx_logo.png
   :height: 20pt


.. _commercial-software-support:

Commercial general purpose tools
================================

Matlab
------

**Supported platforms:** |winlogo| Windows, |linuxlogo| Linux, |osxlogo| OSX

Matlab supports HDF5 since ages. You should be able to access NeXus files
written by DESY beamlines with every Matlab version larger 2015a (at this point
they started to include HDF5 1.8.11 in their software distribution).

* `Matlab Website`_
* `Matlab HDF5 documentation`_

.. _Matlab Website: https://de.mathworks.com/products/matlab.html

.. _Matlab HDF5 documentation: https://de.mathworks.com/help/matlab/hdf5-files.html?searchHighlight=HDF5&s_tid=doc_srchtitle


IDL
---

**Supported platforms:** |winlogo| Windows, |linuxlogo| Linux, |osxlogo| OSX 


As Matlab, IDL has quite a long history of HDF5 support. The minimum IDL
version required to access our files is 8.3.

* `IDL website`_

.. _IDL website: http://www.harrisgeospatial.com/ProductsandSolutions/GeospatialProducts/IDL.aspx


Igor Pro
--------

.. todo:: 
    
    we actually need some user experience with Igor Pro.

.. ===========================================================================
   Open source software supporting HDF5 and NeXus
   ===========================================================================

.. _open-source-software:

Open source tools
=================

..  ===========================================================================

PyMCA
-----

**Supported platforms:** |winlogo| Windows, |linuxlogo| Linux, |osxlogo| OSX

*PyMCA* is a Python program developed at the ESRF which provides native
support for HDF5. 

* `PyMCA Website`_

.. _PyMCA Website: http://pymca.sourceforge.net/

..  ===========================================================================

.. _dawn:

Dawn
----

**Supported platforms:** |winlogo| Windows, |linuxlogo| Linux, |osxlogo| OSX

*DAWN* is a Java and Eclipse based data analysis environment developed at the
Diamond Lightsource near Oxford. The software can definitely handle HDF5 files
and provides limited support for NeXus semantics.

* `DAWN website`_

.. _DAWN website: http://dawnsci.org/

..  ===========================================================================

.. _pni-tools:

PNI Tools
---------

**Supported platforms:** |linuxlogo| Linux, |winlogo| Windows

A set of command line tools developed at DESY particularly tailored to work
with NeXus/HDF5 files. These tools explicitly support and make use of the
sematics of different NeXus objects.

* `PNI tools github site`_

.. _PNI tools github site: https://github.com/eugenwintersberger/pnitools

..  ===========================================================================

.. _nexus-image-tools:

NeXus Image Tools
-----------------

**Supported platforms:** |linuxlogo| Linux, |winlogo| Windows

Command line and GUI tools developed at DESY to convert NeXus image blocks into
a stack of individual files and vice versa. 

* `Stash code repository`_
* `Online documentation`_ 

.. _Stash code repository: https://stash.desy.de/projects/EW/repos/nexus-image-tools/browse
.. _Online documentation: http://hasyweb.desy.de/services/computing/nexus/nexus-image-tools/

..  ===========================================================================

.. _hdf5-lz4-filter:

HDF5 LZ4 filter plugin
----------------------

**Supported platforms:** |linuxlogo| Linux, |winlogo| Windows

The Eiger detector users a custom LZ4 filter to compress the data fields with 
image data. In order to access these files with commercial software packages
(provided that they support HDF5 and use a library version larger than 1.8.12) 
this package must be installed.

* `External filter installation instructions`_


.. _External filter installation instructions: http://hasyweb.desy.de/services/computing/nexus/hdf5-external-filters/