From XDSwiki
Revision as of 22:32, 6 May 2013 by Kay (talk | contribs) (→‎Frame)
Jump to navigation Jump to search

XDSgui is a GUI (graphical user interface) for XDS that is supposed to help both novice and experienced users. It displays the ASCII and cbf files that XDS writes, and can run useful shell commands with a simple mouse click. The design goal of the program is to enable XDS data processing without the commandline, and to supply additional graphical information.

The main window of XDSgui has the following sub-windows organized as tabs:


stores names of directories which contain files from XDS processing. If none of these is selected, the current directory is used. A new directory may be created. The list of project directories is saved to ~/.xds-gui .


to display existing 2-dimensional data frames, or to start XDS data processing by displaying a raw data frame. In the latter case, the "generate XDS.INP" button runs the generate_XDS.INP script for the raw data frame that is being displayed. The blue circles correspond to the areas of the detector that are within TRUSTED_REGION; the green circles correspond to INCLUDE_RESOLUTION_RANGE, and the red hatched regions correspond to EXCLUDE_RESOLUTION_RANGEs. The locations of the circles are not as accurate as those that XDS uses internally, because a simplified formula is used to calculate the resolution; this e.g. does not take care of detector swingout or otherwise skew geometry. Untrusted areas can be specified by the user, using two (UNTRUSTED_ELLIPSE; UNTRUSTED_RECTANGLE) or four (UNTRUSTED QUADRILATERAL) right mouse clicks. The resulting areas are shown in red, and the keyword/parameter pairs are shown in the XDS.INP tab.


this shows the current XDS.INP file. Coloured items correspond to the circles of the Frame tab. Changes can be made with the simple

editor, and the new version can be saved. A run of xds_par can be started (and killed).




shows INIT.LP








shows INTEGRATE.LP on the left side. During the INTEGRATE step, the temporary files are displayed. On the right side, plots of the

tabular quantities given for each frame, or for each batch of data are shown. For the refined quantities, only the changes are plotted.


shows CORRECT.LP on the left, and plots of tabular quantities on the right. The upper line in the I/sigma plot gives I/sigma(asmptotic).

The three lines in the CHI^2 plot are the Chi^2 values  obtained during scaling, for the ABSORP, MODPIX and DECAY corrections, respectively.


offers possibilities for running short scripts. Several such scripts are pre-defined; the user may create her own scripts. The first item offers to run XDS-viewer for displaying the predicted pattern of reflections for a user-specified frame, together with the frame itself. The other pre-defined scripts run commands that either simplify to save/restore the current data processing files to/from a "save" directory, or to manipulate XDS.INP in several ways, or to run e.g. pointless on the generated XDS_ASCII.HKL file.

If scripts are modified, they are saved to ~/.xds-gui .


the tab is currently non-functional


a simple XDSCONV.INP may be edited by the user, and saved. Upon clicking a button, xdsconv is run and if necessary a MTZ file is produced. XDSCONV.LP may be displayed.


The current version of the program can be downloaded from https://www.dropbox.com/sh/i569reo9ldzkpom/IIRU4Xwesc