LaueTools 3.0.0.23

Distribution of LaueTools Package from gitlab.esrf.fr repository for pip

Welcome to LaueTools's DOCUMENTATION!

1- Download LaueTools code

---

• the very last version of the code at gitlab.esrf.fr (you are also welcome to fork this project):

  https://gitlab.esrf.fr/micha/lauetools

• last (or older releases) with repository on pypi

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

  if pip is installed:

  .. code-block:: python

   pip install lauetools 
  

2a- Launch Graphical User Interfaces of LaueTools

---

• start Lauetools GUIs from command line :

To deal with relative import, the package name ‘LaueTools’ must be specified to the python interpreter as following

Examples:

- python -m LaueTools.LaueToolsGUI

- python -m LaueTools.LaueSimulatorGUI

- python -m LaueTools.PeaksearchGUI

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

In jupyter-notebook, it is also simple in the same manner:

.. image:: Images/notebook0.jpg

2c- LaueTools Documentation

---

Documentation can be generated, by installing sphinx and a cool html theme:

.. code-block:: python

   pip install sphinx

       pip install sphinx-rtd-theme

Then from /LaueTools/Documentation folder which contain Makefile and 2 folders build and source, build the documentation

.. code-block:: shell

   make html

Files in html format can be browsed in /build/html folder. You can start with index.html.