graintools

What is it?

graintools is a set of Python tools is aimed at segmenting X-ray diffraction data coming from polycrystalline materials. The data is acquired using the LAUEMAX setup at BM32 of the European Synchrotron Radiation Facility (ESRF).

Installation

Install the test version

python3 -m pip install --index-url https://test.pypi.org/simple/ graintools

Or add it to your PYTHONPAH

git clone https://github.com/serbng/graintools.git

Inside your script or notebook

>>> sys.path.append("path/to/repo/graintools")

Optional extras

Install dependencies necessary to run the notebooks and the simulation:

pip install "graintools[full]"

Get started

Create a virtual environment and activate it. For example

python -m venv ~/graintools
source ~/graintools/bin/activate

Inside the virtual environment

pip install "graintools[full]"

Download and run the notebook:

git clone https://github.com/serbng/graintools.git
jupyter lab graintools/examples/simulation

Contacts

myemail, TBD which one