Skip to content

Commit b6213ed

Browse files
committed
Updated.
1 parent bca3b2d commit b6213ed

File tree

1 file changed

+14
-17
lines changed

1 file changed

+14
-17
lines changed

README.rst

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
CommPy
99
======
1010

11-
CommPy is an open source toolkit implementing digital communications algorithms
12-
in Python using SciPy, NumPy and Cython.
11+
CommPy is an open source toolkit implementing digital communications algorithms
12+
in Python using NumPy and SciPy.
1313

1414
Objectives
1515
----------
@@ -25,10 +25,10 @@ Channel Coding
2525
- Encoder for a rate-1/3 systematic parallel concatenated Turbo Code.
2626
- Turbo Decoder for a rate-1/3 systematic parallel concatenated turbo code (Based on the MAP decoder/BCJR algorithm).
2727
- Binary Galois Field GF(2^m) with minimal polynomials and cyclotomic cosets.
28-
- Create all possible generator polynomials for a (n,k) cyclic code.
28+
- Create all possible generator polynomials for a (n,k) cyclic code.
2929
- Random Interleavers and De-interleavers.
3030

31-
Channel Models
31+
Channel Models
3232
~~~~~~~~~~~~~~
3333
- Binary Erasure Channel (BEC)
3434
- Binary Symmetric Channel (BSC)
@@ -50,7 +50,7 @@ Modulation/Demodulation
5050
- Quadrature Amplitude Modulation (QAM)
5151
- OFDM Tx/Rx signal processing
5252

53-
Sequences
53+
Sequences
5454
~~~~~~~~~
5555
- PN Sequence
5656
- Zadoff-Chu (ZC) Sequence
@@ -69,7 +69,7 @@ During my coursework in communication theory and systems at UCSD, I realized tha
6969

7070
What programming languages do you use?
7171
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
72-
CommPy uses Python as its base programming language and python packages like NumPy, SciPy and Matplotlib. Some algorithms which are too slow in a pure Python implementation are implemented using Cython.
72+
CommPy uses Python as its base programming language and python packages like NumPy, SciPy and Matplotlib.
7373

7474
How can I contribute?
7575
~~~~~~~~~~~~~~~~~~~~~
@@ -79,11 +79,11 @@ How do I use CommPy?
7979
~~~~~~~~~~~~~~~~~~~~
8080
Requirements/Dependencies
8181
^^^^^^^^^^^^^^^^^^^^^^^^^
82-
- Python 2.7 or above
83-
- NumPy 1.6 or above
84-
- SciPy 0.10 or above
85-
- Matplotlib 1.1 or above
86-
- Cython 0.15 or above
82+
- python 2.7 or above
83+
- numpy 1.9 or above
84+
- scipy 0.15 or above
85+
- matplotlib 1.4 or above
86+
- nose 1.3 or above
8787

8888
Installation
8989
^^^^^^^^^^^^
@@ -92,18 +92,15 @@ Installation
9292

9393
$ git clone https://github.com/veeresht/CommPy.git
9494
$ cd CommPy
95-
$ sudo python setup.py build_ext --inplace
96-
$ sudo python setup.py install
95+
$ sudo python setup.py install
9796

9897
- To install using pip or easy_install use the following commands::
99-
98+
10099
$ sudo pip install scikit-commpy
101-
$ sudo easy_install scikit-commpy
100+
$ sudo easy_install scikit-commpy
102101

103102

104103
I would greatly appreciate your feedback if you have found CommPy useful. Just send me a mail: [email protected]
105104

106105

107106
For more details on CommPy, please visit http://veeresht.github.com/CommPy
108-
109-
.. _here: https://trello.com/board/commpy/4f44785f28107d10684bbd7d

0 commit comments

Comments
 (0)