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