Development
===========

Information regarding project development.

.. toctree::
    :maxdepth: 1

    api.rst


Test datasets
'''''''''''''

A set of datasets is available at `/data/scisoft/darfix/datasets`

It contains:

* HDF5 / bliss datasets (*bliss_hdf5* folder)
    * *Silicon_111_reflection_0003*: *chi*, *mu* evolving.
        .. note:: for this dataset you must modify the tolerance to 10e-5 to have a correct fitting of the dimensions

* spec / EDF datasets (*spec_edf* folder)
    * *2017_run3_es_binary*
    * *3Dstrainlayer_full*
    * *55min*

* HDF5 'like' datasets (`converted_from_spec_edf_to_hdf5` folder)
those datasets has been converted from the spec / EDF datasets to HDF5 using the `convert_to_hdf5.py` script.
They were originally created to get HDF5 like dataset before the beamline fully moved to bliss-hdf5

* spec / EDF datasets (`2017_run3_es_binary`, `3Dstrainlayer_full`, `55min`)
* HDF5 'like' datasets (converted from the EDF/spec) (`3Dstrainlayer_full.hdf5` converted using `convert_to_hdf5.py`)

Deployment
''''''''''

Deployment is done with `darfix apptainer <https://gitlab.esrf.fr/apptainer/darfix>`_
See details in `README.md <https://gitlab.esrf.fr/apptainer/darfix/-/blob/main/README.md>`_