File: README.rst

package info (click to toggle)
python-pysam 0.10.0+ds-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 14,196 kB
  • ctags: 10,087
  • sloc: ansic: 79,627; python: 8,569; sh: 282; makefile: 215; perl: 41
file content (48 lines) | stat: -rw-r--r-- 1,569 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
=====
Pysam
=====

|build-status| |docs|

Pysam is a python module for reading and manipulating files in the
SAM/BAM format. The SAM/BAM format is a way to store efficiently large
numbers of alignments (`Li 2009`_), such as those routinely created by
next-generation sequencing methods.

Pysam is a lightweight wrapper of the samtools_ C-API. Pysam also
includes an interface for tabix_.

The latest version is available through `pypi
<https://pypi.python.org/pypi/pysam>`_. To install, simply type::

   pip install pysam

If you are using the conda packaging manager (e.g. miniconda or anaconda),
you can install pysam from the `bioconda channel <https://bioconda.github.io/>`_:

   conda config --add channels r

   conda config --add channels bioconda

   conda install pysam


Pysam documentation is available through https://readthedocs.org/ from
`here <http://pysam.readthedocs.org/en/latest/>`_

Questions and comments are very welcome and should be sent to the
`pysam user group <http://groups.google.com/group/pysam-user-group>`_

.. _samtools: http://samtools.sourceforge.net/
.. _tabix: http://samtools.sourceforge.net/tabix.shtml
.. _Li 2009: http://www.ncbi.nlm.nih.gov/pubmed/19505943

.. |build-status| image:: https://travis-ci.org/pysam-developers/pysam.svg
    :alt: build status
    :scale: 100%
    :target: https://travis-ci.org/pysam-developers/pysam

.. |docs| image:: https://readthedocs.org/projects/pysam/badge/?version=latest
    :alt: Documentation Status
    :scale: 100%
    :target: https://pysam.readthedocs.org/en/latest/?badge=latest