annotate docker/dependency_resolvers_conf.xml @ 31:e4281dad3291 draft default tip

planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit 488b3c091e8bf80f741a3e46b929427f1658ba3a-dirty
author davidecangelosi
date Thu, 10 Oct 2019 09:23:42 -0400
parents 11393eb1c557
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
1 <dependency_resolvers>
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
2 <!-- the default configuration, first look for dependencies installed from the toolshed -->
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
3 <tool_shed_packages />
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
4 <!-- then look for env.sh files in directories according to the "galaxy packages" schema.
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
5 These resolvers can take a base_path attribute to specify where to look for
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
6 package definitions, but by default look in the directory specified by tool_dependency_dir
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
7 in Galaxy's config/galaxy.ini -->
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
8 <galaxy_packages />
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
9 <!-- check whether the correct version has been installed via conda -->
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
10 <conda />
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
11 <!-- look for a "default" symlink pointing to a directory containing an
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
12 env.sh file for the package in the "galaxy packages" schema -->
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
13 <galaxy_packages versionless="true" />
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
14 <!-- look for any version of the dependency installed via conda -->
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
15 <conda versionless="true" />
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
16
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
17 <!-- LMOD dependency resolver (For the LMOD environment modules system - https://github.com/TACC/Lmod) -->
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
18 <!--
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
19 The LMOD dependency resolver attributes are:
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
20 * lmodexec - Path to the lmod executable on your system - Default: value of the "LMOD_CMD" environment variable
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
21 * settargexec - Path to the settarg executable on your system - Default: value of the "LMOD_SETTARG_CMD" environment variable
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
22 * modulepath - Path to the folder that contains the LMOD module files on your system - Default: value of the "MODULEPATH" environment variable
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
23 * versionless - Set it to true to resolve a dependency based on its name only (the version number is ignored) - Default: false
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
24 * mapping_files - Path to a Yaml configuration file that can be used to link tools requirements with existing LMOD modules - Default: config/lmod_modules_mapping.yml
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
25 Important notes:
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
26 - All the above attributes are optional
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
27 - The value of the lmodexec attribute can't just be "module" because module is actually a bash function and not the real LMOD binary (see the result of the "type module" command)
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
28 - The value of the modulepath attribute can also be a semicolon separated list of path
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
29 - In versionless mode, only modules marked as Default will be listed by the "avail" command (The -d option is used)
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
30 - If the config folder of your Galaxy instance contains a file called "lmod_modules_mapping.yml" (based on the lmod_modules_mapping.yml.sample file) it will be taken into consideration automatically
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
31 -->
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
32 <!--
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
33 <lmod />
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
34 <lmod versionless="true" />
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
35 -->
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
36
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
37 <!-- Example configuration of modules dependency resolver, uses Environment Modules -->
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
38 <!--
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
39 <modules modulecmd="/opt/Modules/3.2.9/bin/modulecmd" />
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
40 <modules modulecmd="/opt/Modules/3.2.9/bin/modulecmd" versionless="true" default_indicator="default" />
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
41 Attributes are:
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
42 * modulecmd - path to modulecmd
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
43 * versionless - default: false - whether to resolve tools using a version number or not
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
44 * find_by - directory or avail - use the DirectoryModuleChecker or AvailModuleChecker
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
45 * prefetch - default: true - in the AvailModuleChecker prefetch module info with 'module avail'
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
46 * default_indicator - default: '(default)' - what indicate to the AvailModuleChecker that a module is the default version
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
47 -->
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
48
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
49 <!-- other resolvers
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
50 <tool_shed_tap />
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
51 <homebrew />
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
52 -->
11393eb1c557 planemo upload for repository https://github.com/igg-molecular-biology-lab/pipe-t.git commit d1be332a7da0e53b3e6451f0aeda0675f190dd64
davidecangelosi
parents:
diff changeset
53 </dependency_resolvers>