Metadata-Version: 2.1
Name: HTSeq
Version: 1.99.2
Summary: A framework to process and analyze data from high-throughput sequencing (HTS) assays
Home-page: https://github.com/htseq
Author: Simon Anders, Fabio Zanini
Author-email: fabio.zanini@unsw.edu.au
Maintainer: Fabio Zanini
Maintainer-email: fabio.zanini@unsw.edu.au
License: GPL3
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Description-Content-Type: text/markdown
Provides-Extra: htseq-qa
Provides-Extra: test
License-File: LICENSE

![CI](https://github.com/htseq/htseq/workflows/CI/badge.svg)
[![Documentation Status](https://readthedocs.org/projects/htseq/badge/?version=master)](https://htseq.readthedocs.io)

# HTSeq
**DEVS**: https://github.com/htseq/htseq

**DOCS**: https://htseq.readthedocs.io

A Python library to facilitate programmatic analysis of data
from high-throughput sequencing (HTS) experiments. A popular component of ``HTSeq``
is ``htseq-count``, a script to quantify gene expression in bulk and single-cell RNA-Seq
and similar experiments.

## Requirements

To use ``HTSeq`` you need:

-  ``Python >= 3.7`` (**note**: ``Python 2.7`` support has been dropped)
-  ``numpy``
-  ``pysam``

To manipulate BigWig files, you also need:

- ``pyBigWig``

To run the ``htseq-qa`` script, you also need:

-  ``matplotlib``

To run ``htseq-count`` and ``htseq-count-barcodes`` with custom output formats for the counts table, you need:

- ``mtx`` file: ``scipy``
- ``h5ad`` file: ``anndata``
- ``loom`` file: ``loompy``

Both **Linux** and **OSX** are supported and binaries are provided on Pypi. We
would like to support **Windows** but currently lack the expertise to do so. If
you would like to take on the Windows release and maintenance, please open an
issue and we'll try to help.

A source package which should not require ``Cython`` nor ``SWIG`` is also
provided on Pypi.

To **develop** `HTSeq` you will **also** need:

-  ``Cython >=0.29.5``
-  ``SWIG >=3.0.8``

## Installation

### PIP

To install directly from PyPI:

```bash
pip install HTSeq
```

To install a specific version:

```bash
pip install 'HTSeq==0.13.5'
```

If this fails, please install all dependencies first:

```bash
pip install matplotlib
pip install Cython
pip install pysam
pip install HTSeq
```

### setup.py (distutils/setuptools)

Install the dependencies with your favourite tool (``pip``, ``conda``,
etc.).

To install ``HTSeq`` itself, run:

```bash
python setup.py build install
```

## Testing
To test locally, run

```bash
./test.sh
```

To test `htseq-count` alone, run it with the `-o` option.

A virtual environment is created in the `.venv` folder and `HTSeq` is installed inside it, including all modules and scripts.

## Authors
- 2016-: Fabio Zanini @ https://fabilab.org.
- 2010-2015: Simon Anders, Wolfgang Huber


