Commit 2ff18a11 authored by Leo Gordon's avatar Leo Gordon
Browse files

simplify installation docs for coreless Hive

parent 4910c5c3
......@@ -38,49 +38,17 @@
- Chart::Gnuplot (needed for generate_timeline.pl)
2. Download and install essential repositories from EnsEMBL @ GitHub
2. Install the Hive repository from GitHub:
2.1. It is advised to have a dedicated directory where EnsEMBL-related packages will be deployed.
Unlike DBI modules that can be installed system-wide by the system administrator,
you will benefit from full (read+write) access to the EnsEMBL files/directories,
so it is best to install them under your home directory. For example,
git clone https://github.com/Ensembl/ensembl-hive.git
$ mkdir $HOME/ensembl_main
This will create ensembl-hive directory with all the code and documentation.
It will be convenient to set a variable pointing at this directory for future use:
You may find it convenient (although it is not necessary) to add "ensembl-hive/scripts"
to your $PATH variable to make it easier to run beekeeper.pl and other useful Hive scripts.
# using bash syntax:
$ export ENSEMBL_CVS_ROOT_DIR="$HOME/ensembl_main"
#
# (for best results, append this line to your ~/.bashrc configuration file)
# using [t]csh syntax:
$ setenv ENSEMBL_CVS_ROOT_DIR "$HOME/ensembl_main"
#
# (for best results, append this line to your ~/.cshrc or ~/.tcshrc configuration file)
2.2. Change into your ensembl codebase directory:
$ cd $ENSEMBL_CVS_ROOT_DIR
2.3. Check out the Ensembl repositories by cloning them from GitHub:
git clone https://github.com/Ensembl/ensembl.git # core API
git clone https://github.com/Ensembl/ensembl-hive.git # Ensembl Hive
2.4. Add new packages to the PERL5LIB variable:
# using bash syntax:
$ export PERL5LIB=${PERL5LIB}:${ENSEMBL_CVS_ROOT_DIR}/ensembl/modules
$ export PERL5LIB=${PERL5LIB}:${ENSEMBL_CVS_ROOT_DIR}/ensembl-hive/modules
#
# (for best results, append these lines to your ~/.bashrc configuration file)
# using [t]csh syntax:
$ setenv PERL5LIB ${PERL5LIB}:${ENSEMBL_CVS_ROOT_DIR}/ensembl/modules
$ setenv PERL5LIB ${PERL5LIB}:${ENSEMBL_CVS_ROOT_DIR}/ensembl-hive/modules
#
# (for best results, append these lines to your ~/.cshrc or ~/.tcshrc configuration file)
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 $PERL5LIB variable.
3. Useful files and directories of the eHive repository.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment