Metadata-Version: 2.1
Name: zrhappy
Version: 0.1
Summary: A python library to analyse hydride morphology present in light optical and scanning electron micrographs.
Home-page: UNKNOWN
Author: Mia Maric, Rhys Thomas, Michael D. Atkinson, Pratheek Shanthraj,Juan Nunez-Iglesias,Gerard Capes 
Author-email: mia.maric@manchester.ac.uk
License: UNKNOWN
Project-URL: GitHub, https://github.com/miamaric12/HAPPy
Keywords: micrograph,zirconium,hydride
Platform: UNKNOWN
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Development Status :: 4 - Beta
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
Requires-Dist: scipy
Requires-Dist: numpy
Requires-Dist: matplotlib (>=3.0.0)
Requires-Dist: scikit-image
Requires-Dist: numba
Requires-Dist: skan
Requires-Dist: toolz
Requires-Dist: matplotlib-scalebar
Requires-Dist: networkx
Requires-Dist: jupyter

[![Documentation Status](https://readthedocs.org/projects/radial-hydride-code/badge/?version=latest)](https://radial-hydride-code.readthedocs.io/en/latest/?badge=latest)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/miamaric12/HAPPY/HEAD)
[![PyPI version](https://badge.fury.io/py/RHaP.svg)](https://badge.fury.io/py/RHaP)


# HAPPy (Hydride Analysis Package in Python)

This is a Python package developed to aid in the charactacterisation and quantification of hydrides from micrographs. The main functions of this package are to:
- Determine the Radial Hydride Fraction (RHF)
- Characterise the extent of branching
- Determine the most probable crack path within a micrograph

## **How to install**

- `pip install RHaP==0.2`

## **How to use**

- Enter `jupyter lab` into the anaconda terminal and Jupyter lab will open in your browser.
- Open the example notebook, provided with the folder downloaded earlier.
- Examples of how to use the software are included, as well as an example micrograph.

## **Documentation**

- For more help, browse the documentation in the /docs directory.

## **Credits**

The software uses the following open source packages:

- [jupyter-notebook](http://jupyter.org/)
- [numpy](http://numpy.org/)
- [matplotlib](http://matplotlib.org/)
- [scikit-image](http://scikit-image.org/)
- [scipy](https://scipy.org/scipylib/)
- [numba](https://numba.pydata.org)
- [skan](https://jni.github.io/skan/)
- [networkx](https://networkx.org/)
- [toolz](https://github.com/pytoolz/toolz/)
- [matplotlib-scalebar](https://pypi.org/project/matplotlib-scalebar/)

## **Contacts**

- Miss Mia Maric (mia.maric@manchester.ac.uk)
- Dr Pratheek Shanthraj (pratheek.shanthraj@manchester.ac.uk)
- Dr Rhys Thomas (rhys.thomas@manchester.ac.uk)
- Dr Michael Atkinson (michael.atkinson@manchester.ac.uk)
- Dr Juan Nunez-Iglesias (juan.nunez-iglesias@monash.edu)


