Metadata-Version: 2.4
Name: lauetools
Version: 3.2.12
Summary: Distribution of LaueTools Package from github.com/BM32ESRF/Lauetools repository for pip
Author-email: J S Micha <micha@esrf.fr>
License: MIT
Project-URL: Homepage, https://github.com/BM32ESRF/lauetools
Requires-Python: <3.13,>=3.8
Description-Content-Type: text/markdown
Requires-Dist: docutils>=0.3
Requires-Dist: numpy>=1.0.3
Requires-Dist: scipy>=0.15.0
Requires-Dist: matplotlib>=2.0.0
Requires-Dist: wxpython>=3.0
Requires-Dist: networkx>=2.1
Requires-Dist: tqdm>=4.60.0
Requires-Dist: h5py>=3.1
Requires-Dist: scikit-image>=0.1.0
Requires-Dist: astropy>=3.0
Requires-Dist: fabio>=0.11.0
Requires-Dist: PyYAML>=6.0.1
Requires-Dist: ObjectListView2
Provides-Extra: daxm
Requires-Dist: numba; extra == "daxm"
Requires-Dist: photutils; extra == "daxm"
Requires-Dist: pypubsub; extra == "daxm"
Provides-Extra: hdf5
Requires-Dist: tables; extra == "hdf5"
Provides-Extra: all
Requires-Dist: lauetools[daxm,hdf5]; extra == "all"

[![Lint, test, build, and publish (PYPI, CONDA)](https://github.com/BM32ESRF/lauetools/actions/workflows/complete_workflow.yml/badge.svg)](https://github.com/BM32ESRF/lauetools/actions/workflows/complete_workflow.yml)
[![PyPI](https://img.shields.io/pypi/v/LaueTools)](https://pypi.python.org/pypi/LaueTools/)
[![Conda](https://img.shields.io/conda/v/bm32esrf/lauetools?style=flat-square)](https://anaconda.org/bm32esrf/lauetools)


[![PyPI pyversions](https://img.shields.io/pypi/pyversions/LaueTools.svg)](https://pypi.python.org/pypi/LaueTools/)
[![Anaconda-Server Badge](https://anaconda.org/bm32esrf/lauetools/badges/license.svg)](https://anaconda.org/bm32esrf/lauetools)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/BM32ESRF/lauetools/HEAD?urlpath=https%3A%2F%2Fgithub.com%2FBM32ESRF%2Flauetools%2Ftree%2Fmaster%2FLaueTools%2Fnotebooks)

Welcome to LaueTools's DOCUMENTATION!
=====================================

Last revision (Sept. 2026)

LaueTools information on BM32 beamline website:

https://www.esrf.fr/UsersAndScience/Experiments/CRG/BM32/Microdiffraction


1- Download LaueTools code
***************************
- It is highly recommended to create a conda (or pip) environment. See [INSTALL.readme](https://github.com/BM32ESRF/lauetools/raw/master/INSTALL.readme)
- the very last version of the code running with python3 is now on github (you are also welcome to fork this project):

	https://github.com/BM32ESRF/lauetools

- last (or older releases) with repository on pypi

	https://pypi.org/project/LaueTools/

	if pip is installed:

	   pip install lauetools

- optional features need extra packages, installed by adding their name in brackets:

	   pip install "lauetools[daxm]"   depth-resolved Laue analysis (DAXM, daxmgui): numba, photutils, pypubsub
	   pip install "lauetools[hdf5]"   .hdf5 summary files (buildsummary), EIGER stacked hdf5 images: tables
	   pip install "lauetools[all]"    all optional features

	Without them, LaueTools works normally; only these features are disabled (a message tells which package is missing).



2a- Launch Graphical User Interfaces of LaueTools
*************************************************
- start Lauetools GUIs from command line :

Normally, in a command window (if environment variables are well set) several GUIs can be launched:

	> lauetools   for the main GUI, simulation, complex Laue pattern calibration, teaching the concepts

	> peaksearch  for batch Laue pattern peak search processing
	> indexrefine   for batch Laue pattern indexing and unit cell (strain) refinement
	> buildsummary    to compile all results from indexrefine analysis
	> plotmap    to plot 2D map of structural quantities from file built previously
 
	> plotmeshgui   to plot 2D map from counters values in (spec) logfile

	> daxmgui   for depth-resolved Laue analysis with wire scans (needs: pip install "lauetools[daxm]")


2b- Use LaueTools module as a library
**************************************

With pip installation, LaueTools package will be included to python packages. Therefore any module will be callable as the following:
 
	-In [1] : import LaueTools.readmccd as rmccd

	-In [2] : rmccd.readCCDimage(‘myimage.tif’)

### Some useful notebooks workflow to treat images dataset

- **[PixelMonitoring.ipynb](https://github.com/BM32ESRF/lauetools/releases/download/3.2.10-pixelmonitoring/PixelMonitoring_polycrystalsMgO_Sept2026.ipynb)**:
  Mosaic plot (map of 2D ROI centered on user-defined Laue spot) and GrainImaging plots (maps of scattering signal derived from ROI quantities).
  [PixelMonitoring.html](https://github.com/BM32ESRF/lauetools/releases/download/3.2.10-pixelmonitoring/PixelMonitoring_polycrystalsMgO_Sept2026.html)

- **[PeakSearch_Multiprocessing.ipynb](https://github.com/BM32ESRF/lauetools/releases/download/3.2.10-data/PeakSearch_MultiProcessing.ipynb)**:
  Peak search and write `.dat` and `.cor` files.

- **[Indexing_Multiprocessing.ipynb](https://github.com/BM32ESRF/lauetools/releases/download/3.2.10-data/Indexation_MultiProcessing_april2025.ipynb)**:
  Index Laue pattern (find UB and refine lattice parameters or strain) and write `.fit` file.



