GenDBWiki/AdministratorDocumentation: Difference between revisions
No edit summary |
No edit summary |
||
(22 intermediate revisions by 5 users not shown) | |||
Line 2: | Line 2: | ||
= GenDB Administrator Documentation = | = GenDB Administrator Documentation = | ||
As an alternative to using GenDB via the Internet at Bielefeld University, you can also download it and install it at your location. Please read the installation requirements, installing GenDB requires extensive resources and bioinformatics skills. GenDB 2.x has a web user interface (WebUI) for most user interactions. We recommend that annotation teams use that web interface. In addition to this interface GenDB also has a Gtk-1/Gnome-1 based graphical user interface (GUI) that has some added value, but is difficult to install. | |||
* [[GenDBWiki/AdministratorDocumentation/DependenciesAndRequirements|Dependencies and Requirements]] | |||
* [[GenDBWiki/AdministratorDocumentation/GenDBInstallation|GenDB Installation]] | |||
* [[GenDBWiki/AdministratorDocumentation/GenDBInstallationFAQ|GenDB Installation FAQ]] | |||
* [[GenDBWiki/AdministratorDocumentation/UpdatingFromOlderVersions|Updating from older Versions]] | |||
- | ----- | ||
'''There is more stuff to be written! Here is just a list of topics:''' | |||
- | - GenDB setup via Common Execution Environment (CEE) | ||
- installing a GenDB patch/bugfix | |||
- upgrading and update | |||
- backup | |||
- sequence db update | |||
- DRMAA and scheduler issues | |||
---------------------- | |||
Installing GenDB-2.2 from CVS | |||
If you are installing from an external destination and have an account for the Center for Biotechnology (CeBiTec), you first have to set your '''CVSROOT''' variable properly: | |||
<pre><nowiki> | |||
export CVSROOT=:ext:juser@porta.Genetik.Uni-Bielefeld.DE:/vol/cvs/intern/cvsroot | |||
</nowiki></pre> | |||
Go to a directory of your choice where you would like to install all software modules (you should have approximately 10 MB free disk space), e.g.: | |||
<pre><nowiki> | |||
cd /vol | |||
</nowiki></pre> | |||
Create a directory to install your local GenDB-2.2 version: | |||
<pre><nowiki> | |||
mkdir gendb-2.2 | |||
cd gendb-2.2 | |||
</nowiki></pre> | |||
Checkout the HEAD version of the '''bridge_install''' module: | |||
<pre><nowiki> | |||
cvs checkout -r HEAD bioinfo/bridge_install | |||
</nowiki></pre> | |||
Or update your files if you have already checked out a CVS version: | |||
<pre><nowiki> | |||
cvs update -dPA bioinfo/bridge_install | |||
</nowiki></pre> | |||
Call the install.sh script which is located in bioinfo/bridge_install to set up the installation system. Define the target directory for the installation (/vol/gendb-2.2 in this case): | |||
<pre><nowiki> | |||
cd bioinfo/bridge_install | |||
./install.sh /vol/gendb-2.2/ | |||
</nowiki></pre> | |||
The next step is optional: | |||
Call the script generate_cebitec_config to generate an initial configuration file. This will produce the typical settings for SUN Grid Enginge (SGE), SQL databases and sequence databases used at CeBiTec. | |||
Please checkout the bioinfo/seed_stuff module as well: | |||
<pre><nowiki> | |||
. bioinfo/seed_stuff/generate_cebitec_config > /vol/gendb-2.2/config | |||
</nowiki></pre> | |||
If you cannot or don't want to use the CeBiTec configuration, create an empty configuration file, e.g.: | |||
<pre><nowiki> | |||
/vol/gendb-2.2/> touch config | |||
</nowiki></pre> | |||
Go to the '''bin''' directory of your installation directory: | |||
<pre><nowiki> | |||
cd /vol/gendb-2.2/bin | |||
</nowiki></pre> | |||
Install the modules from CVS in the following order and activate each of them | |||
If you want to set the configuration settings interactively via gui ommit the -c param | |||
If the '''-r''' param is ommited the HEAD version of the CVS will be used! | |||
<pre><nowiki>./add_cvs_repository -n common -c ../config | |||
./activate_module -n common</nowiki></pre> | |||
<pre><nowiki>./add_cvs_repository -n wrapper -c ../config | |||
./activate_module -n wrapper</nowiki></pre> | |||
<pre><nowiki>./add_cvs_repository -n projectmanagement -c ../config | |||
./activate_module -n projectmanagement</nowiki></pre> | |||
'''ATTENTION:''' | |||
Check the file /vol/gendb-2.2/share/modules.xml for invalid characters! | |||
otherwise installation of GOPARC will fail. The xml parser fails to quote '&' | |||
characters in perl code sections | |||
<pre><nowiki>./add_cvs_repository -n GOPArc -c ../config | |||
./activate_module -n GOPArc </nowiki></pre> | |||
<pre><nowiki>./add_cvs_repository -n gendb -c ../config | |||
./activate_module -n gendb</nowiki></pre> | |||
Comment: GlobalConfig.pm.template was outdated | |||
reconfigure_module does not work. Templates were not | |||
recomputed, reconfigure_module does not feature configuartion files | |||
* fixed* | |||
<pre><nowiki>./add_cvs_repository -n gendb_web -c ../config | |||
./activate_module -n gendb_web</nowiki></pre> | |||
Comment: no bridge_install.xml file for gendb_web head | |||
* fixed* | |||
- | <pre><nowiki>./add_cvs_repository -n GooBS -c ../config | ||
- | ./activate_module -n GooBS</nowiki></pre> | ||
- | <pre><nowiki>./add_cvs_repository -n SEED -c ../config | ||
- | ./activate_module -n SEED</nowiki></pre> |
Latest revision as of 16:27, 28 October 2011
GenDB Administrator Documentation
As an alternative to using GenDB via the Internet at Bielefeld University, you can also download it and install it at your location. Please read the installation requirements, installing GenDB requires extensive resources and bioinformatics skills. GenDB 2.x has a web user interface (WebUI) for most user interactions. We recommend that annotation teams use that web interface. In addition to this interface GenDB also has a Gtk-1/Gnome-1 based graphical user interface (GUI) that has some added value, but is difficult to install.
- Dependencies and Requirements
- GenDB Installation
- GenDB Installation FAQ
- Updating from older Versions
There is more stuff to be written! Here is just a list of topics:
- GenDB setup via Common Execution Environment (CEE)
- installing a GenDB patch/bugfix
- upgrading and update
- backup
- sequence db update
- DRMAA and scheduler issues
Installing GenDB-2.2 from CVS
If you are installing from an external destination and have an account for the Center for Biotechnology (CeBiTec), you first have to set your CVSROOT variable properly:
export CVSROOT=:ext:juser@porta.Genetik.Uni-Bielefeld.DE:/vol/cvs/intern/cvsroot
Go to a directory of your choice where you would like to install all software modules (you should have approximately 10 MB free disk space), e.g.:
cd /vol
Create a directory to install your local GenDB-2.2 version:
mkdir gendb-2.2 cd gendb-2.2
Checkout the HEAD version of the bridge_install module:
cvs checkout -r HEAD bioinfo/bridge_install
Or update your files if you have already checked out a CVS version:
cvs update -dPA bioinfo/bridge_install
Call the install.sh script which is located in bioinfo/bridge_install to set up the installation system. Define the target directory for the installation (/vol/gendb-2.2 in this case):
cd bioinfo/bridge_install ./install.sh /vol/gendb-2.2/
The next step is optional:
Call the script generate_cebitec_config to generate an initial configuration file. This will produce the typical settings for SUN Grid Enginge (SGE), SQL databases and sequence databases used at CeBiTec.
Please checkout the bioinfo/seed_stuff module as well:
. bioinfo/seed_stuff/generate_cebitec_config > /vol/gendb-2.2/config
If you cannot or don't want to use the CeBiTec configuration, create an empty configuration file, e.g.:
/vol/gendb-2.2/> touch config
Go to the bin directory of your installation directory:
cd /vol/gendb-2.2/bin
Install the modules from CVS in the following order and activate each of them
If you want to set the configuration settings interactively via gui ommit the -c param
If the -r param is ommited the HEAD version of the CVS will be used!
./add_cvs_repository -n common -c ../config ./activate_module -n common
./add_cvs_repository -n wrapper -c ../config ./activate_module -n wrapper
./add_cvs_repository -n projectmanagement -c ../config ./activate_module -n projectmanagement
ATTENTION:
Check the file /vol/gendb-2.2/share/modules.xml for invalid characters!
otherwise installation of GOPARC will fail. The xml parser fails to quote '&'
characters in perl code sections
./add_cvs_repository -n GOPArc -c ../config ./activate_module -n GOPArc
./add_cvs_repository -n gendb -c ../config ./activate_module -n gendb
Comment: GlobalConfig.pm.template was outdated
reconfigure_module does not work. Templates were not recomputed, reconfigure_module does not feature configuartion files
- fixed*
./add_cvs_repository -n gendb_web -c ../config ./activate_module -n gendb_web
Comment: no bridge_install.xml file for gendb_web head
- fixed*
./add_cvs_repository -n GooBS -c ../config ./activate_module -n GooBS
./add_cvs_repository -n SEED -c ../config ./activate_module -n SEED