:orphan:  .. only available via index, not via toctree

.. title:: Package Recipe 'samplesheet-parser'
.. highlight: bash

samplesheet-parser
==================

.. conda:recipe:: samplesheet-parser
   :replaces_section_title:
   :noindex:

   Format\-agnostic parser for Illumina SampleSheet.csv files — supports IEM V1 and BCLConvert V2

   :homepage: https://github.com/chaitanyakasaraneni/samplesheet-parser
   :documentation: https://illumina-samplesheet.readthedocs.io
   
   :license: Apache-2.0
   :recipe: /`samplesheet-parser <https://github.com/bioconda/bioconda-recipes/tree/master/recipes/samplesheet-parser>`_/`meta.yaml <https://github.com/bioconda/bioconda-recipes/tree/master/recipes/samplesheet-parser/meta.yaml>`_

   A Python library for parsing\, validating\, converting\, and merging
   Illumina SampleSheet V1 and V2 files for BCLConvert and bcl2fastq.
   Provides format auto\-detection\, bidirectional V1\/V2 conversion\,
   structural and index validation\, sheet diffing\, and cross\-project
   merging with Hamming\-distance collision detection.



.. conda:package:: samplesheet-parser

   |downloads_samplesheet-parser| |docker_samplesheet-parser|

   :versions:
      
      

      ``1.2.0-0``,  ``1.1.0-0``

      

   
   :depends on loguru: ``>=0.7``
   :depends on python: ``>=3.12``
   :depends on typer: ``>=0.12``

   :additional platforms:
      

Installation
------------

You need a conda-compatible package manager
(currently either `pixi <https://pixi.sh>`__, `conda <https://docs.conda.io/projects/conda>`__, or `micromamba <https://mamba.readthedocs.io>`__)
and the Bioconda channel already activated (see :ref:`bioconda_setup`).
Below, we show how to install with either pixi or conda (for micromamba and mamba, commands are essentially the same as with conda).

Pixi
""""

With pixi_ installed and the Bioconda channel set up (see :ref:`bioconda_setup`),
to install globally, run::

    pixi global install samplesheet-parser

to add into an existing workspace instead, run::

    pixi add samplesheet-parser

In the latter case, make sure to first add bioconda and conda-forge to the channels considered by the workspace::

    pixi workspace channel add conda-forge
    pixi workspace channel add bioconda

Conda
"""""

With conda_ installed and the Bioconda channel set up (see :ref:`bioconda_setup`), to install into an existing and activated environment, run::

    conda install samplesheet-parser

Alternatively, to install into a new environment, run::

    conda create -n envname samplesheet-parser

with ``envname`` being the name of the desired environment.

Container
"""""""""

Alternatively, every Bioconda package is available as a container image for usage with your preferred container runtime.
For e.g. docker, run::

    docker pull quay.io/biocontainers/samplesheet-parser:<tag>

(see `samplesheet-parser/tags`_ for valid values for ``<tag>``).

Integrated deployment
"""""""""""""""""""""

Finally, note that many scientific workflow management systems directly integrate both conda and container based software deployment.
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.
Check the documentation of your workflow management system to find out about the integration.

.. _conda: https://conda.io
.. _pixi: https://pixi.sh
.. |downloads_samplesheet-parser| image:: https://img.shields.io/conda/dn/bioconda/samplesheet-parser.svg?style=flat
   :target: https://anaconda.org/bioconda/samplesheet-parser
   :alt:   (downloads)
.. |docker_samplesheet-parser| image:: https://quay.io/repository/biocontainers/samplesheet-parser/status
   :target: https://quay.io/repository/biocontainers/samplesheet-parser
.. _`samplesheet-parser/tags`: https://quay.io/repository/biocontainers/samplesheet-parser?tab=tags


.. raw:: html

    <script>
        var package = "samplesheet-parser";
        var versions = ["1.2.0","1.1.0"];
    </script>






Download stats
-----------------

.. raw:: html
    :file: ../../templates/package_dashboard.html

Link to this page
-----------------

Render an |install-with-bioconda| badge with the following MarkDown::

   [![install with bioconda](https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat)](http://bioconda.github.io/recipes/samplesheet-parser/README.html)

.. |install-with-bioconda| image:: https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat
   :target: http://bioconda.github.io/recipes/samplesheet-parser/README.html