Welcome to modlAMP's documentation!
===================================

**modlAMP**

.. image:: https://img.shields.io/pypi/v/modlamp.svg
   :target: https://pypi.org/project/modlamp/

.. image:: https://travis-ci.org/alexarnimueller/modlAMP.svg?branch=master
    :target: https://travis-ci.org/alexarnimueller/modlAMP

.. image:: https://codecov.io/gh/alexarnimueller/modlAMP/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/alexarnimueller/modlAMP

.. image:: https://img.shields.io/badge/License-BSD--3-lightgrey.svg
    :target: https://github.com/alexarnimueller/modlAMP/blob/master/LICENSE.rst

.. image:: https://img.shields.io/badge/DOI-10.1093%2Fbioinformatics%2Fbtx285-ff69b4.svg
    :target: https://doi.org/10.1093/bioinformatics/btx285

**Authors:** Alex Müller, Gisela Gabernet

**Copyright:** (c) 2016 - 2019 ETH Zurich, Switzerland; Alex Müller, Gisela Gabernet, Gisbert Schneider `(modlab)
<http://www.cadd.ethz.ch>`_.

This is a **Python package** (for Python 3 since version 4.0.0) that was designed for working with **peptides**, **proteins** or any
sequence of **natural amino acids**. It incorporates several modules, like sequence generation (module ``sequences``),
sequence library analysis (module ``analysis``) or descriptor calculation (module ``descriptors``). For
basic instructions on how to use the package, check the `README <readme.html>`_ or the `example script <examplescript
.html>`_. The project's GitHub page can be found here: http://github.com/alexarnimueller/modlamp

.. toctree::
   :caption: The package has the following contents:
   :maxdepth: 3
   :numbered:

   readme
   modlamp
   examplescript
   license
   todo

**If you use modlAMP in a scientific publication, we would appreciate citations to the following paper:**

Müller A. T. *et al.* (2017) modlAMP: Python for anitmicrobial peptides, *Bioinformatics* **33**, (17), 2753-2755,
DOI:`10.1093/bioinformatics/btx285 <https://doi.org/10.1093/bioinformatics/btx285>`_.

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
