Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

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

Project description

Welcome to LaueTools's DOCUMENTATION!

1- Download LaueTools code


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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for LaueTools, version 3.0.0.23
Filename, size File type Python version Upload date Hashes
Filename, size LaueTools-3.0.0.23-py3-none-any.whl (13.0 MB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size LaueTools-3.0.0.23.tar.gz (12.8 MB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page