Metadata-Version: 2.1
Name: pyldpc
Version: 0.7.8
Summary: Simulation of Low Density Parity Check (LDPC) Codes
Home-page: https://github.com/hichamjanati/pyldpc
Author: Hicham Janati
Author-email: hicham.janati100@gmail.com
License: MIT
Description: 
        |Travis|_ |AppVeyor|_ |Codecov|_
        
        .. |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
        
        
        =============================================
        **Simulation of LDPC Codes & Applications**
        =============================================
        *version 0.7.8*
        
        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
        ------------
        
        If you already have a working Python environment (Anaconda for e.g):
        
        ::
        
            pip install --upgrade pyldpc
        
        Otherwise, we recommend creating this minimal `conda env <https://raw.githubusercontent.com/hichamjanati/pyldpc/master/environment.yml>`_
        
        ::
        
            conda env create --file environment.yml
            conda activate pyldpc-env
            pip install -U 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 = 20
            >>> 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)
            >>> x = get_message(G, d)
            >>> assert abs(x - v).sum() == 0
        
        Documentation
        -------------
        
        For more examples, see `the pyldpc webpage <https://hichamjanati.github.io/pyldpc/>`_.
        
Keywords: codes ldpc error decoding information theory
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
Provides-Extra: tests
Provides-Extra: docs
