Metadata-Version: 2.1
Name: pyldpc
Version: 0.7.6
Summary: Simulation of Low Density Parity Check Codes ldpc
Home-page: https://github.com/hichamjanati/pyldpc
Author: Hicham Janati
Author-email: hicham.janati100@gmail.com
License: MIT
Keywords: codes ldpc error detection decoding coding pyldpc
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Telecommunications Industry
Classifier: Natural Language :: English
Requires-Dist: numpy
Requires-Dist: scipy
Provides-Extra: docs
Requires-Dist: sphinx ; extra == 'docs'
Requires-Dist: sphinx-gallery ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Requires-Dist: numpydoc ; extra == 'docs'
Requires-Dist: matplotlib ; extra == 'docs'
Requires-Dist: download ; extra == 'docs'
Provides-Extra: tests
Requires-Dist: pytest ; extra == 'tests'
Requires-Dist: pytest-cov ; extra == 'tests'


|Travis|_ |AppVeyor|_ |Codecov|_ |CircleCI|_ |ReadTheDocs|_

.. |Travis| image:: https://travis-ci.com/hichamjanati/pyldpc.svg?branch=master
.. _Travis: https://travis-ci.com/hichamjanati/pyldpc

.. |AppVeyor| image:: https://ci.appveyor.com/api/projects/status/l7g6vywwwuyha49l?svg=true
.. _AppVeyor: https://ci.appveyor.com/project/hichamjanati/pyldpc

.. |Codecov| image:: https://codecov.io/gh/hichamjanati/pyldpc/branch/master/graph/badge.svg
.. _Codecov: https://codecov.io/gh/hichamjanati/pyldpc

.. |CircleCI| image:: https://circleci.com/gh/hichamjanati/pyldpc.svg?style=svg
.. _CircleCI: https://circleci.com/gh/hichamjanati/pyldpc/tree/master

.. |ReadTheDocs| image:: https://readthedocs.org/projects/pyldpc/badge/?version=latest
.. _ReadTheDocs: https://pyldpc.readthedocs.io/en/latest/



=============================================
**Simulation of LDPC Codes & Applications**
=============================================
*version 0.7.6*

Description:
------------
- Simulation of regular LDPC codes.
- Probabilistic decoding: Belief Propagation algorithm for gaussian white noise transmission.
- Simulation application to image and audio data.

**Image coding-decoding example:**

.. .. image:: https://media.giphy.com/media/l4KicsAauqIWjeFR6/giphy.gif
.. image:: https://media.giphy.com/media/l0COHC49bK6g7yIPm/giphy.gif


**Sound coding-decoding example:**

 `Sound Transmission <http://nbviewer.jupyter.org/github/hichamjanati/pyldpc-tutos/blob/master/Example-Sound.ipynb>`_


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

From pip::

    $ pip install --upgrade pyldpc

Example
-------

.. code:: python

    >>> import numpy as np
    >>> from pyldpc import make_ldpc, encode, decode, get_message
    >>> n = 15
    >>> d_v = 4
    >>> d_c = 5
    >>> snr = 10
    >>> H, G = make_ldpc(n, d_v, d_c, systematic=True, sparse=True)
    >>> k = G.shape[1]
    >>> v = np.random.randint(2, size=k)
    >>> y = encode(G, v, snr)
    >>> d = decode(H, y, snr, maxiter=100, log=True)
    >>> x = get_message(G, d)
    >>> assert abs(x - v).sum() == 0

Contact:
--------
Please contact hicham.janati@inria.fr for any bug encountered / any further information.


