Skip to content

Commit e580696

Browse files
committed
Ready for v0.8 pip update
1 parent c2f6fc9 commit e580696

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

commpy/channelcoding/ldpc.py

+4-3
Original file line numberDiff line numberDiff line change
@@ -304,15 +304,16 @@ def triang_ldpc_systematic_encode(message_bits, ldpc_code_params, pad=True):
304304
Encode bits using the LDPC code specified. If the generator matrix is not computed, this function will build it
305305
and add it to the dictionary. It will also add the parity check matrix.
306306
307-
This function work only for LDPC specified by a triangular parity check matrix.
307+
This function work only for LDPC specified by a approximate triangular parity check matrix.
308308
309309
Parameters
310310
----------
311311
message_bits : 1D-array
312312
Message bit to encode.
313313
314314
ldpc_code_params : dictionary that at least contains one of these options:
315-
Option 1: generator matrix is available.
315+
Option 1: generator matrix and parity-check matrix are available.
316+
parity_check_matrix (CSC sparse matrix of int8) - parity check matrix.
316317
generator_matrix (2D-array or sparse matrix) - generator matrix of the code.
317318
Option 2: generator and parity check matrices will be added as sparse matrices.
318319
n_vnodes (int) - number of variable nodes.
@@ -337,7 +338,7 @@ def triang_ldpc_systematic_encode(message_bits, ldpc_code_params, pad=True):
337338
If the message length is not a multiple of block length and pad is False.
338339
"""
339340

340-
if ldpc_code_params.get('generator_matrix') is None:
341+
if ldpc_code_params.get('generator_matrix') is None or ldpc_code_params.get('parity_check_matrix') is None:
341342
build_matrix(ldpc_code_params)
342343

343344
block_length = ldpc_code_params['generator_matrix'].shape[1]

setup.py

+4-3
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@
66
# Taken from scikit-learn setup.py
77
DISTNAME = 'scikit-commpy'
88
DESCRIPTION = 'Digital Communication Algorithms with Python'
9-
LONG_DESCRIPTION = open('README.md').read()
9+
LONG_DESCRIPTION = open('README.md', encoding="utf8").read()
1010
MAINTAINER = 'Veeresh Taranalli & Bastien Trotobas'
11-
MAINTAINER_EMAIL = 'veeresht@gmail.com'
11+
MAINTAINER_EMAIL = 'bastien.trotobas@gmail.com'
1212
URL = 'http://veeresht.github.com/CommPy'
1313
LICENSE = 'BSD 3-Clause'
14-
VERSION = '0.7.0'
14+
VERSION = '0.8.0'
1515

1616
#This is a list of files to install, and where
1717
#(relative to the 'root' dir, where setup.py is)
@@ -53,6 +53,7 @@
5353
'Intended Audience :: Science/Research',
5454
'Intended Audience :: Telecommunications Industry',
5555
'Operating System :: Unix',
56+
'Operating System :: Microsoft :: Windows',
5657
'Programming Language :: Python',
5758
'Topic :: Scientific/Engineering',
5859
'Topic :: Software Development',

0 commit comments

Comments
 (0)