xrdpy: Python package for 2D X-ray diffraction data analysis
 |
 |
 |
|---|---|---|
| Real space map | Reciprocal space map | Detecting RSM peaks (example-1) |
 |
 |
 |
|---|---|---|
| Detecting sensitive RSM peaks (peak detection at low intesity) | Merged RSM maps (including strain calculations) | Aligning RSM maps using $\omega$ rotation (2nd sample is relaxed) |
Developers and contributors
Developer of xrdpy : Badal Mondal, Pietro Pampili
xrdpy Contributors: Contributors
- We sincerely thank each and every contributor for their valuable input and support.
Contact us: Email developer/maintainer team
- If you would like to contribute to the development of
xrdpyor request new functionality, please get in touch with us or open a pull request or discuss here. We appreciate and respect our users' views and are committed to providing the best experience possible. Your feedback is highly valued. We will be happy to support your request ASAP.
Installation
1. Requirements
1. python>=3.12
3. numpy>=1.13
5. scipy>=1.26
7. matplotlib
3. Installation using pip [*recommended]
pip install xrdpy
2. Installation from github repository
git clone https://github.com/XRDmapAnalysis/xrdpy.git
cd xrdpy
pip install .
Or,
pip install git+https://github.com/XRDmapAnalysis/xrdpy.git@specific_branch
Usage
Wiki page: Welcome to xrdpy
Documentation: Package documentation
Discussions: Discuss more about the package here
Tutorials: tutorial
Theoretical details: TBA
Tips and tricks:
FAQs: here
You can find a list of common user issues encountered while using this software here. We appreciate and respect our users' views and are committed to providing the best experience possible. Your feedback is highly valued.
Citations and references:
If you use xrdpy in your work, please:
-
State EXPLICITLY that you have used the xrdpy code (or a modified version of it, if this is the case), for instance, adding a sentence like:
"The XRD analysis is performed using the xrdpy code." -
How to cite the package: (use appropriate version number and doi corresponding to your installed xrdpy)
Badal Mondal and Pietro Pampili, "XRDmapAnalysis/xrdpy: version-V.V.V (vV.V.V))". Zenodo, 2026. doi: XXXXX
- Read and cite the following papers (and the appropriate references therein):
TBA
Bibliography file: Here is the bibliography file for your convenience.
Version release
Chekout out version release history here for the full list of updates and upgrades.
License
Upcoming (TBD)
- ZB structure
- Implement arbritraty 1D line scan capability on 2D RSM plots
- Quaternary alloy
1 maintainer
Metadata
1 maintainer
Release files for xrdpy 0.0.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| xrdpy-0.0.5.tar.gz | 34.6 kB | With provenance | Details for xrdpy-0.0.5.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| xrdpy-0.0.5-py3-none-any.whl | Python 3 | none | any | Details for xrdpy-0.0.5-py3-none-any.whl |
Total release size: 69.6 kB
Release files / xrdpy-0.0.5.tar.gz
| Download URL | xrdpy-0.0.5.tar.gz |
|---|---|
| Size | 34.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
688c6bc14cd107adff4a10de254d81de250f78eba76bc0f2cfd323b164094144
|
|
BLAKE2b-256 checksum How to use checksums |
48548a9fb58172a56b925928cfd0cde30f33f3c3c415dae66a6fefaaa6ffd600
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Feb 5, 2026.
Transparency logRelease files / xrdpy-0.0.5-py3-none-any.whl
| Download URL | xrdpy-0.0.5-py3-none-any.whl |
|---|---|
| Size | 35.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
45f52b98af3d8d81bbd11c990eb9d44adb7d65d75a9f2bfadf2d1ccb3474dd69
|
|
BLAKE2b-256 checksum How to use checksums |
bab86ad6c7aed0de2a9e40bef28a0b83bc01aa44e7618c26c41a4f2ce827c9e9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Feb 5, 2026.
Transparency logSecurity for xrdpy 0.0.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for xrdpy-0.0.5.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Feb 5, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
