install.html 3.8 KB
Newer Older
1 2 3
<html>
    <head>
        <title>eHive installation and setup</title>
4
        <link rel="stylesheet" type="text/css" media="all" href="ehive_doc.css" />
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
    </head>
<body>

    <center><h1>eHive installation and setup</h1></center>
    <hr width=50% />

    <center><h2>eHive dependencies</h2></center>

    eHive system depends on the following components that you may need to download and install first:
    <ol>
        <li>Perl 5.10 <a href=http://www.perl.org/get.html>or higher</a></li>
        <li>A database engine of your choice. eHive keeps its state in a database, so you will need
            <ol>
                <li>a server installed on the machine where you want to maintain the state of your pipeline(s) and</li>
                <li>clients installed on the machines where the jobs are to be executed.</li>
            </ol>
            At the moment, the following database options are available:
            <ul>
                <li>MySQL 5.1 <a href=http://dev.mysql.com/downloads/>or higher</a></li>
                <li>SQLite 3.6 <a href=http://www.sqlite.org/download.html>or higher</a></li>
                <li>PostgreSQL 9.2 <a href=http://www.postgresql.org/download/>or higher</a></li>
            </ul>
        </li>
        <li>Perl DBI API version 1.6 <a href=http://dbi.perl.org/>or higher</a> --
            Perl database interface that has to include a driver for the database engine of your choice above.
        </li>
        <li>Perl libraries for visualisation (optional but recommended). They can be found on CPAN:
            <ul>
                <li><a href=http://search.cpan.org/~rsavage/GraphViz/lib/GraphViz.pm>GraphViz</a> (needed for generate_graph.pl and the GUI)</li>
                <li><a href=http://search.cpan.org/dist/Chart-Gnuplot/lib/Chart/Gnuplot.pm>Chart::Gnuplot</a> (needed for generate_timeline.pl)</li>
            </ul>
        </li>

    </ol>

    <hr width=50% />

42
    <center><h2>Installing eHive code</h2></center>
43

44
<h3>Check out the repository by cloning it from GitHub:</h3>
45 46

<pre>
47
        $ git clone https://github.com/Ensembl/ensembl-hive.git
48 49
</pre>

50 51 52 53 54 55 56 57 58 59 60
<p>
This will create ensembl-hive directory with all the code and documentation.
</p>


<h3>Optional configuration of the system:</h3>

<p>
You may find it convenient (although it is not necessary) to add "ensembl-hive/scripts"
to your <code>$PATH</code> variable to make it easier to run beekeeper.pl and other useful Hive scripts.
</p>
61 62 63 64

<ul>
<li><i>using bash syntax:</i>
<pre>
65
        $ export PATH=$PATH:$ENSEMBL_CVS_ROOT_DIR/ensembl-hive/scripts<i>
66 67 68 69 70 71
                #
                # (for best results, append this line to your ~/.bashrc or ~/.bash_profile configuration file)</i>
</pre></li>

<li><i>using [t]csh syntax:</i>
<pre>
72
        $ set path = ( $path ${ENSEMBL_CVS_ROOT_DIR}/ensembl-hive/scripts )<i>
73 74 75 76 77
                #
                # (for best results, append this line to your ~/.cshrc or ~/.tcshrc configuration file)</i>
</pre></li>
</ul>

78 79 80 81
<p>
Also, if you are developing the code and not just running ready pipelines,
you may find it convenient to add "ensembl-hive/modules" to your <code>$PERL5LIB</code> variable.
</p>
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102

<ul>
<li><i>using bash syntax:</i>
<pre>
        $ export PERL5LIB=${PERL5LIB}:${ENSEMBL_CVS_ROOT_DIR}/ensembl/modules
        $ export PERL5LIB=${PERL5LIB}:${ENSEMBL_CVS_ROOT_DIR}/ensembl-hive/modules<i>
                #
                # (for best results, append these lines to your ~/.bashrc or ~/.bash_profile configuration file)</i>
</pre></li>

<li><i>using [t]csh syntax:</i>
<pre>
        $ setenv PERL5LIB  ${PERL5LIB}:${ENSEMBL_CVS_ROOT_DIR}/ensembl/modules
        $ setenv PERL5LIB  ${PERL5LIB}:${ENSEMBL_CVS_ROOT_DIR}/ensembl-hive/modules<i>
                #
                # (for best results, append these lines to your ~/.cshrc or ~/.tcshrc configuration file)</i>
</pre></li>
</ul>

</body>
</html>