Skip to content

Commit 45d5256

Browse files
authored
Merge pull request #683 from jmchilton/conda_doc_enhance
Conda docs improvements.
2 parents ccd6d79 + daa1155 commit 45d5256

2 files changed

Lines changed: 14 additions & 3 deletions

File tree

docs/_writing_dependencies_conda.rst

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,17 @@ As configured by Planemo, when Galaxy encounters these ``requirement`` tags it
7575
will attempt to install Conda, check for referenced packages (such as
7676
``seqtk``), and install them as needed for tool testing.
7777

78+
.. figure:: images/dependency_resolution.png
79+
:alt: Diagram describing mapping tool requirements to dependencies.
80+
81+
Galaxy's dependency resolution maps tool requirement tags to concrete
82+
applications and libraries setup by the Galaxy deployer (or Planemo). As
83+
the above diagram indicates the same requirements may be used by multiple
84+
Galaxy tools and a single Galaxy tool may depend on multiple requirements.
85+
The document describes working with Conda dependencies from a developer
86+
perspective but other dependency resolution techniques are covered in
87+
the `Galaxy docs <https://docs.galaxyproject.org/en/latest/admin/dependency_resolvers.html>`__.
88+
7889
We can check if the requirements on a tool are available in best practice
7990
Conda channels using an extended form of the ``planemo lint`` command. Passing
8091
``--conda_requirements`` flag will ensure all listed requirements are found.
@@ -88,8 +99,8 @@ Conda channels using an extended form of the ``planemo lint`` command. Passing
8899
.. INFO: Requirement [seqtk@1.2] matches target in best practice Conda channel [bioconda].
89100

90101

91-
.. note:: You can download the final version of the seqtk from the Planemo tutorial using
92-
the command::
102+
.. note:: You can download the final version of the seqtk seq wrapper from the Planemo
103+
tutorial using the command::
93104

94105
$ planemo project_init --template=seqtk_complete seqtk_example
95106
$ cd seqtk_example
@@ -136,7 +147,7 @@ for their declared requirements.
136147
seqtk not found
137148
$
138149

139-
The above install worked properly, but seqtk is not on your ``PATH`` because this merely
150+
The above install worked properly, but ``seqtk`` is not on your ``PATH`` because this merely
140151
created an environment within the Conda directory for the seqtk installation. Planemo
141152
will configure Galaxy to exploit this installation. If you wish to interactively explore
142153
the resulting enviornment to explore the installed tool or produce test data the output
61.7 KB
Loading

0 commit comments

Comments
 (0)