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

The notebooks are installed with LaueTools. To copy them (with their YAML configuration files, the tutorials notebooks and the scripts) to a folder of your choice:

lauetools-copy -d my_folder          (default folder: ./lauetools_examples)
lauetools-copy-gui                   (choose the folder in a dialog, no terminal needed)
lauetools-copy -d my_folder -w notebooks   (only the quickstart, peaksearch and indexation notebooks)
lauetools-copy -d my_folder --download     (also download the example images from GitHub to my_folder/LaueImages)

Files already present in the folder are not overwritten (option --force to overwrite them). Then start with jupyter lab my_folder/notebooks/quickstart/laue_maps_quickstart.ipynb.

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.17

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

Source distribution (sdist)

Source distribution for lauetools 3.2.17
File	Size	Uploaded
lauetools-3.2.17.tar.gz	13.0 MB	Oct 12, 2026	Details

Built distribution (wheel)

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

Total release size: 19.5 MB

Release files / lauetools-3.2.17.tar.gz

Download URL	lauetools-3.2.17.tar.gz
Size	13.0 MB
Tags	Source
SHA-256 checksum How to use checksums	`8115c403b4958c47f9939a216386b01f22b899f84630278e15bfd96a0e029c14`
BLAKE2b-256 checksum How to use checksums	`ddf46c4f1d343b46db47b9dd8040e4bc8a92f6742d6c6a070db4e480948f10a0`
Upload date	Oct 12, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.15`

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

Download URL	lauetools-3.2.17-py3-none-any.whl
Size	6.5 MB
Tags	Python 3
SHA-256 checksum How to use checksums	`36703086142f2dc716fa3209c8e749fcae4d540331d6268408fdeefe308db483`
BLAKE2b-256 checksum How to use checksums	`feef46b6956c55377f13e7590e513f18eb414b1d61ae6ef26948f8429a722bce`
Upload date	Oct 12, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.15`