You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/conda_integration.rst
+13-16Lines changed: 13 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,9 +18,9 @@ The conda package manager makes installing software a vastly more streamlined pr
18
18
Defining a Conda package
19
19
-------------------------
20
20
21
-
The preferred way to build a conda package is to write a `conda recipe <https://conda.pydata.org>`_ and submit this it the BioConda communitiy. As soon as your PR is merged and continues integration testing was successful, we will build you automatically a container and publish it at `quay.io/biocontainers <https://quay.io/organization/biocontainers>`_ and `BioContainers Registry <http://biocontainers.pro/#/registry>`__.
21
+
The preferred way to build a conda package is to write a `conda recipe <https://conda.pydata.org>`_ and submit this it the BioConda community. As soon as your PR is merged and continues integration testing was successful, we will build you automatically a container and publish it at `quay.io/biocontainers <https://quay.io/organization/biocontainers>`_ and `BioContainers Registry <http://biocontainers.pro/#/registry>`__.
22
22
23
-
The BioConda specification `Contribution Guide <https://bioconda.github.io/contributing.html>`_ define how to create a recipe. In summary, a BioConda recipe should contain the following parts ():
23
+
The BioConda specification `Contribution Guide <https://bioconda.github.io/contributing.html>`_ define how to create a recipe. In summary, a BioConda recipe should contain the following parts:
24
24
25
25
- Source URL is stable (details)
26
26
- md5 or sha256 hash included for source download (details)
@@ -33,7 +33,7 @@ The BioConda specification `Contribution Guide <https://bioconda.github.io/contr
33
33
- Package does not already exist in the defaults, r, or conda-forge channels with some
34
34
exceptions (details)
35
35
- Package is appropriate for bioconda
36
-
- If the recipe installs custom wrapper scripts, usage notes should be added to ``extra -> notes`` in the meta.yaml.
36
+
- If the recipe installs custom wrapper scripts, usage notes should be added to ``extra -> notes`` in the meta.yaml
37
37
38
38
Example Yaml for bowtie2:
39
39
@@ -82,13 +82,13 @@ Example Yaml for bowtie2:
82
82
license_file: LICENSE
83
83
summary: 'Hybrid assembly pipeline for bacterial genomes'
84
84
85
-
When the recipe is ready a Pull Request should be created (https://bioconda.github.io/contribute-a-recipe.html#push-changes-wait-for-tests-to-pass-submit-pull-request). Finally, the container is automatically created for the new BioConda Package.
85
+
When the recipe is ready, a Pull Request should be created (https://bioconda.github.io/contributor/workflow.html). Finally, the container is automatically created for the new BioConda Package.
86
86
87
87
88
88
Automatic build from conda recipes
89
89
-----------------------------------
90
90
91
-
We utilize `mulled <https://github.com/mulled/mulled>`_ with `involucro <https://github.com/involucro/involucro>`_ in an automatic way. This is for example used to convert all packages in ``bioconda`` into Linux Containers (Docker and rkt at the moment. We have developed small utilities around this technology stack which is currently included in galaxy-lib.
91
+
We utilize `mulled <https://github.com/mulled/mulled>`_ with `involucro <https://github.com/involucro/involucro>`_ in an automatic way. This is for example used to convert all packages in ``bioconda`` into Linux Containers (Docker and rkt at the moment). We have developed small utilities around this technology stack which is currently included in galaxy-lib.
92
92
93
93
.. code-block:: bash
94
94
@@ -108,7 +108,7 @@ This will search for containers in the biocontainers organisation.
108
108
Build all packages from bioconda from the last 24h
109
109
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
110
110
111
-
The BioConda community is building a container for every package they create with a command similar to this.
111
+
The BioConda community is building a container for every package they create with a command similar to this:
112
112
113
113
.. code-block:: bash
114
114
@@ -119,27 +119,25 @@ The BioConda community is building a container for every package they create wit
119
119
Building Docker containers for local Conda packages
120
120
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
121
121
122
-
Conda packages can be tested with creating a busyboxbased container for this particular package in the following way.
122
+
Conda packages can be tested with creating a busybox-based container for this particular package in the following way.
123
123
This also demonstrates how you can build a container locally and on-the-fly.
124
124
125
-
..
125
+
..note:: We modified the samtools package to version 3.0 to make clear we are using a local version.
126
126
127
-
we modified the samtools package to version 3.0 to make clear we are using a local version
128
127
129
-
130
-
1) build your recipe
128
+
1) Build your recipe
131
129
132
130
.. code-block:: bash
133
131
134
132
$ conda build recipes/samtools
135
133
136
-
2) index your local builds
134
+
2) Index your local builds
137
135
138
136
.. code-block:: bash
139
137
140
138
$ conda index /home/bag/miniconda2/conda-bld/linux-64/
141
139
142
-
3) build a container for your local package
140
+
3) Build a container for your local package
143
141
144
142
.. code-block:: bash
145
143
@@ -154,8 +152,7 @@ Build, test and push a conda-forge package to biocontainers
154
152
155
153
.. note:: You need to have write access to the biocontainers repository
156
154
157
-
You can build packages from other Conda channels as well, not only from BioConda. ``pandoc`` is available from the conda-forge channel and conda-forge is also enabled by default in Galaxy. To build ``pandoc`` and push it to biocontainrs
158
-
you could do something along these lines.
155
+
You can build packages from other Conda channels as well, not only from BioConda. ``pandoc`` is available from the conda-forge channel and conda-forge is also enabled by default in Galaxy. To build ``pandoc`` and push it to BioContainers, you could do something along these lines:
159
156
160
157
.. code-block:: bash
161
158
@@ -166,7 +163,7 @@ you could do something along these lines.
0 commit comments