Skip to content
Snippets Groups Projects
index.rst 2.85 KiB
Newer Older
Jean Sebastien Micha's avatar
Jean Sebastien Micha committed
Welcome to LaueTools's DOCUMENTATION!
Jean Sebastien Micha's avatar
Jean Sebastien Micha committed
=====================================

Jean Sebastien Micha's avatar
Jean Sebastien Micha committed
Last revision (Sept 2022)
Jean Sebastien Micha's avatar
Jean Sebastien Micha committed
LaueTools information on BM32 beamline website:
Jean Sebastien Micha's avatar
Jean Sebastien Micha committed
https://www.esrf.fr/UsersAndScience/Experiments/CRG/BM32/Microdiffraction

Jean Sebastien Micha's avatar
Jean Sebastien Micha committed
1- Download LaueTools code
***************************

Jean Sebastien Micha's avatar
Jean Sebastien Micha committed
- the very last version of the code running with python3 is now on github (you are also welcome to fork this project):
Jean Sebastien Micha's avatar
Jean Sebastien Micha committed
	https://github.com/BM32ESRF/lauetools
Jean Sebastien Micha's avatar
Jean Sebastien Micha committed

- last (or older releases) with repository on pypi

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

	if pip is installed:

	.. code-block:: python

Jean Sebastien Micha's avatar
Jean Sebastien Micha committed
	   pip install lauetools

- Former LaueTools package written for python 2.7 only (up to June 2019) is no longer maintained and can be found on sourceforge:
	
	https://sourceforge.net/projects/lauetools/version
Jean Sebastien Micha's avatar
Jean Sebastien Micha committed
But it is highly recommended to use python 3 to take benefit from all capabilities
Jean Sebastien Micha's avatar
Jean Sebastien Micha committed

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

Jean Sebastien Micha's avatar
Jean Sebastien Micha committed
Normally, in a command window (if environment variables are well set) 3 main GUIs can be launched:

	> lauetools   for the main GUI
	> peaksearch  for batch Laue pattern peak search processing
	> indexrefine   for batch Laue pattern indexing and unit cell (strain) refinement
Jean Sebastien Micha's avatar
Jean Sebastien Micha committed
	> 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
Jean Sebastien Micha's avatar
Jean Sebastien Micha committed
To deal with relative import, the package name ‘LaueTools’ must be specified to the python interpreter with -m option as following
Jean Sebastien Micha's avatar
Jean Sebastien Micha committed
	if LaueTools is a current subfolder:
Jean Sebastien Micha's avatar
Jean Sebastien Micha committed

	- python -m LaueTools.LaueToolsGUI

Jean Sebastien Micha's avatar
Jean Sebastien Micha committed
	- python -m LaueTools.GUI.LaueSimulatorGUI
Jean Sebastien Micha's avatar
Jean Sebastien Micha committed
	- python -m LaueTools.GUI.PeaksearchGUI
Jean Sebastien Micha's avatar
Jean Sebastien Micha committed

The two last GUIs (LaueSimulatorGUI, PeaksearchGUI) can be accessed by the first main one, LaueToolsGUI

There are additional basic GUIs for batch processing located in FileSeries folder:

	- python -m LaueTools.FileSeries.Peak_Search
	- python -m LaueTools.FileSeries.Index_Refine
	- python -m LaueTools.FileSeries.Build_summary
	- python -m LaueTools.FileSeries.Plot_Maps2

- within interactive python (say, ipython -i), GUI can be started thanks to a start() function:

	- In [1] : import LaueTools.LaueToolsGUI as LTGUI

	- In [2] : LTGUI.start()

.. note::
	in the LaueTools folder :

	- neither > python LaueToolsGUI

	- nor in >ipython -i :  > run LaueToolsGUI  will work…


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’)

Jean Sebastien Micha's avatar
Jean Sebastien Micha committed
In jupyter-notebook, it is also simple in the same manner:

	.. image:: /images/notebook0.jpg