Metadata-Version: 2.1
Name: crystalmapping
Version: 0.2.0
Summary: A python package to do crystal mapping.
Home-page: https://github.com/st3107/crystalmapping
Author: Songsheng Tao
Author-email: st3107@columbia.edu
License: BSD (3-clause)
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.6
License-File: LICENSE
License-File: AUTHORS.rst

==============
crystalmapping
==============

Obtain the distribution of grains inside a crystal from a series of diffraction images using automated peak
tracking.

* Free software: 3-clause BSD license
* Documentation: https://st3107.github.io/crystalmapping.


Install
=======

Run the bash script in a `bash` shell.

``bash install.sh``

It will start an interactive session for the installation.


Update
======

Run the following commands to update.

``bash update.sh <the name of the conda environment>``


Examples
========

The example of usage will be released to the public after the publication of the paper.


