Cheat sheet: Difference between revisions
m improving |
m smaller font in right column |
||
| Line 17: | Line 17: | ||
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. | |<small>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.</small> | ||
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). | <small>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).</small> | ||
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> | <small>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></small> | ||
|- | |- | ||
|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! | |<small>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!</small> | ||
|- | |- | ||
|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. | |<small>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.</small> | ||
|- | |- | ||
|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> . | |<small>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> .</small> | ||
|- | |- | ||
|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. JOB=XYCORR INIT COLSPOT IDXREF DEFPIX INTEGRATE CORRECT is only needed at the beginning i.e. for the first run. | |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. JOB=XYCORR INIT COLSPOT IDXREF DEFPIX INTEGRATE CORRECT is only needed at the beginning i.e. for the first run. | ||
|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> ! | |<small>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> !</small> | ||
|- | |- | ||
|6. run XDS | |6. run XDS | ||
click <code>Save</code> (unless greyed out) and <code>Run XDS</code> . The tasks of the JOB keyword 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. The goal is to make sure that spacegroup and resolution are correct or at least reasonable, and that the processing is optimal. | click <code>Save</code> (unless greyed out) and <code>Run XDS</code> . The tasks of the JOB keyword 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. The goal 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>. | |<small>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>.</small> | ||
|- | |- | ||
|7. inspection and analysis of diffraction patterns in the first run of XDS | |7. inspection and analysis of diffraction patterns in the first run of XDS | ||
| Line 42: | Line 42: | ||
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? | 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]] . | |<small>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]] .</small> | ||
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 all along the "Beam divergence" and "Mosaicity" plots? If not, too few strong reflections were found (inspect the "THREE-DIMENSIONAL PROFILE" output in the text part) and you should add DELPHI=20 in <code>XDS.INP</code>, or increase the parameter if the keyword already exists. | <small>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 all along the "Beam divergence" and "Mosaicity" plots? If not, too few strong reflections were found (inspect the "THREE-DIMENSIONAL PROFILE" output in the text part) and you should add DELPHI=20 in <code>XDS.INP</code>, or increase the parameter if the keyword already exists.</small> | ||
|- | |- | ||
|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). If the spacegroup is unknown, the text part reports the spacegroup that XDS determines automatically. To do better, 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 <code>XDS.INP</code> from the pointless output (unless you know better, of course). Often there are two enantiomorphic spacegroups possible ([[Space group determination#Space group selected by XDS: ambiguous with respect to enantiomorph and screw axes]], [[Space group determination#Table of space groups by Laue class and Bravais type]]) or even more than two; keep that in mind for the structure solution - the correct spacegroup is only found when the structure is solved and well refined. | |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). If the spacegroup is unknown, the text part reports the spacegroup that XDS determines automatically. To do better, 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 <code>XDS.INP</code> from the pointless output (unless you know better, of course). Often there are two enantiomorphic spacegroups possible ([[Space group determination#Space group selected by XDS: ambiguous with respect to enantiomorph and screw axes]], [[Space group determination#Table of space groups by Laue class and Bravais type]]) or even more than two; keep that in mind for the structure solution - the correct spacegroup is only found when the structure is solved and well refined. | ||