Mercurial > repos > genouest > braker

annotate README.rst @ 2:cf241e076f7b draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
author genouest
date Tue, 05 Sep 2023 09:40:27 +0000
parents
children ac13de106677
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
1 Braker3
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
2 =======
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
3
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
4 This tool is not in IUC because of the license issues with GeneMark and
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
5 ProtHint that makes it impossible to test it using CI.
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
6
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
7 GeneMark and ProtHint
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
8 ---------------------
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
9
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
10 Braker requires GeneMark to predict gene, but due to licensing issues, we
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
11 are not allowed to distribute GeneMark automatically.
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
12
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
13 Braker also requires ProtHint to use protein sequences as hints to predict
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
14 genes, but, again, due to licensing issues, we are not allowed to distribute
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
15 ProtHint automatically.
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
16
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
17 To use Braker3, the Galaxy administrator needs to install
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
18 GeneMark, and set the ``GENEMARK_PATH`` variable on the job destination.
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
19
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
20 The only working version of GeneMark to install needs to be downloaded from
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
21 http://topaz.gatech.edu/GeneMark/etp.for_braker.tar.gz
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
22 This archive also contains ProtHint and various other tools in specific versions needed by Braker3.
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
23
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
24 Unzip it, and set the ``GENEMARK_PATH`` variable to point to the extracted ``bin``
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
25 directory.
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
26
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
27 Also set the ``PROTHINT_PATH`` variable on the job destination, pointing to the extracted
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
28 ``bin/gmes/ProtHint/bin/`` directory
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
29
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
30 Running tests
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
31 -------------
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
32
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
33 Tests require working GeneMark and ProtHint installations, which means
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
34 both GENEMARK_PATH and PROTHINT_PATH are set in job_conf_braker3.xml.
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
35
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
36 You should then use the ``--job_config_file job_conf_braker3.xml``
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
37 option for planemo commands.
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
38
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
39 You should also copy a valid GeneMark license (from
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
40 http://topaz.gatech.edu/GeneMark/license_download.cgi) in
cf241e076f7b planemo upload for repository https://github.com/genouest/galaxy-tools/tree/master/tools/braker commit be0db9109388c0660c9f901f6b7129c0e3e5105c
genouest
parents:
diff changeset
41 test-data/gm_key_64.