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):
-
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 featuresWithout 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
.datand.corfiles. -
Indexing_Multiprocessing.ipynb: Index Laue pattern (find UB and refine lattice parameters or strain) and write
.fitfile.
1 maintainer
Metadata
1 maintainer
Release files for lauetools 3.2.14
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| lauetools-3.2.14.tar.gz | 15.4 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| lauetools-3.2.14-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 24.2 MB
Release files / lauetools-3.2.14.tar.gz
| Download URL | lauetools-3.2.14.tar.gz |
|---|---|
| Size | 15.4 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3dc5b9b3243e6f7d073973756bc4778ea6fa8e5345a54c895d8ee8548aeaacf6
|
|
BLAKE2b-256 checksum How to use checksums |
a7937f86e99ef89e72ae75b2b48bde78e1ae6e255098d3a2503886f232490a9a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.14
|
Release files / lauetools-3.2.14-py3-none-any.whl
| Download URL | lauetools-3.2.14-py3-none-any.whl |
|---|---|
| Size | 8.8 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c08d9506791ecd0c2d0fca1bd7b7dec006b46fd06935fecec65591cea76b6135
|
|
BLAKE2b-256 checksum How to use checksums |
a028a9839ce92eca2c493f3fa7f643879af74769ebcb32e253c547184a01f006
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.14
|
