Skip to content

Commit c822e15

Browse files
committed
Updated documentation home page.
1 parent 1f6b39f commit c822e15

File tree

1 file changed

+51
-5
lines changed

1 file changed

+51
-5
lines changed

doc/index.rst

Lines changed: 51 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,63 @@
66
CommPy
77
==================================
88

9-
CommPy is an open source package implementing digital communications algorithms
10-
in Python using NumPy, SciPy, Matplotlib and Cython.
9+
CommPy is an open source package implementing digital communications algorithms
10+
in Python using NumPy, SciPy and Matplotlib.
11+
12+
Available Features
13+
------------------
14+
Channel Coding
15+
~~~~~~~~~~~~~~
16+
- Encoder for Convolutional Codes (Polynomial, Recursive Systematic). Supports all rates and puncture matrices.
17+
- Viterbi Decoder for Convolutional Codes (Hard Decision Output).
18+
- MAP Decoder for Convolutional Codes (Based on the BCJR algorithm).
19+
- Encoder for a rate-1/3 systematic parallel concatenated Turbo Code.
20+
- Turbo Decoder for a rate-1/3 systematic parallel concatenated turbo code (Based on the MAP decoder/BCJR algorithm).
21+
- Binary Galois Field GF(2^m) with minimal polynomials and cyclotomic cosets.
22+
- Create all possible generator polynomials for a (n,k) cyclic code.
23+
- Random Interleavers and De-interleavers.
24+
25+
Channel Models
26+
~~~~~~~~~~~~~~
27+
- Binary Erasure Channel (BEC)
28+
- Binary Symmetric Channel (BSC)
29+
- Binary AWGN Channel (BAWGNC)
30+
31+
Filters
32+
~~~~~~~
33+
- Rectangular
34+
- Raised Cosine (RC), Root Raised Cosine (RRC)
35+
- Gaussian
36+
37+
Impairments
38+
~~~~~~~~~~~
39+
- Carrier Frequency Offset (CFO)
40+
41+
Modulation/Demodulation
42+
~~~~~~~~~~~~~~~~~~~~~~~
43+
- Phase Shift Keying (PSK)
44+
- Quadrature Amplitude Modulation (QAM)
45+
- OFDM Tx/Rx signal processing
46+
47+
Sequences
48+
~~~~~~~~~
49+
- PN Sequence
50+
- Zadoff-Chu (ZC) Sequence
51+
52+
Utilities
53+
~~~~~~~~~
54+
- Decimal to bit-array, bit-array to decimal.
55+
- Hamming distance, Euclidean distance.
56+
- Upsample
57+
58+
1159

1260
Reference
1361
---------
1462
.. toctree::
1563
:maxdepth: 1
16-
64+
1765
channelcoding
1866
filters
1967
modulation
2068
sequences
21-
22-

0 commit comments

Comments
 (0)