Cheat sheet: Difference between revisions
m improving |
improving |
||
Line 1: | Line 1: | ||
{| class="wikitable" | {| class="wikitable" | ||
|+ | |+ | ||
!Processing workflow. The links given in the form [[XDSGUI#Frame]] refer to the XDSwiki at | |||
https://wiki.uni-konstanz.de/xds/index.php/ | |||
!The programs must have been properly installed - see [[Installation]]. Troubleshooting hints are at [[Problems]]. | |||
|- | |||
! | |||
! | |||
|- | |||
!Action | !Action | ||
!why? what to look out for? what else to know? | !why? what to look out for? what else to know? | ||
|- | |- | ||
| | | | ||
Line 14: | Line 18: | ||
Type <code>xdsgui</code> and move its window so that you still see the left half of the terminal window. | Type <code>xdsgui</code> and move its window so that you still see the left half of the terminal window. | ||
|Keeping the terminal window to the left of the XDSGUI window makes it possible to see some screen output of XDSGUI, e.g. error messages, or the <code>pointless</code> output. | |Keeping the terminal window to the left of the XDSGUI window makes it possible to see some screen output of XDSGUI, e.g. error messages, or the <code>pointless</code> output. | ||
For HDF5 data from DIAMOND, use <code>export DURIN_PATH= /usr/local/lib64/durin-plugin.so</code>instead (of course with the correct path). The actual path must appear in "Generic frame library" under <code>Preferences</code> | For HDF5 data from DIAMOND, use <code>export DURIN_PATH= /usr/local/lib64/durin-plugin.so</code>instead (of course with the correct path). The actual path must appear in "Generic frame library" under <code>xdsgui / Preferences ../ Paths</code> on macOS, or <code>Menu / Settings / Paths</code> on Linux, and should appear after LIB= in <code>XDS.INP</code> (below). | ||
Optionally, before typing <code>xdsgui</code> : <code>cd</code> to an existing XDS directory, or create a new (empty) directory:<code>cd <toplevel-directory></code>;<code>mkdir <xds-directory>; cd <xds-directory></code> | Optionally, before typing <code>xdsgui</code> : <code>cd</code> to an existing XDS directory, or create a new (empty) directory:<code>cd <toplevel-directory></code>;<code>mkdir <xds-directory>; cd <xds-directory></code> | ||
|- | |- | ||
|2. click the <code>Projects</code> tab and either choose an existing entry (if there is a list of previous projects) or browse to an existing XDS directory, or create a new (empty) directory | |2. click the <code>Projects</code> tab and either choose an existing entry (if there is a list of previous projects) or browse to an existing XDS directory, or create a new (empty) directory | ||
|If XDS's files already exist in the XDS directory, their content is shown in the tabs of XDSGUI. Note that the XDS directory name appears in the title bar of the XDSGUI window! | |If XDS's files already exist in the XDS directory, their content is shown in the tabs of XDSGUI. Note that the XDS directory name appears in the title bar of the XDSGUI window! | ||
|- | |- | ||
|3. click the <code>Frame</code> tab and load a frame of your dataset (for HDF5, load <code>xxx_master.h5</code>). Click <code>generate XDS.INP</code> - this reads the header of that frame, and counts the frames of the dataset. Use <code>Zoom</code>, <code>Contrast</code> and <code>Brightness</code> and move around the frame to evaluate the shape and separation of the reflections: are they smeared or sharp, tiny or broad, regular or broken, symmetric or asymmetric? Look at other frames (selector is at upper right of window) as well! | |3. click the <code>Frame</code> tab and load a frame of your dataset (for HDF5, load <code>xxx_master.h5</code>). Click <code>generate XDS.INP</code> - this reads the header of that frame, and counts the frames of the dataset. Use <code>Zoom</code>, <code>Contrast</code> and <code>Brightness</code> and move around the frame to evaluate the shape and separation of the reflections: are they smeared or sharp, tiny or broad, regular or broken, symmetric or asymmetric? Look at other frames (selector is at upper right of window) as well! | ||
|Watch the green crosshair at ORGX ORGY, the green circle around it (lower INCLUDE_RESOLUTION_RANGE), the red UNTRUSTED_RECTANGLEs at the module borders, and the blue TRUSTED_REGION appear. The corresponding keyword=parameter lines in <code>XDS.INP</code> have the same colour code. | |Watch the green crosshair at ORGX ORGY, the green circle around it (lower INCLUDE_RESOLUTION_RANGE), the red UNTRUSTED_RECTANGLEs at the module borders, and the blue TRUSTED_REGION appear. The corresponding keyword=parameter lines in <code>XDS.INP</code> have the same colour code. | ||
|- | |- | ||
|4. mask the shaded regions of the detector: at least the beamstop shadow, and the beamstop holder. There is a button <code>Untrusted areas (...)</code> towards the upper right with three tools: UNTRUSTED_ELLIPSE, UNTRUSTED_RECTANGLE, UNTRUSTED_QUADRILATERAL | |4. mask the shaded regions of the detector: at least the beamstop shadow, and the beamstop holder. There is a button <code>Untrusted areas (...)</code> towards the upper right with three tools: UNTRUSTED_ELLIPSE, UNTRUSTED_RECTANGLE, UNTRUSTED_QUADRILATERAL | ||
|This step is important, do not forget it! Reason is in the XDSGUI paper (reference at the end). More explanation of the tools is at [[XDSGUI#Frame]] . Wrongly placed UNTRUSTED areas can be removed by deleting their lines in <code>XDS.INP</code> . | |This step is important, do not forget it! Reason is in the XDSGUI paper (reference at the end). More explanation of the tools is at [[XDSGUI#Frame]] . Wrongly placed UNTRUSTED areas can be removed by deleting their lines in <code>XDS.INP</code> . | ||
|- | |- | ||
|5. click the <code>XDS.INP</code> tab and inspect its contents. For a first XDS run, typically you would leave everything at its defaults, except with broad reflections covering many pixels, set MINIMUM_NUMBER_OF_PIXELS_IN_A_SPOT to 6 instead of 3. | |5. click the <code>XDS.INP</code> tab and inspect its contents. For a first XDS run, typically you would leave everything at its defaults, except with broad reflections covering many pixels, set MINIMUM_NUMBER_OF_PIXELS_IN_A_SPOT to 6 instead of 3. In later XDS runs, modify parameters to optimize processing. | ||
| | |The paradigm of manual processing is to repeat INTEGRATE and CORRECT with optimized parameters that are available after a completed XDS run. Please note that geometry parameters for INTEGRATE are in <code>XPARM.XDS</code>, not in <code>XDS.INP</code> ! | ||
|- | |- | ||
|6. click <code>Save</code> (unless greyed out) and <code>Run XDS</code> | |6. run XDS | ||
click <code>Save</code> (unless greyed out) and <code>Run XDS</code> . Ideally, the XYCORR INIT COLSPOT IDXREF DEFPIX INTEGRATE CORRECT tasks are run one after the other. Thus watch the adjacent tabs to the right flash yellow as they are being filled with text and graphics. Inspect the left (text) and right (graphics) sides of these tabs. Once the CORRECT tab is filled, the XDS run has completed, and the reflection file XDS_ASCII.HKL is available. What remains is to make sure that spacegroup and resolution are correct or at least reasonable, and that the processing is optimal. | |||
|If XDS stops after the IDXREF step (with ERROR in IDXREF.LP), this most often happens because it could index less than 50% of the spots only. This may be due to ice rings that obviously cannot be indexed, or due to additional lattices. In most cases, this should at least prompt you to think about the possible reasons. To continue, set JOB=DEFPIX INTEGRATE CORRECT in the XDS.INP tab, <code>Save</code> and <code>Run XDS</code>. | |If XDS stops after the IDXREF step (with ERROR in IDXREF.LP), this most often happens because it could index less than 50% of the spots only. This may be due to ice rings that obviously cannot be indexed, or due to additional lattices. In most cases, this should at least prompt you to think about the possible reasons. To continue, set JOB=DEFPIX INTEGRATE CORRECT in the XDS.INP tab, <code>Save</code> and <code>Run XDS</code>. | ||
|- | |- | ||
|7. | |7. inspection and analysis of diffraction patterns | ||
COLSPOT tab: is the "number of spots" evenly distributed among the frames? If not, it may be a sign of radiation damage or anisotropy, or plate-shaped crystal. Maybe see [https://wiki.uni-konstanz.de/xds/index.php?search=COLSPOT&title=Special%3ASearch&fulltext=1 COLSPOT] | |||
COLSPOT: is the "number of spots" evenly distributed among the frames? If not, it may be a sign of radiation damage or anisotropy, or plate-shaped crystal. [https://wiki.uni-konstanz.de/xds/index.php?search=COLSPOT&title=Special%3ASearch&fulltext=1 COLSPOT] | |||
IDXREF: are the "CLUSTER INDICES" of the difference vectors integer numbers, or close to integers? Are the cell parameters reasonable? Is the first POPULATION of the first SUBTREE close to 3000? See [[IDXREF.LP]] and [[IDXREF]] . | once IDXREF has run, inspect the <code>predictions</code> in <code>Frame</code> . Do they match the observed reflections? Visualize reflections in reciprocal space : in <code>tools</code> go to <code>Further analyses</code> and click the second button from the top. This will load the indexed reflections (yellow) and non-indexed ones (pink) as pseudo-PDB files into <code>Coot</code>. Inspect the lattices: is the "yellow lattice" convincing, and/or do the pink reflections form their own lattice(s), or are they just random? | ||
|IDXREF tab: are the "CLUSTER INDICES" of the difference vectors integer numbers, or close to integers? Are the cell parameters reasonable? Is the first POPULATION of the first SUBTREE close to 3000? Ice rings? See [[IDXREF.LP]] and [[IDXREF]] . | |||
INTEGRATE: are the curves smooth (good) or are there jumps (bad)? Try to think of reasons! Could it be the beamline flux or the crystal changing? Are their straight red and green lines in the "Beam divergence" and "Mosaicity" plots? If not, few strongs reflections were found and you should add DELPHI=20 in XDS.INP, or increase the value if the line already exists. | INTEGRATE tab: are the curves smooth (good) or are there jumps (bad)? Try to think of reasons for jumps/spikes! Could it be the beamline flux or the crystal changing? Are their straight red and green lines in the "Beam divergence" and "Mosaicity" plots? If not, few strongs reflections were found (inspect the "THREE-DIMENSIONAL PROFILE" output in the text part) and you should add DELPHI=20 in XDS.INP, or increase the value if the line already exists. | ||
| | |- | ||
|8. inspect the CORRECT tab: Numerical values and plots are only meaningful if the spacegroup is correct (screw axes don't matter for the statistics, though). In the text part, look at the spacegroup determination to find out what XDS finds. Then, in <code>tools / Further analyses</code> click <code>determine spacegroups with pointless</code>. Output is in the terminal window! Since pointless is more elaborate and more believable (but not infallible), obtain the SPACE_GROUP_NUMBER and UNIT_CELL_CONSTANTS in XDS.INP from the pointless output (unless you know better, of course). Sometimes there are two possibilities, keep that in mind - the correct spacegroup is only clear when the structure is solved. | |||
|The first look goes to the the first plot (I/sigma unmerged data). The red horizontal line is ISa - what is its value? The exact numerical value is in the text part, but the plot is enough for a good estimate. If the value is less than 5, something is severely wrong. Good values are 20 and more. | |||
|- | |||
|9. if the spacegroup that CORRECT determines differs from the one that pointless determined, CORRECT has to be re-run: change the JOB=... line to JOB=CORRECT, and go to step 6. | |||
| | | | ||
|- | |- | ||
| | |9. decide about resolution: go to the section after STATISTICS OF SAVED DATA SET "XDS_ASCII.HKL" and inspect the table SUBSET OF INTENSITY DATA WITH SIGNAL/NOISE >= -3.0 . A useful estimate of the high-resolution limit is the last resolution range that still gets a star "*" in the CC1/2 column. | ||
| | | | ||
|} | |} | ||
The XDSGUI paper (Brehm, Triviño, Krahn, Usón and Diederichs (2023) XDSGUI: a graphical user interface for XDS, SHELX and ARCIMBOLDO. J. Appl. Cryst. 56) is open access at <nowiki>https://doi.org/10.1107/S1600576723007057</nowiki> . | The XDSGUI paper (Brehm, Triviño, Krahn, Usón and Diederichs (2023) XDSGUI: a graphical user interface for XDS, SHELX and ARCIMBOLDO. J. Appl. Cryst. 56) is open access at <nowiki>https://doi.org/10.1107/S1600576723007057</nowiki> . |
Revision as of 20:05, 12 October 2025
Processing workflow. The links given in the form XDSGUI#Frame refer to the XDSwiki at | The programs must have been properly installed - see Installation. Troubleshooting hints are at Problems. |
---|---|
Action | why? what to look out for? what else to know? |
1. open a terminal and move the window to the left side of the screen. If you work with HDF5 data, now type Type |
Keeping the terminal window to the left of the XDSGUI window makes it possible to see some screen output of XDSGUI, e.g. error messages, or the pointless output.
For HDF5 data from DIAMOND, use Optionally, before typing |
2. click the Projects tab and either choose an existing entry (if there is a list of previous projects) or browse to an existing XDS directory, or create a new (empty) directory
|
If XDS's files already exist in the XDS directory, their content is shown in the tabs of XDSGUI. Note that the XDS directory name appears in the title bar of the XDSGUI window! |
3. click the Frame tab and load a frame of your dataset (for HDF5, load xxx_master.h5 ). Click generate XDS.INP - this reads the header of that frame, and counts the frames of the dataset. Use Zoom , Contrast and Brightness and move around the frame to evaluate the shape and separation of the reflections: are they smeared or sharp, tiny or broad, regular or broken, symmetric or asymmetric? Look at other frames (selector is at upper right of window) as well!
|
Watch the green crosshair at ORGX ORGY, the green circle around it (lower INCLUDE_RESOLUTION_RANGE), the red UNTRUSTED_RECTANGLEs at the module borders, and the blue TRUSTED_REGION appear. The corresponding keyword=parameter lines in XDS.INP have the same colour code.
|
4. mask the shaded regions of the detector: at least the beamstop shadow, and the beamstop holder. There is a button Untrusted areas (...) towards the upper right with three tools: UNTRUSTED_ELLIPSE, UNTRUSTED_RECTANGLE, UNTRUSTED_QUADRILATERAL
|
This step is important, do not forget it! Reason is in the XDSGUI paper (reference at the end). More explanation of the tools is at XDSGUI#Frame . Wrongly placed UNTRUSTED areas can be removed by deleting their lines in XDS.INP .
|
5. click the XDS.INP tab and inspect its contents. For a first XDS run, typically you would leave everything at its defaults, except with broad reflections covering many pixels, set MINIMUM_NUMBER_OF_PIXELS_IN_A_SPOT to 6 instead of 3. In later XDS runs, modify parameters to optimize processing.
|
The paradigm of manual processing is to repeat INTEGRATE and CORRECT with optimized parameters that are available after a completed XDS run. Please note that geometry parameters for INTEGRATE are in XPARM.XDS , not in XDS.INP !
|
6. run XDS
click |
If XDS stops after the IDXREF step (with ERROR in IDXREF.LP), this most often happens because it could index less than 50% of the spots only. This may be due to ice rings that obviously cannot be indexed, or due to additional lattices. In most cases, this should at least prompt you to think about the possible reasons. To continue, set JOB=DEFPIX INTEGRATE CORRECT in the XDS.INP tab, Save and Run XDS .
|
7. inspection and analysis of diffraction patterns
COLSPOT tab: is the "number of spots" evenly distributed among the frames? If not, it may be a sign of radiation damage or anisotropy, or plate-shaped crystal. Maybe see COLSPOT once IDXREF has run, inspect the |
IDXREF tab: are the "CLUSTER INDICES" of the difference vectors integer numbers, or close to integers? Are the cell parameters reasonable? Is the first POPULATION of the first SUBTREE close to 3000? Ice rings? See IDXREF.LP and IDXREF .
INTEGRATE tab: are the curves smooth (good) or are there jumps (bad)? Try to think of reasons for jumps/spikes! Could it be the beamline flux or the crystal changing? Are their straight red and green lines in the "Beam divergence" and "Mosaicity" plots? If not, few strongs reflections were found (inspect the "THREE-DIMENSIONAL PROFILE" output in the text part) and you should add DELPHI=20 in XDS.INP, or increase the value if the line already exists. |
8. inspect the CORRECT tab: Numerical values and plots are only meaningful if the spacegroup is correct (screw axes don't matter for the statistics, though). In the text part, look at the spacegroup determination to find out what XDS finds. Then, in tools / Further analyses click determine spacegroups with pointless . Output is in the terminal window! Since pointless is more elaborate and more believable (but not infallible), obtain the SPACE_GROUP_NUMBER and UNIT_CELL_CONSTANTS in XDS.INP from the pointless output (unless you know better, of course). Sometimes there are two possibilities, keep that in mind - the correct spacegroup is only clear when the structure is solved.
|
The first look goes to the the first plot (I/sigma unmerged data). The red horizontal line is ISa - what is its value? The exact numerical value is in the text part, but the plot is enough for a good estimate. If the value is less than 5, something is severely wrong. Good values are 20 and more. |
9. if the spacegroup that CORRECT determines differs from the one that pointless determined, CORRECT has to be re-run: change the JOB=... line to JOB=CORRECT, and go to step 6. | |
9. decide about resolution: go to the section after STATISTICS OF SAVED DATA SET "XDS_ASCII.HKL" and inspect the table SUBSET OF INTENSITY DATA WITH SIGNAL/NOISE >= -3.0 . A useful estimate of the high-resolution limit is the last resolution range that still gets a star "*" in the CC1/2 column. |
The XDSGUI paper (Brehm, Triviño, Krahn, Usón and Diederichs (2023) XDSGUI: a graphical user interface for XDS, SHELX and ARCIMBOLDO. J. Appl. Cryst. 56) is open access at https://doi.org/10.1107/S1600576723007057 .