diffpy.srxplanar documentation

Software version 1.0.1

Last updated November 16, 2025.

diffpy.srxplanar package provides 2D diffraction image integration using non splitting pixel algorithm. And it can estimate and propagate statistic uncertainty of raw counts and integrated intensity. If you are using this software. If you use this program to do productive scientific research that leads to publication, we kindly ask that you acknowledge use of the program by citing the following paper in your publication:

Xiaohao Yang, Pavol Juhas, Simon J. L. Billinge, On the estimation of statistical uncertainties on powder diffraction and small angle scattering data from 2-D x-ray detectors, arXiv:1309.3614

Authors

diffpy.srxplanar is developed by Xiaohao Yang and Billinge Group members. The maintainer for this project is Simon Billinge. For a detailed list of contributors see https://github.com/diffpy/diffpy.srxplanar/graphs/contributors.

Installation

See the README file included with the distribution.

Acknowledgements

diffpy.srxplanar is built and maintained with scikit-package.

Table of contents

• Package API
  • Submodules
  • diffpy.srxplanar.calculate module
  • diffpy.srxplanar.loadimage module
  • diffpy.srxplanar.mask module
  • diffpy.srxplanar.saveresults module
  • diffpy.srxplanar.srxplanar module
  • diffpy.srxplanar.srxplanarconfig module
  • diffpy.srxplanar.version module
• Modules
  • diffpy Package
• Release notes
  • 1.0.1
  • 1.0.0
• License
  • OPEN SOURCE LICENSE AGREEMENT

Indices

• Index

• Search Page