https://github.com/fenderglass/Ragout
Revision c1b078f72986212f42533a1aa5c036f9c9bf709e authored by fenderglass on 22 June 2014, 11:31:53 UTC, committed by fenderglass on 22 June 2014, 11:31:53 UTC
1 parent 0387a13
Raw File
Tip revision: c1b078f72986212f42533a1aa5c036f9c9bf709e authored by fenderglass on 22 June 2014, 11:31:53 UTC
update
Tip revision: c1b078f
install.html
<!DOCTYPE html>
<html>
  <head>
    <meta charset='utf-8'>
    <meta http-equiv="X-UA-Compatible" content="chrome=1">
    <link href='https://fonts.googleapis.com/css?family=Chivo:900' rel='stylesheet' type='text/css'>
    <link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen" />
    <link rel="stylesheet" type="text/css" href="stylesheets/pygment_trac.css" media="screen" />
    <link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print" />

    <link rel="shortcut icon" type="image/x-icon" href="images/favicon.ico" />
    
    <!--[if lt IE 9]>
    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <title>Ragout - installation</title>
  </head>

  <body>
    <div id="container">
      <div class="inner">

        <header>
          <h1>Ragout</h1>
          <h2>A tool for assisted assembly using multiple references</h2>
        </header>

        <section id="downloads" class="clearfix">
          <a href="https://github.com/fenderglass/Ragout/zipball/master" id="download-zip" class="button"><span>Download .zip</span></a>
          <a href="https://github.com/fenderglass/Ragout/tarball/master" id="download-tar-gz" class="button"><span>Download .tar.gz</span></a>
          <a href="https://github.com/fenderglass/Ragout" id="view-on-github" class="button"><span>View on GitHub</span></a>
        </section>

        <hr>

        <section id="main_content">
        
<h1>Installation instructions for Ragout</h1>
<h2>Availability</h2>
<p>Ragout is tested under Mac OS and Linux. While it should work
under Windows, we currently do not provide an official support.</p>
<h2>Build requirements</h2>
<ul>
<li>C++ compiler with C++0x support (GCC 4.6+ / Clang 3.2+ / Apple Clang 4.2+)</li>
<li>GNU make / Cmake (for building Sibelia)</li>
</ul>
<h2>Runtime depenencies</h2>
<ul>
<li>Python 2.7</li>
<li>Sibelia [<a href="http://github.com/bioinf/Sibelia">http://github.com/bioinf/Sibelia</a>] or Progresssive Cactus [<a href="http://github.com/glennhickey/progressiveCactus">http://github.com/glennhickey/progressiveCactus</a>]</li>
</ul>
<h2>Building</h2>
<ol>
<li><p>To build Ragout native modules, type:</p>
<pre><code> make</code></pre>
</li>
<li><p>To build and install Sibelia, use:</p>
<pre><code> python scripts/install-sibelia.py</code></pre>
</li>
</ol>
<p>If you already have Sibelia installed, you can skip second step.</p>
<p>After this, you can test your installation by running:</p>
<pre><code>python ragout.py --help</code></pre>
<p>If no errors occured, installation was successful and you can start using Ragout!</p>
<h2>Binary distribution</h2>
<p>While we recommend to build Ragout from source on each machine, you also can
use pre-compiled binaries which are available for Linux and Mac OS on our
website: <a href="http://fenderglass.github.io/Ragout/">http://fenderglass.github.io/Ragout/</a></p>
<h2>progressiveCactus</h2>
<p>Ragout can use both Sibelia and Progressive Cactus for synteny block decomposition.
Cactus support is still in early stage, however you already can try it with genomes,
that are too big for Sibelia.</p>
<p>First, download and build Progressive Cactus: <a href="https://github.com/glennhickey/progressiveCactus">https://github.com/glennhickey/progressiveCactus</a>
Then set &quot;CACTUS_INSTALL&quot; environment variable pointing to Cactus installation directory:</p>
<pre><code>export CACTUS_INSTALL=path_to_cactus</code></pre>
<h2>Troubleshooting</h2>
<p>Q: Tons of errors during compilation, possibly with 
&quot;unrecognized command line option &#39;-std=c++0x&#39;&quot; message:</p>
<p>A: Probably your compiler is too old and does not support C++0x. Minimum
versions of GCC and Clang are mentioned at the beginnig of this documtent.</p>

        </section>

        <footer>
          Ragout is maintained by <a href="https://github.com/fenderglass">fenderglass</a><br>
          This page was generated by <a href="http://pages.github.com">GitHub Pages</a>. Tactile theme by <a href="https://twitter.com/jasonlong">Jason Long</a>.
        </footer>

        
      </div>
    </div>
  </body>
</html>
back to top