Skip to content

Commit e2ac2bf

Browse files
committed
Updated docs to commit fc2ca8824c8c384d55bd8330609114505436ab8b
1 parent 99e6ef0 commit e2ac2bf

File tree

71 files changed

+3663
-1830
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+3663
-1830
lines changed
Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
:orphan: .. only available via index, not via toctree
2+
3+
.. title:: Package Recipe 'alpaqa-bio'
4+
.. highlight: bash
5+
6+
alpaqa-bio
7+
==========
8+
9+
.. conda:recipe:: alpaqa-bio
10+
:replaces_section_title:
11+
:noindex:
12+
13+
a quality control tool for bacterial ONT\-only assemblies
14+
15+
:homepage: https://pypi.org/project/alpaqa-bio/
16+
:license: GPL-3.0-only
17+
:recipe: /`alpaqa-bio <https://github.com/bioconda/bioconda-recipes/tree/master/recipes/alpaqa-bio>`_/`meta.yaml <https://github.com/bioconda/bioconda-recipes/tree/master/recipes/alpaqa-bio/meta.yaml>`_
18+
19+
20+
21+
22+
.. conda:package:: alpaqa-bio
23+
24+
|downloads_alpaqa-bio| |docker_alpaqa-bio|
25+
26+
:versions:
27+
28+
29+
30+
``0.1.4-0``
31+
32+
33+
34+
35+
:depends on python: ``>=3.9``
36+
:depends on scipy: ``>=1.10.0``
37+
38+
:additional platforms:
39+
40+
41+
Installation
42+
------------
43+
44+
You need a conda-compatible package manager
45+
(currently either `pixi <https://pixi.sh>`__, `conda <https://docs.conda.io/projects/conda>`__, or `micromamba <https://mamba.readthedocs.io>`__)
46+
and the Bioconda channel already activated (see :ref:`bioconda_setup`).
47+
Below, we show how to install with either pixi or conda (for micromamba and mamba, commands are essentially the same as with conda).
48+
49+
Pixi
50+
""""
51+
52+
With pixi_ installed and the Bioconda channel set up (see :ref:`bioconda_setup`),
53+
to install globally, run::
54+
55+
pixi global install alpaqa-bio
56+
57+
to add into an existing workspace instead, run::
58+
59+
pixi add alpaqa-bio
60+
61+
In the latter case, make sure to first add bioconda and conda-forge to the channels considered by the workspace::
62+
63+
pixi workspace channel add conda-forge
64+
pixi workspace channel add bioconda
65+
66+
Conda
67+
"""""
68+
69+
With conda_ installed and the Bioconda channel set up (see :ref:`bioconda_setup`), to install into an existing and activated environment, run::
70+
71+
conda install alpaqa-bio
72+
73+
Alternatively, to install into a new environment, run::
74+
75+
conda create -n envname alpaqa-bio
76+
77+
with ``envname`` being the name of the desired environment.
78+
79+
Container
80+
"""""""""
81+
82+
Alternatively, every Bioconda package is available as a container image for usage with your preferred container runtime.
83+
For e.g. docker, run::
84+
85+
docker pull quay.io/biocontainers/alpaqa-bio:<tag>
86+
87+
(see `alpaqa-bio/tags`_ for valid values for ``<tag>``).
88+
89+
Integrated deployment
90+
"""""""""""""""""""""
91+
92+
Finally, note that many scientific workflow management systems directly integrate both conda and container based software deployment.
93+
Thus, workflow steps can be often directly annotated to use the package, leading to automatic deployment by the respective workflow management system, thereby improving reproducibility and transparency.
94+
Check the documentation of your workflow management system to find out about the integration.
95+
96+
.. _conda: https://conda.io
97+
.. _pixi: https://pixi.sh
98+
.. |downloads_alpaqa-bio| image:: https://img.shields.io/conda/dn/bioconda/alpaqa-bio.svg?style=flat
99+
:target: https://anaconda.org/bioconda/alpaqa-bio
100+
:alt: (downloads)
101+
.. |docker_alpaqa-bio| image:: https://quay.io/repository/biocontainers/alpaqa-bio/status
102+
:target: https://quay.io/repository/biocontainers/alpaqa-bio
103+
.. _`alpaqa-bio/tags`: https://quay.io/repository/biocontainers/alpaqa-bio?tab=tags
104+
105+
106+
.. raw:: html
107+
108+
<script>
109+
var package = "alpaqa-bio";
110+
var versions = ["0.1.4"];
111+
</script>
112+
113+
114+
115+
116+
117+
118+
Download stats
119+
-----------------
120+
121+
.. raw:: html
122+
:file: ../../templates/package_dashboard.html
123+
124+
Link to this page
125+
-----------------
126+
127+
Render an |install-with-bioconda| badge with the following MarkDown::
128+
129+
[![install with bioconda](https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat)](http://bioconda.github.io/recipes/alpaqa-bio/README.html)
130+
131+
.. |install-with-bioconda| image:: https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat
132+
:target: http://bioconda.github.io/recipes/alpaqa-bio/README.html

_sources/recipes/atol-genome-launcher/README.rst.txt

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ atol-genome-launcher
2828

2929
.. raw:: html
3030

31-
<details><summary><span class="truncated-version-list"><code>0.8.0-0</code>,  <code>0.7.5-0</code>,  <code>0.7.4-0</code>,  <code>0.7.2-0</code>,  <code>0.7.1-0</code>,  <code>0.7.0-0</code>,  <code>0.6.0-0</code>,  <code>0.5.5-0</code>,  <code>0.5.4-0</code>,  </span></summary>
31+
<details><summary><span class="truncated-version-list"><code>0.8.2-0</code>,  <code>0.8.1-0</code>,  <code>0.8.0-0</code>,  <code>0.7.5-0</code>,  <code>0.7.4-0</code>,  <code>0.7.2-0</code>,  <code>0.7.1-0</code>,  <code>0.7.0-0</code>,  <code>0.6.0-0</code>,  </span></summary>
3232

3333

34-
``0.8.0-0``,  ``0.7.5-0``,  ``0.7.4-0``,  ``0.7.2-0``,  ``0.7.1-0``,  ``0.7.0-0``,  ``0.6.0-0``,  ``0.5.5-0``,  ``0.5.4-0``,  ``0.5.3-0``,  ``0.5.2-0``,  ``0.5.1-0``,  ``0.5.0-0``,  ``0.4.1-0``,  ``0.4.0-0``,  ``0.3.1-0``,  ``0.2.1-0``,  ``0.2.0-0``,  ``0.1.5-0``
34+
``0.8.2-0``,  ``0.8.1-0``,  ``0.8.0-0``,  ``0.7.5-0``,  ``0.7.4-0``,  ``0.7.2-0``,  ``0.7.1-0``,  ``0.7.0-0``,  ``0.6.0-0``,  ``0.5.5-0``,  ``0.5.4-0``,  ``0.5.3-0``,  ``0.5.2-0``,  ``0.5.1-0``,  ``0.5.0-0``,  ``0.4.1-0``,  ``0.4.0-0``,  ``0.3.1-0``,  ``0.2.1-0``,  ``0.2.0-0``,  ``0.1.5-0``
3535

3636

3737
.. raw:: html
@@ -41,6 +41,7 @@ atol-genome-launcher
4141

4242

4343
:depends on ca-certificates:
44+
:depends on git:
4445
:depends on pandas: ``>=2.3.3,<3``
4546
:depends on pigz:
4647
:depends on pydantic: ``>=2.12.5``
@@ -122,7 +123,7 @@ Check the documentation of your workflow management system to find out about the
122123

123124
<script>
124125
var package = "atol-genome-launcher";
125-
var versions = ["0.8.0","0.7.5","0.7.4","0.7.2","0.7.1"];
126+
var versions = ["0.8.2","0.8.1","0.8.0","0.7.5","0.7.4"];
126127
</script>
127128

128129

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
:orphan: .. only available via index, not via toctree
2+
3+
.. title:: Package Recipe 'bigsdb-downloader'
4+
.. highlight: bash
5+
6+
bigsdb-downloader
7+
=================
8+
9+
.. conda:recipe:: bigsdb-downloader
10+
:replaces_section_title:
11+
:noindex:
12+
13+
BIGSdb Downloader
14+
15+
:homepage: https://github.com/kjolley/BIGSdb_downloader
16+
:license: GPL-3.0-or-later
17+
:recipe: /`bigsdb-downloader <https://github.com/bioconda/bioconda-recipes/tree/master/recipes/bigsdb-downloader>`_/`meta.yaml <https://github.com/bioconda/bioconda-recipes/tree/master/recipes/bigsdb-downloader/meta.yaml>`_
18+
19+
20+
21+
22+
.. conda:package:: bigsdb-downloader
23+
24+
|downloads_bigsdb-downloader| |docker_bigsdb-downloader|
25+
26+
:versions:
27+
28+
29+
30+
``1.0.5-0``
31+
32+
33+
34+
35+
:depends on python: ``>=3.9``
36+
:depends on rauth: ``>=0.7.3``
37+
38+
:additional platforms:
39+
40+
41+
Installation
42+
------------
43+
44+
You need a conda-compatible package manager
45+
(currently either `pixi <https://pixi.sh>`__, `conda <https://docs.conda.io/projects/conda>`__, or `micromamba <https://mamba.readthedocs.io>`__)
46+
and the Bioconda channel already activated (see :ref:`bioconda_setup`).
47+
Below, we show how to install with either pixi or conda (for micromamba and mamba, commands are essentially the same as with conda).
48+
49+
Pixi
50+
""""
51+
52+
With pixi_ installed and the Bioconda channel set up (see :ref:`bioconda_setup`),
53+
to install globally, run::
54+
55+
pixi global install bigsdb-downloader
56+
57+
to add into an existing workspace instead, run::
58+
59+
pixi add bigsdb-downloader
60+
61+
In the latter case, make sure to first add bioconda and conda-forge to the channels considered by the workspace::
62+
63+
pixi workspace channel add conda-forge
64+
pixi workspace channel add bioconda
65+
66+
Conda
67+
"""""
68+
69+
With conda_ installed and the Bioconda channel set up (see :ref:`bioconda_setup`), to install into an existing and activated environment, run::
70+
71+
conda install bigsdb-downloader
72+
73+
Alternatively, to install into a new environment, run::
74+
75+
conda create -n envname bigsdb-downloader
76+
77+
with ``envname`` being the name of the desired environment.
78+
79+
Container
80+
"""""""""
81+
82+
Alternatively, every Bioconda package is available as a container image for usage with your preferred container runtime.
83+
For e.g. docker, run::
84+
85+
docker pull quay.io/biocontainers/bigsdb-downloader:<tag>
86+
87+
(see `bigsdb-downloader/tags`_ for valid values for ``<tag>``).
88+
89+
Integrated deployment
90+
"""""""""""""""""""""
91+
92+
Finally, note that many scientific workflow management systems directly integrate both conda and container based software deployment.
93+
Thus, workflow steps can be often directly annotated to use the package, leading to automatic deployment by the respective workflow management system, thereby improving reproducibility and transparency.
94+
Check the documentation of your workflow management system to find out about the integration.
95+
96+
.. _conda: https://conda.io
97+
.. _pixi: https://pixi.sh
98+
.. |downloads_bigsdb-downloader| image:: https://img.shields.io/conda/dn/bioconda/bigsdb-downloader.svg?style=flat
99+
:target: https://anaconda.org/bioconda/bigsdb-downloader
100+
:alt: (downloads)
101+
.. |docker_bigsdb-downloader| image:: https://quay.io/repository/biocontainers/bigsdb-downloader/status
102+
:target: https://quay.io/repository/biocontainers/bigsdb-downloader
103+
.. _`bigsdb-downloader/tags`: https://quay.io/repository/biocontainers/bigsdb-downloader?tab=tags
104+
105+
106+
.. raw:: html
107+
108+
<script>
109+
var package = "bigsdb-downloader";
110+
var versions = ["1.0.5"];
111+
</script>
112+
113+
114+
115+
116+
117+
118+
Download stats
119+
-----------------
120+
121+
.. raw:: html
122+
:file: ../../templates/package_dashboard.html
123+
124+
Link to this page
125+
-----------------
126+
127+
Render an |install-with-bioconda| badge with the following MarkDown::
128+
129+
[![install with bioconda](https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat)](http://bioconda.github.io/recipes/bigsdb-downloader/README.html)
130+
131+
.. |install-with-bioconda| image:: https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat
132+
:target: http://bioconda.github.io/recipes/bigsdb-downloader/README.html

0 commit comments

Comments
 (0)