rings_logo

pydidas#

pyDIDAS (python DIffraction Data Analysis Suite) is a toolset developed at Helmholtz-Zentrum Hereon to improve the ease of use and efficiency of diffraction data analysis. A key requirement is to create a graphical user interface of the software and processing which scales with available resources to allow running pyDIDAS on a wide range of machines from a small laptop up to a central cluster at the facility level.

Quickstart

Using pydidas for the first time? For questions about how to run pydidas and how to get started with the software, please refer to the pydidas quickstart guide.

Pydidas quick-start guide
Installation

For information on how to install pydidas, please refer to the README file.

https://github.com/hereon-GEMS/pydidas/tree/master?tab=readme-ov-file#readme
Graphical user interface

For an introduction on how to use pydidas, please refer to the manual for the graphical user interface.

Graphical user interface
Full manuals

For detailed information on how to use pydidas, please refer to the complete list of manuals. This documentation also includes command-line usage.

User manuals
Code Documentation

For detailed information on the code structure and API, please refer to the code documentation.

Code documentation
Developer Guide

For information on how to contribute to pydidas, please refer to the developer guide.

Developer guide

Introduction#

Two main use cases have been considered:

  1. Fast (quasi-live) analysis of diffraction data during beamtimes.

  2. Supply users with an easy-to-use software solution which can also be used by users offline and offsite with no/minimal supervision from beamline staff.

The rational behind these two use cases are

  • Fast analysis of diffraction data can improve beamtime efficiency, for example in optimizing in situ / operando conditions

  • Give beamline staff software tools which facilitate user support during experiments.

  • Give users a software tool which allows them to work with their data more independantly of beamline staff support.

  • Support users with managing and automatically analyzing ever growing datasets.

Acknowledgements

The pyDIDAS project is funded by Helmholtz-Zentrum Hereon.

The pyDIDAS software uses widgets and tools from the pyFAI and silx projects at the ESRF. The azimuthal integration routines are also taken from the pyFAI distribution.

Index#