.. int3d08 documentation master file, created by
   sphinx-quickstart on Tue Apr  9 09:56:35 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

User Guide
==========
Int3D is a software package developed at the `Institut Laue Langevin <https://www.ill.eu/fr/>`_ for performing the data reduction for single crystal diffraction in neutron diffractometers with area detectors. It also contains a small module for performing the data reduction for neutron powder diffraction.

Int3D can be easily adapted to any instrument with an area detector. The data collected by the detector is generally read from :code:`hdf5` or :code:`nexus` files, the structure of which varies from instrument to instrument. Creating a routine to correctly read the :code:`hdf5` file is all that is needed to incorporate a new instrument. Int3D is currently able to work with data from different instruments of several neutron sources:

* Institut Laue-Langevin (ILL): `D9 <https://www.ill.eu/users/instruments/instruments-list/d9/description/instrument-layout>`_, `D10 <https://www.ill.eu/users/instruments/instruments-list/d10/description/instrument-layout>`_, `D19 <https://www.ill.eu/users/instruments/instruments-list/d19/description/instrument-layout>`_ and `XtremeD <https://www.ill.eu/users/instruments/instruments-list/xtremed/description/instrument-layout>`_
* Paul Scherrer Institute (PSI): `Zebra <https://www.psi.ch/en/sinq/zebra>`_ and `DMC <https://www.psi.ch/en/sinq/dmc>`_
* Australia's Nuclear Science and Technology Organisation (ANSTO): `Wombat <https://www.ansto.gov.au/our-facilities/australian-centre-for-neutron-scattering/neutron-scattering-instruments/wombat-high>`_

Int3D is a continuation of a work started at the ILL in the 1980s. The authors would like to acknowledge the previous work of R.F.D. Stansfield, M. Thomas, G. McIntyre, C. Wilkinson, S. Mason, M. Turner, M.S. Lehmann, P.J. Brown, A. Barthelemy, and A. Filhol.

This user guide is currently under development.

.. figure:: ./pages/basics/img/logo-ILL.png
    :width: 20 %
    :alt: framework
    :align: center

.. toctree::
   :hidden:
   :numbered:
   :maxdepth: 3
   :caption: Contents:
   :glob:

   ./pages/installation/*
   ./pages/basics/*
   ./pages/visualization/*
   ./pages/rspace/*
   ./pages/single_crystal/*
   ./pages/powder/*
   ./pages/demos/*
   ./pages/contact/*