Mercurial > repos > genouest > braker
diff README.rst @ 3:ac13de106677 draft default tip
planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit d6e73c0417506d93c905b4aeb77d92350b662fbb
author | genouest |
---|---|
date | Wed, 06 Sep 2023 09:50:12 +0000 |
parents | cf241e076f7b |
children |
line wrap: on
line diff
--- a/README.rst Tue Sep 05 09:40:27 2023 +0000 +++ b/README.rst Wed Sep 06 09:50:12 2023 +0000 @@ -1,41 +1,24 @@ -Braker3 +Braker ======= -This tool is not in IUC because of the license issues with GeneMark and -ProtHint that makes it impossible to test it using CI. - -GeneMark and ProtHint ---------------------- +This tool is not in IUC because of the license issues with GeneMark and ProtHint that makes it impossible to test it using CI. -Braker requires GeneMark to predict gene, but due to licensing issues, we -are not allowed to distribute GeneMark automatically. +GeneMark +--------- -Braker also requires ProtHint to use protein sequences as hints to predict -genes, but, again, due to licensing issues, we are not allowed to distribute -ProtHint automatically. +Braker can use GeneMark to predict gene, but due to licensing issues, we are not allowed to distribute GeneMark automatically. -To use Braker3, the Galaxy administrator needs to install -GeneMark, and set the ``GENEMARK_PATH`` variable on the job destination. +If you want to use it, the Galaxy administrator needs to install GeneMark, and set the `GENEMARK_PATH` variable on the job destination. -The only working version of GeneMark to install needs to be downloaded from -http://topaz.gatech.edu/GeneMark/etp.for_braker.tar.gz -This archive also contains ProtHint and various other tools in specific versions needed by Braker3. +ProtHint +--------- +Braker can use ProtHint to use protein sequences as hints to predict genes, but due to licensing issues, we are not allowed to distribute ProtHint automatically. -Unzip it, and set the ``GENEMARK_PATH`` variable to point to the extracted ``bin`` -directory. - -Also set the ``PROTHINT_PATH`` variable on the job destination, pointing to the extracted -``bin/gmes/ProtHint/bin/`` directory +If you want to use it, the Galaxy administrator needs to install ProtHint, and set the `PROTHINT_PATH` variable on the job destination. Running tests -------------- - -Tests require working GeneMark and ProtHint installations, which means -both GENEMARK_PATH and PROTHINT_PATH are set in job_conf_braker3.xml. +-------------- -You should then use the ``--job_config_file job_conf_braker3.xml`` -option for planemo commands. +Tests require working GeneMark and ProtHint installations, which means both GENEMARK_PATH and PROTHINT_PATH are set. -You should also copy a valid GeneMark license (from -http://topaz.gatech.edu/GeneMark/license_download.cgi) in -test-data/gm_key_64. +You should also copy a valid GeneMark license (from http://topaz.gatech.edu/GeneMark/license_download.cgi) in test-data/genemark_license.gm_key