Skip to content

Commit e843d94

Browse files
committed
Updated README to use markdown instead of rst.
1 parent d23f1f8 commit e843d94

File tree

1 file changed

+28
-36
lines changed

1 file changed

+28
-36
lines changed

README

Lines changed: 28 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,9 @@
1-
.. -*- mode: rst -*-
21

3-
.. image:: https://secure.travis-ci.org/veeresht/CommPy.svg?branch=master
4-
:target: https://secure.travis-ci.org/veeresht/CommPy
5-
6-
.. image:: https://coveralls.io/repos/veeresht/CommPy/badge.svg
7-
:target: https://coveralls.io/r/veeresht/CommPy
8-
9-
.. image:: https://badge.fury.io/py/scikit-commpy.svg
10-
:target: https://badge.fury.io/py/scikit-commpy
11-
12-
.. image:: https://readthedocs.org/projects/commpy/badge/?version=latest
13-
:target: http://commpy.readthedocs.io/en/latest/?badge=latest
14-
:alt: Documentation Status
152

3+
[![Build Status](https://secure.travis-ci.org/veeresht/CommPy.svg?branch=master)](https://secure.travis-ci.org/veeresht/CommPy)
4+
[![Coverage](https://coveralls.io/repos/veeresht/CommPy/badge.svg)](https://coveralls.io/r/veeresht/CommPy)
5+
[![PyPi](https://badge.fury.io/py/scikit-commpy.svg)](https://badge.fury.io/py/scikit-commpy)
6+
[![Docs](https://readthedocs.org/projects/commpy/badge/?version=latest)](http://commpy.readthedocs.io/en/latest/?badge=latest)
167

178
CommPy
189
======
@@ -27,7 +18,7 @@ Objectives
2718
Available Features
2819
------------------
2920
Channel Coding
30-
~~~~~~~~~~~~~~
21+
--------------
3122
- Encoder for Convolutional Codes (Polynomial, Recursive Systematic). Supports all rates and puncture matrices.
3223
- Viterbi Decoder for Convolutional Codes (Hard Decision Output).
3324
- MAP Decoder for Convolutional Codes (Based on the BCJR algorithm).
@@ -39,78 +30,79 @@ Channel Coding
3930
- Belief Propagation (BP) Decoder for LDPC Codes.
4031

4132
Channel Models
42-
~~~~~~~~~~~~~~
33+
--------------
4334
- Binary Erasure Channel (BEC)
4435
- Binary Symmetric Channel (BSC)
4536
- Binary AWGN Channel (BAWGNC)
4637

4738
Filters
48-
~~~~~~~
39+
-------
4940
- Rectangular
5041
- Raised Cosine (RC), Root Raised Cosine (RRC)
5142
- Gaussian
5243

5344
Impairments
54-
~~~~~~~~~~~
45+
-----------
5546
- Carrier Frequency Offset (CFO)
5647

5748
Modulation/Demodulation
58-
~~~~~~~~~~~~~~~~~~~~~~~
49+
-----------------------
5950
- Phase Shift Keying (PSK)
6051
- Quadrature Amplitude Modulation (QAM)
6152
- OFDM Tx/Rx signal processing
6253

6354
Sequences
64-
~~~~~~~~~
55+
---------
6556
- PN Sequence
6657
- Zadoff-Chu (ZC) Sequence
6758

6859
Utilities
69-
~~~~~~~~~
60+
---------
7061
- Decimal to bit-array, bit-array to decimal.
7162
- Hamming distance, Euclidean distance.
7263
- Upsample
7364

7465
FAQs
7566
----
7667
Why are you developing this?
77-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
68+
----------------------------
7869
During my coursework in communication theory and systems at UCSD, I realized that the best way to actually learn and understand the theory is to try and implement ''the Math'' in practice :). Having used Scipy before, I thought there should be a similar package for Digital Communications in Python. This is a start!
7970

8071
What programming languages do you use?
81-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
72+
--------------------------------------
8273
CommPy uses Python as its base programming language and python packages like NumPy, SciPy and Matplotlib.
8374

8475
How can I contribute?
85-
~~~~~~~~~~~~~~~~~~~~~
76+
---------------------
8677
Implement any feature you want and send me a pull request :). If you want to suggest new features or discuss anything related to CommPy, please get in touch with me (veeresht@gmail.com).
8778

8879
How do I use CommPy?
89-
~~~~~~~~~~~~~~~~~~~~
80+
--------------------
9081
Requirements/Dependencies
91-
^^^^^^^^^^^^^^^^^^^^^^^^^
82+
-------------------------
9283
- python 2.7 or above
93-
- numpy 1.9 or above
84+
- numpy 1.10 or above
9485
- scipy 0.15 or above
9586
- matplotlib 1.4 or above
9687
- nose 1.3 or above
9788

9889
Installation
99-
^^^^^^^^^^^^
90+
------------
10091

10192
- To use the released version on PyPi, use pip or conda to install as follows::
102-
103-
$ pip install scikit-commpy
104-
$ conda install -c https://conda.binstar.org/veeresht scikit-commpy
105-
93+
```
94+
$ pip install scikit-commpy
95+
$ conda install -c https://conda.binstar.org/veeresht scikit-commpy
96+
```
10697
- To work with the development branch, clone from github and install as follows::
107-
108-
$ git clone https://github.com/veeresht/CommPy.git
109-
$ cd CommPy
110-
$ python setup.py install
98+
```
99+
$ git clone https://github.com/veeresht/CommPy.git
100+
$ cd CommPy
101+
$ python setup.py install
102+
```
111103

112104
Citing CommPy
113-
^^^^^^^^^^^^^
105+
-------------
114106
If you use CommPy for a publication, presentation or a demo, I request you to please cite CommPy as follows:
115107

116108
Veeresh Taranalli, "CommPy: Digital Communication with Python, version 0.3.0. Available at https://github.com/veeresht/CommPy", 2015.

0 commit comments

Comments
 (0)