MechMicroMan / DefDAP

A python library for correlating EBSD and HRDIC data.

How to install • How To Use • Documentation • Credits • Contributing • License

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

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

Documentation

• For more help, see the online documentation or browse in the /docs directory.

Contributing

• For information about contributing see the guidelines
• Any new functions or changes to arguments should be documented. Details on how to regenerate html documentation is given here.

Credits

The software uses the following open source packages:

• scipy
• numpy
• matplotlib
• scikit-image
• scikit-learn
• networkx
• pandas
• peakutils
• matplotlib_scalebar
• IPython
• jupyter

License

Apache 2.0 license