Metadata-Version: 2.1
Name: xrdfit
Version: 0.1.1
Summary: Automated fitting of XRD peaks using Pseudo-Voight fits
Home-page: https://github.com/LightForm-group/xrdfit
Author: Peter Crowther
License: UNKNOWN
Description: [![DOI](https://zenodo.org/badge/203145007.svg)](https://zenodo.org/badge/latestdoi/203145007) 
        [![PyPI version](https://badge.fury.io/py/xrdfit.svg)](https://badge.fury.io/py/xrdfit)
        
        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/)
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: documentation_compilation
