Metadata-Version: 2.1
Name: DefDAP
Version: 0.92.3
Summary: A python library for correlating EBSD and HRDIC data.
Home-page: UNKNOWN
Author: Michael D. Atkinson, Rhys Thomas, João Quinta da Fonseca
Author-email: michael.atkinson@manchester.ac.uk
License: Apache 2.0 License
Project-URL: GitHub, https://github.com/MechMicroMan/DefDAP
Project-URL: Documentation, http://mechmicroman.github.io/DefDAP
Description: <p align="center">
          <img src="http://mechmicroman.github.io/DefDAP/_images/logo.png">
        </p>
        
        <h4 align="center">A python library for correlating EBSD and HRDIC data.</h4>
        
        <p align="center">
          <img alt="Release" src="https://img.shields.io/github/v/release/MechMicroMan/DefDAP?include_prereleases">
          <img alt="Python 3.7" src="https://img.shields.io/badge/python-3.7-red">
          <img alt="License" src="https://img.shields.io/github/license/MechMicroMan/DefDAP">
          <a href="https://mybinder.org/v2/gh/MechMicroMan/DefDAP/master?filepath=example_notebook.ipynb">
            <img alt="Binder" src="https://mybinder.org/badge_logo.svg">
          </a>
          <a href="https://zenodo.org/record/3688096">
            <img alt="DOI" src="https://zenodo.org/badge/DOI/10.5281/zenodo.3688096.svg">
          </a>
        </p>
        
        <p align="center">
          <a href="#how-to-install">How to install</a> •
          <a href="#how-to-use">How To Use</a> •
          <a href="#documentation">Documentation</a> •
          <a href="#credits">Credits</a> •
          <a href="#contributing">Contributing</a> •
          <a href="#license">License</a>
        </p>
        
        
        ## How to install
        
        - DefDAP can be installed from PyPI using the command `pip install defdap`
        
        - If you use conda as your package manager (https://www.anaconda.com/), the prerequisite packages that are available from anaconda can be installed using the command `conda install scipy numpy matplotlib scikit-image scikit-learn pandas networkx jupyter ipython` (Anaconda3-2020.02 has been tested)
        
        - For more information, see the [documentation](http://mechmicroman.github.io/DefDAP/installation.html)
        
        ## How to use
        
        - To start the example notebook, use the command `jupyter lab` and click the notebook (.ipynb file)
        
        - Try out the example notebook using the binder link above (Note: change the matplotlib plotting mode to inline, some of the interactive features will not work)
        
        - Here is a video demonstrating the basic functionality of the package: 
        [DefDAP demo](http://www.youtube.com/watch?v=JIbc7F-nFSQ "DefDAP demo")
        
        ## Documentation
        
        - For more help, see the online [documentation](http://mechmicroman.github.io/DefDAP) or browse in the /docs directory.
        
        ## Contributing
        
        - For information about contributing see the [guidelines](http://mechmicroman.github.io/DefDAP/contributing.html)
        - Any new functions or changes to arguments should be documented. Details on how to regenerate html documentation is given [here](/docs/README.md).
        
        ## Credits
        
        The software uses the following open source packages:
        
        - [scipy](http://scipy.org/)
        - [numpy](http://numpy.org/)
        - [matplotlib](http://matplotlib.org/)
        - [scikit-image](http://scikit-image.org/)
        - [scikit-learn](https://scikit-learn.org/stable/)
        - [networkx](https://networkx.github.io/)
        - [pandas](http://pandas.pydata.org)
        - [peakutils](https://peakutils.readthedocs.io/en/latest/)
        - [matplotlib_scalebar](https://pypi.org/project/matplotlib-scalebar/)
        - [IPython](https://ipython.org/)
        - [jupyter](https://jupyter.org/)
        
        ## License
        
        [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0)
        
Keywords: defdap,EBSD,HRDIC,deformation,crystal,correlative analysis
Platform: UNKNOWN
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Framework :: IPython
Classifier: Framework :: Jupyter
Classifier: Framework :: Matplotlib
Requires-Python: >=3.5
Description-Content-Type: text/markdown
Provides-Extra: testing
