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
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: 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
PeakSearch_Multiprocessing.ipynb: Peak search and write .dat and .cor files.
Indexing_Multiprocessing.ipynb: Index Laue pattern (find UB and refine lattice parameters or strain) and write .fit file.

Metadata

Release files for lauetools 3.2.13

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for lauetools 3.2.13
File	Interpreter	ABI	Platform	Reset
lauetools-3.2.13-py3-none-any.whl 7.9 MB Oct 5, 2026	Python 3	none	any	Details

Release files / lauetools-3.2.13-py3-none-any.whl

Download URL	lauetools-3.2.13-py3-none-any.whl
Size	7.9 MB
Tags	Python 3
SHA-256 checksum How to use checksums	`12c759c35790b89bdbfa27dabf4db1ef2775d44505563035753b43bcf2286fdc`
BLAKE2b-256 checksum How to use checksums	`e09581c90622ca85ebe33805ca1685574600556b61d5a7fceb40bb821d7c6693`
Upload date	Oct 5, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.14`