installation.html


<!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>Installation &#8212; xia2  documentation</title>
    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
    <link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
    <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
    <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=9bcbadda"></script>
    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Introductory example" href="introductory_example.html" />
    <link rel="prev" title="Using xia2" href="using_xia2.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="installation">
<h1>Installation<a class="headerlink" href="#installation" title="Link to this heading">¶</a></h1>
<p>The recommended way of obtaining the latest xia2 is to install the latest
xia2/DIALS bundle which can be obtained
<a class="reference external" href="https://dials.github.io/installation.html">here</a>.</p>
<p>xia2 depends critically on having CCP4 available. The <code class="docutils literal notranslate"><span class="pre">dials</span></code> and <code class="docutils literal notranslate"><span class="pre">dials-aimless</span></code>
pipelines will work with only xia2 and CCP4 installed. In order to use the
<code class="docutils literal notranslate"><span class="pre">3d</span></code>, <code class="docutils literal notranslate"><span class="pre">3di</span></code> and <code class="docutils literal notranslate"><span class="pre">3dii</span></code> pipelines you will also need XDS.</p>
<p>The standard recommended procedure for installing xia2 is therefore:</p>
<ul class="simple">
<li><p>Install CCP4 from <a class="reference external" href="http://www.ccp4.ac.uk/download/">http://www.ccp4.ac.uk/download/</a>. This now includes xia2/DIALS
as part of the installation.</p></li>
<li><p>Optionally download the latest xia2/DIALS bundle from <a class="reference external" href="https://dials.github.io/installation.html">https://dials.github.io/installation.html</a>.
Once installed, simply sourcing the dials_env.sh script in the installation
directory will make available all xia2 and DIALS commands in the current
terminal. Make sure to source the dials_env.sh script after the CCP4 setup
script</p></li>
<li><p>Optionally download XDS from <a class="reference external" href="http://xds.mpimf-heidelberg.mpg.de/">http://xds.mpimf-heidelberg.mpg.de/</a> and add this to your path <a class="footnote-reference brackets" href="#id2" id="id1" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a></p></li>
</ul>
<p>By and large, if these instruction are followed you should end up with a
happy xia2 installation. If you find any problems it’s always worth checking
the <a class="reference external" href="http://xia2.blogspot.com/">blog</a> or sending an email to <a class="reference external" href="mailto:xia2&#46;support&#37;&#52;&#48;gmail&#46;com">xia2<span>&#46;</span>support<span>&#64;</span>gmail<span>&#46;</span>com</a>.</p>
<aside class="footnote-list brackets">
<aside class="footnote brackets" id="id2" role="doc-footnote">
<span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id1">1</a><span class="fn-bracket">]</span></span>
<p>To use <code class="samp docutils literal notranslate"><span class="pre">xparallel=True</span></code> you will need to fiddle with forkintegrate in the XDS distribution</p>
</aside>
</aside>
</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 current"><a class="current reference internal" href="#">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="multiplex-multi-crystal.html">Multi-crystal data reduction (xia2.multiplex)</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"><a class="reference internal" href="parameters.html">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">
      &#169;2020, Diamond Light Source.
      
    </div>

    
  </body>
</html>