[go: up one dir, main page]
Menu ▾ ▴

Home

MICHA Jean-Sebastien

LaueTools Software

This is a wiki page of LaueTools software

This wiki is currently migrating. In several days, you will find the original wiki after correct syntax translation! Sorry for the inconvenience.

more details in:

Project interactions and feedbacks

A forum dedicated to white microdiffraction (experimental, theory and data analysis) is now opened in the discussion tab of the website

Developers and users!

You are kindly invited to report any issues/bugs/troubles or new functionnality needs at LaueTools trouble tickets.

For those motivated in joining this project, you must create first an account on sourceforge.net and then send me an email at micha 'at' esrf 'dot' fr to grant some developer rights.

Installation Procedures

1- install python and its modules
(version 2.6 or later) if it is not already installed on your computer. I am developing in python 2.7.2

linux: python is usually already included in the main linux distributions

windows: I like the python distribution for academic research purpose from enthought. This EPD distribution called canopy (also available for linux). You may have to register and download a . msi installer.

On both platforms, I like today anaconda distribution (with python 2.7 not 3.0!)

You can find some tips to install LaueTools on Windows (in French) : [Installation de LaueTools sous Windows]

http://www.enthought.com/products/edudownload.php. There will be a lot of up to date modules that lauetools depends on.

2- install the useful modules
numpy, scipy (for array manipulation and scientific tools), matplotlib (for graph plot), wxpython (for graphical user interface), networkwx (for graph theory tools), PIL (for image processing)

windows: EPD distribution have them inside otherwise download at www.scipy.org or separately at

https://sourceforge.net/projects/scipy/files/

https://sourceforge.net/projects/numpy/files/

https://sourceforge.net/projects/matplotlib/files/

linux: download via your package manager (after having searched numpy, scipy, matplotlib, wxpython, networkx, PIL) or in the just above-mentionned links download the rpm files

A test to check if the modules are already installed : launch python and try : import numpy (or matplotlib, or scipy). With EPD, you can check and downgrade if necessary some modules.

Currently LaueTools is perfectly running with:

  • wx.version

'3.0.2'

  • scipy.version

'0.17.0'

  • matplotlib.version

'1.5.1'

  • networkx.version

'1.11'

  • numpy.version

'1.11.0'

3- Download the LaueTools package

in your local folder (called for example MyLaueTools here)

two possibilities :

3.0 Download the zip release

In this case you may lack the very very last to date functions

3.1 : from a compressed archive

to download a ""frozen"" (snapshot) version of the code :

http://sourceforge.net/projects/lauetools/files/?source=navbar

3.2 : (better) use the version-control-software subversion

Installing svn simplifies code upgrades : the command :

svn up

will automatically update your version to the latest version of Lauetools available on sourceforge (all files !)

examples :

svn log -v -r 434

shows the messages associated to revision 434.

svn up -r1170

brings your local code back to revision 1170.

Installing subversion or svn

  • linux : svn is usually already included in the main linux distributions

  • windows : try :

http://tortoisesvn.net/downloads.html (""menu + mouse"" user-interface)

https://sourceforge.net/projects/win32svn/ (command lines in a shell)

  • all operating systems : try :

http://subversion.tigris.org/ go to ""featured projects"" in vertical menu at left (tortoiseSVN, Qsvn, kdesvn, RapidSVN...)

http://subversion.apache.org/packages.html#windows

First time use of svn

  • to ""check out"" the latest version :

Open a dos command window (cmd.exe) or a linux terminal, create a directory MyLaueTools, and to ""check out"" only the ""living"" parts of lauetools codes (located in the \trunk folder) type:

svn co https://svn.code.sf.net/p/lauetools/code/trunk MyLaueTools

For users already using SVN with the old repository, and wanting to move to the new repository :

see : https://sourceforge.net/p/forge/community-docs/Repository%20Upgrade%20FAQ/

4- DEPENDENCIES:

You may encounter some module imports issues (raised as ""ImportError"") when modules are not found or basically not installed. Additional packages may be copied in MyLaueTools if installing them in ""lib"" folder of python failed :

website : https://pypi.python.org/pypi/ObjectListView

Zip-file: http://objectlistview.sourceforge.net/samples/ObjectListView-1.2.zip

How to launch Python or use lauetools' GUI and scripts

many possibilities:

1 : click on file explorer for module without argument

2 : in dos command window or unix termial (console): > python A_Lauetools_Module.py [optionaly arguments] (see usage)

3 : Use an Integrated Development Editor (IDE) to run the python script from it: Spyder, Eclipse (with Pydev plugin), KDE dev.
For the IDE called ""idle"" on windows (supplied by Enthought distribution), you may experience troubles with indentation. You may need then to select all text of the code (ctrl+A) and then in the menu Format/Untabify with 8 spaces

User's Manuals

A [LaueTools Documentation] describing very the Laue pattern data analysis but with an old graphical interfaca

A more recent documentation can be read by browsing index.html file with your favorite web navigator (firefox, netscape ...): [[LaueToolsDoc.zip]]

[Depth Resolved Laue Diffraction - Wire Technique]

Packages

Three packages are interactive with a Graphical User Interface :

  • LaueToolsGUI.py : Polycrystal Laue Patterns indexation, refinement, simulation.

  • PeakSearchGUI.py : Images DataSet Navigator and Peaks Finder, DataSet Monitoring

  • Peak_Search.py and Index_Refine.py in folder FileSeries : Batch Analysis of set of images.

Publications

Slides from GdR MECANO workshops

Screenshots

[[File:screenshot_lauetool24.png|200px|thumb|left|LaueToolsGUI.py : peak search , indexation , strain / geometry refinement, pattern simulation]]

[[File:screenshot_laue3D.png|200px|thumb|left|laue3D.py : 3D Laue Patterns rotations and deformation simulation + raw orientation matrix finding (indexation) ]]

[[File:screenshot_Mapcanvas.png|200px|thumb|left|Mapcanvas.py : Navigation along 2D sample scan image data set and peak fitting]]

Issues with Lauetools

You may experience troubles with Lauetools. Some known issues are in [LaueToolsIssues].

More info

A few hints on using the XMAS software : [XMAS hints]

Installing LaueTools on Windows (in French) : [Installation de LaueTools sous Windows]

Tutorial : calibrating the experimental geometry with a Ge(111) single crystal : [http://www.esrf.fr/UsersAndScience/Experiments/CRG/BM32/2013_04_22_resume_analyse_Ge_Mar13.pdf]"

Help for wiki

Consult the [http://meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software.
EPD
Getting started

Click on the following image to upload a new version of the PNG logo image for your project:

[[Image:MediaWikiSidebarLogo.png]]

Welcome to your wiki!

This is the default page, edit it as you see fit. To add a new page simply reference it within brackets, e.g.: [SamplePage].

The wiki uses Markdown syntax.

Project Members:

Related

LaueToolsWiki: Installation de LaueTools sous Windows
LaueToolsWiki: LaueTools Documentation
LaueToolsWiki: LaueToolsIssues