-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathparameters.html
261 lines (224 loc) · 16.4 KB
/
parameters.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Parameters — xia2 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=12dfc556" />
<link rel="stylesheet" href="_static/xia2.css" type="text/css" />
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Comments" href="comments.html" />
<link rel="prev" title="Program output" href="program_output.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
</head><body>
<!-- <div class="logoheader container"> -->
<!-- <a href="index.html"> -->
<!-- <img class="logoheader" alt="DIALS" src="_static/dials_header.png" /> -->
<!-- </a> -->
<!-- </div> -->
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="parameters">
<h1>Parameters<a class="headerlink" href="#parameters" title="Link to this heading">¶</a></h1>
<section id="commonly-used-program-options">
<h2>Commonly used program options<a class="headerlink" href="#commonly-used-program-options" title="Link to this heading">¶</a></h2>
<p>There are a number of program options used on a daily basis in xia2, which
are:</p>
<blockquote>
<div><table class="docutils align-default">
<tbody>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">atom=X</span></code></p></td>
<td><p>Tell xia2 to separate anomalous pairs i.e. I(+) <span class="math notranslate nohighlight">\(\neq\)</span> I(−) in scaling.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">pipeline=3d</span></code></p></td>
<td><p>Tell xia2 to use <a class="reference external" href="http://xds.mpimf-heidelberg.mpg.de/">XDS</a> and <a class="reference external" href="http://xds.mpimf-heidelberg.mpg.de/html_doc/xscale_program.html">XSCALE</a>.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">pipeline=3dii</span></code></p></td>
<td><p>Tell xia2 to use <a class="reference external" href="http://xds.mpimf-heidelberg.mpg.de/">XDS</a> and <a class="reference external" href="http://xds.mpimf-heidelberg.mpg.de/html_doc/xscale_program.html">XSCALE</a>, indexing with peaks found from all images.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">pipeline=dials</span></code></p></td>
<td><p>Tell xia2 to use <a class="reference external" href="http://dials.github.io/">DIALS</a>.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">pipeline=dials-aimless</span></code></p></td>
<td><p>Tell xia2 to use <a class="reference external" href="http://dials.github.io/">DIALS</a> but scale with <a class="reference external" href="http://www.ccp4.ac.uk/html/aimless.html">Aimless</a>.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">xinfo=some.xinfo</span></code></p></td>
<td><p>Use specific modified .xinfo input file.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">image=/path/to/an/image.img</span></code></p></td>
<td><p>Process a specific scan. Pass multiple <code class="docutils literal notranslate"><span class="pre">image=</span></code> parameters to include multiple scans.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">image=/path/to/an/image.img:start:end</span></code></p></td>
<td><p>Process a specific image range within a scan. <code class="docutils literal notranslate"><span class="pre">start</span></code> and <code class="docutils literal notranslate"><span class="pre">end</span></code> are numbers denoting the image range, e.g. <code class="docutils literal notranslate"><span class="pre">image=/path/to/an/image.img:1:100</span></code> processes images 1–100 inclusive. As above, one can pass multiple <code class="docutils literal notranslate"><span class="pre">image=</span></code> parameters.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">small_molecule=true</span></code></p></td>
<td><p>Process in manner more suited to small molecule data.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">space_group=sg</span></code></p></td>
<td><p>Set the spacegroup, e.g. <code class="docutils literal notranslate"><span class="pre">P21</span></code>.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">unit_cell=a,b,c,α,β,γ</span></code></p></td>
<td><p>Set the cell constants.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">hdf5_plugin=/path/to/durin.so</span></code></p></td>
<td><p>Set the path to the HDF5 file reading plugin for XDS (needed for processing of Eiger data)</p></td>
</tr>
</tbody>
</table>
</div></blockquote>
</section>
<section id="resolution-limits">
<h2>Resolution limits<a class="headerlink" href="#resolution-limits" title="Link to this heading">¶</a></h2>
<p>xia2 uses <code class="docutils literal notranslate"><span class="pre">dials.estimate_resolution</span></code> to estimate the resolution limit, sharing the
same parameters and defaults.
The default behaviour (<code class="docutils literal notranslate"><span class="pre">cc_half=0.3</span></code>) can be overridden with e.g.:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>xia2<span class="w"> </span><span class="o">[</span>options<span class="o">]</span><span class="w"> </span><span class="nv">cc_half</span><span class="o">=</span>None<span class="w"> </span><span class="nv">misigma</span><span class="o">=</span><span class="m">1</span><span class="w"> </span><span class="nv">isigma</span><span class="o">=</span><span class="m">0</span>.25
</pre></div>
</div>
<p>See the <a class="reference external" href="https://dials.github.io/documentation/programs/dials_estimate_resolution.html">dials.estimate_resolution</a> documentation for further details.</p>
</section>
<section id="phil-parameters">
<h2>Phil parameters<a class="headerlink" href="#phil-parameters" title="Link to this heading">¶</a></h2>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>We have now moved towards moving <a class="reference external" href="http://cctbx.sourceforge.net/libtbx_phil.html">PHIL (Python-based Hierarchial Interchange Language)</a>
for specifying xia2 program parameters,
which will in the long run help the documentation, but in the mean time you may see some
warnings as certain parameters were changed from <code class="samp docutils literal notranslate"><span class="pre">-param</span></code> style parameters to
<code class="samp docutils literal notranslate"><span class="pre">param=</span></code> style PHIL parameters. If you see, e.g.:</p>
<blockquote>
<div><p><code class="samp docutils literal notranslate"><span class="pre">Warning:</span> <span class="pre">-spacegroup</span> <span class="pre">option</span> <span class="pre">deprecated:</span> <span class="pre">please</span> <span class="pre">use</span> <span class="pre">space_group='P422'</span> <span class="pre">instead</span></code></p>
<p><code class="samp docutils literal notranslate"><span class="pre">Warning:</span> <span class="pre">-resolution</span> <span class="pre">option</span> <span class="pre">deprecated:</span> <span class="pre">please</span> <span class="pre">use</span> <span class="pre">d_min=1.5</span> <span class="pre">instead</span></code></p>
<p><code class="samp docutils literal notranslate"><span class="pre">Command</span> <span class="pre">line</span> <span class="pre">option</span> <span class="pre">-3d</span> <span class="pre">is</span> <span class="pre">deprecated.</span> <span class="pre">Please</span> <span class="pre">use</span> <span class="pre">pipeline=3d</span> <span class="pre">instead</span></code></p>
</div></blockquote>
<p>don’t panic - this is to be expected - but you may want to change the way you run xia2
or your scripts. More of a warning for beamline / automation people! The outcome of this
should however be automated generation of command-line documentation and the ability to
keep “recipes” for running xia2 in tidy files.</p>
</div>
<p>Here is a comprehensive list of PHIL parameters used by xia2:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">general</span> <span class="p">{</span>
<span class="p">}</span>
<span class="n">xds</span> <span class="p">{</span>
<span class="n">keep_outliers</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">correct</span> <span class="p">{</span>
<span class="p">}</span>
<span class="n">integrate</span> <span class="p">{</span>
<span class="p">}</span>
<span class="n">init</span> <span class="p">{</span>
<span class="p">}</span>
<span class="n">defpix</span> <span class="p">{</span>
<span class="p">}</span>
<span class="n">index</span> <span class="p">{</span>
<span class="n">max_wedge_size</span> <span class="o">=</span> <span class="mi">5</span>
<span class="n">max_wedge_size_degrees</span> <span class="o">=</span> <span class="kc">None</span>
<span class="p">}</span>
<span class="n">colspot</span> <span class="p">{</span>
<span class="p">}</span>
<span class="n">xscale</span> <span class="p">{</span>
<span class="p">}</span>
<span class="n">merge2cbf</span> <span class="p">{</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="n">dials</span> <span class="p">{</span>
<span class="n">outlier</span> <span class="p">{</span>
<span class="p">}</span>
<span class="n">detect_blanks</span> <span class="p">{</span>
<span class="n">phi_step</span> <span class="o">=</span> <span class="mi">2</span>
<span class="n">counts_fractional_loss</span> <span class="o">=</span> <span class="mf">0.1</span>
<span class="n">misigma_fractional_loss</span> <span class="o">=</span> <span class="mf">0.1</span>
<span class="p">}</span>
<span class="n">find_spots</span> <span class="p">{</span>
<span class="n">filter_ice_rings</span> <span class="o">=</span> <span class="kc">False</span>
<span class="p">}</span>
<span class="n">index</span> <span class="p">{</span>
<span class="n">method</span> <span class="o">=</span> <span class="n">fft1d</span> <span class="o">*</span><span class="n">fft3d</span> <span class="n">real_space_grid_search</span>
<span class="n">max_cell_estimation</span> <span class="p">{</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="n">xia2</span><span class="o">.</span><span class="n">settings</span> <span class="p">{</span>
<span class="n">pipeline</span> <span class="o">=</span> <span class="mi">3</span><span class="n">d</span> <span class="mi">3</span><span class="n">dd</span> <span class="mi">3</span><span class="n">di</span> <span class="mi">3</span><span class="n">dii</span> <span class="o">*</span><span class="n">dials</span> <span class="n">dials</span><span class="o">-</span><span class="n">aimless</span>
<span class="n">project</span> <span class="o">=</span> <span class="s1">'AUTOMATIC'</span>
<span class="n">crystal</span> <span class="o">=</span> <span class="s1">'DEFAULT'</span>
<span class="nb">input</span> <span class="p">{</span>
<span class="n">atom</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">anomalous</span> <span class="o">=</span> <span class="n">Auto</span>
<span class="p">}</span>
<span class="n">space_group</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">unit_cell</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">resolution</span> <span class="p">{</span>
<span class="n">keep_all_reflections</span> <span class="o">=</span> <span class="n">Auto</span>
<span class="n">d_max</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">d_min</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">cc_half_method</span> <span class="o">=</span> <span class="o">*</span><span class="n">half_dataset</span> <span class="n">sigma_tau</span>
<span class="n">reflections_per_bin</span> <span class="o">=</span> <span class="mi">10</span>
<span class="n">labels</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">reference</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">emax</span> <span class="o">=</span> <span class="mi">4</span>
<span class="p">}</span>
<span class="n">multiprocessing</span> <span class="p">{</span>
<span class="n">nproc</span> <span class="o">=</span> <span class="n">Auto</span>
<span class="p">}</span>
<span class="n">symmetry</span> <span class="p">{</span>
<span class="n">chirality</span> <span class="o">=</span> <span class="n">chiral</span> <span class="n">nonchiral</span> <span class="n">centrosymmetric</span>
<span class="n">program</span> <span class="o">=</span> <span class="o">*</span><span class="n">pointless</span> <span class="n">dials</span>
<span class="p">}</span>
<span class="n">output</span> <span class="p">{</span>
<span class="n">mmcif</span> <span class="p">{</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</section>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo">
<a href="index.html">
<img class="logo" src="_static/xia2-new-logo.gif" alt="Logo" />
</a>
</p>
<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="quick_start.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="using_xia2.html">Using xia2</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="introductory_example.html">Introductory example</a></li>
<li class="toctree-l1"><a class="reference internal" href="insulin_tutorial.html">Insulin tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="multi_crystal.html">Multi-crystal data</a></li>
<li class="toctree-l1"><a class="reference internal" href="serial_crystallography.html">Serial-crystallography</a></li>
<li class="toctree-l1"><a class="reference internal" href="program_output.html">Program output</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Parameters</a></li>
<li class="toctree-l1"><a class="reference internal" href="comments.html">Comments</a></li>
<li class="toctree-l1"><a class="reference internal" href="background.html">History</a></li>
<li class="toctree-l1"><a class="reference internal" href="acknowledgements.html">Acknowledgements</a></li>
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer container">
<a href="http://www.diamond.ac.uk/"><img class="logofooter" alt="Diamond" src="_static/diamond_logo.png" /></a>
<a href="http://dials.diamond.ac.uk/"><img class="logofooter" alt="DIALS" src="_static/dials_logo_fx_transparent_bg.png" /></a>
<a href="http://www.ccp4.ac.uk/"><img class="logofooter" alt="CCP4" src="_static/CCP4-logo-plain.png" /></a>
</div>
<div class="footer">
©2020, Diamond Light Source.
</div>
</body>
</html>