Automated fitting of XRD peaks using Pseudo-Voight fits
Project description
Installation
To install as a Python module, type
python -m pip install xrdfit
from the root directory. For developers, you should install in linked .egg mode using
python -m pip install -e .
If you are using a Python virtual environment, you should activate this first before using the above commands.
Documentation
Documentation including an API reference is provided at: https://xrdfit.readthedocs.io/en/latest/
The majority of the documentation is provided as example driven interactive Jupyter notebooks. These are included along with the source code in the "tutorial notebooks" folder. If this package was downloaded from pip, the source can be found on GitHub: https://github.com/LightForm-group/xrdfit
Required libraries
This module uses the Python libraries:
- NumPy (https://numpy.org/)
- matplotlib (https://matplotlib.org/)
- pandas (https://pandas.pydata.org/)
- dill (https://pypi.org/project/dill/)
- tqdm (https://tqdm.github.io/)
- SciPy (https://www.scipy.org/)
- lmfit (https://lmfit.github.io/lmfit-py/)
The following libraries are required to use the tutorial documentation workbooks:
- Jupyter (https://jupyter.org/)
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
