xrdpy: Python package for 2D X-ray diffraction data analysis

AlGaN/AlN HEMT real space XRD	AlGaN/AlN HEMT reciprocal space XRD	AlGaN/AlN HEMT reciprocal space (rescaled) XRD

Reciprocal space XRD with peaks	Reciprocal space XRD maps merging	Reciprocal space (rescaled) XRD merging

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 xrdpy or request new functionality, please get in touch with us or open a pull request. 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

2. Installation from github repository

    git clone https://github.com/XRDmapAnalysis/xrdpy.git
    cd xrdpy
    pip install .  

Or, without cloning

    pip install git+https://github.com/XRDmapAnalysis/xrdpy.git #@specific_branch

3. Installation using pip [* not available yet]

    pip install xrdpy

Usage

Documentation: here

The detailed documentation is available here. Explore the tutorial folder for example tutorials. Below are quick snippets showcasing what you can achieve with xrdpy:

xrdpy package:
    1. general_fns class
        1.1 alloy_parameters_from_binary()
    1. xrd class
        1.1 xrd_read_data()
        1.2 find_composition_strain_4_point()
        1.3 get_full_strain_line()
        1.4 Qxy()
        1.5 Qxy_theor()
        1.6 xrd_plot()
    3. plottings class
        3.1 xrd_plot()
        3.2 save_figure()

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"
  

• Read and cite the following papers (and the appropriate references therein):

Bibliography file: Here is the bibliography file for your convenience.

Version release

Latest release: v0.0.3

Chekout out version release history here for the full list of updates and upgrades.

License

• GNU General Public License v3.0

Upcoming (TBD)

1. Rotation
2. ZB structure
3. Quaternary alloy