Merge branch 'feature/fix-installation'

Author: grigory

.travis.yml

@@ -0,0 +1,9 @@
+language: python
+python:
+  - "3.6"
+  - "3.7"
+  - "3.8"
+install:
+  - pip install -r requirements.txt
+script:
+  - make test

LICENSE.MD LICENSE.txtLICENSE.MD renamed to LICENSE.txt

@@ -0,0 +1,7 @@
+include pyproject.toml
+
+# Include the README
+include README.md
+
+# Include the license file
+include LICENSE.txt

MANIFEST.in

@@ -0,0 +1,6 @@
+# -----------------------------------------------------------------------------
+# Run tests
+# -----------------------------------------------------------------------------
+
+test:
+	python -m unittest discover

Makefile

@@ -73,8 +73,25 @@ for snr in snr_range:
 
 ## TODO
 
-[TODO List](TODO.md)
+### General
+
+- [ ] Fix CRC-aided SC List decoder
+
+### Polar code construction
+
+- [ ] Arikan’s Monte-Carlo estimation [Section V.B](https://arxiv.org/pdf/1501.02473.pdf)
+- [ ] Trifonov’s Gaussian approximation [Section V.D](https://arxiv.org/pdf/1501.02473.pdf)
+
+### Decoding
+- [ ] [SC STACK Decoding](https://ieeexplore.ieee.org/document/6215306)
+- [ ] [Fast SSC List Decoding](https://arxiv.org/pdf/1703.08208.pdf)
+- [ ] [Generalized Fast SSC LIST Decoding](https://arxiv.org/pdf/1804.09508.pdf)
+
+### Modulation
+
+- [ ] Q-PSK
+- [ ] 4-QAM
 
 ## License
 
-[MIT License](LICENSE.MD)
+[MIT License](LICENSE.txt)

README.md

@@ -0,0 +1,5 @@
+[build-system]
+# These are the assumed default build requirements from pip:
+# https://pip.pypa.io/en/stable/reference/pip/#pep-517-and-518-support
+requires = ["setuptools>=40.8.0", "wheel"]
+build-backend = "setuptools.build_meta"

TODO.md

@@ -0,0 +1,5 @@
+from .fast_ssc import FastSSCPolarCodec
+from .g_fast_ssc import GFastSSCPolarCodec
+from .rc_scan import RCSCANPolarCodec
+from .sc import SCPolarCodec
+from .sc_list import SCListPolarCodec

pyproject.toml

@@ -1,3 +1,3 @@
-from .codec import GeneralizedFastSSCPolarCodec
-from .decoder import GeneralizedFastSSCDecoder
+from .codec import GFastSSCPolarCodec
+from .decoder import GFastSSCDecoder
 from .node import GFastSSCNode

python_polar_coding/polar_codes/__init__.py

@@ -2,16 +2,16 @@
 
 from python_polar_coding.polar_codes.fast_ssc import FastSSCPolarCodec
 
-from .decoder import GeneralizedFastSSCDecoder
+from .decoder import GFastSSCDecoder
 
 
-class GeneralizedFastSSCPolarCodec(FastSSCPolarCodec):
+class GFastSSCPolarCodec(FastSSCPolarCodec):
     """Generalized Fast SSC code.
 
     Based on: https://arxiv.org/pdf/1804.09508.pdf
 
     """
-    decoder_class = GeneralizedFastSSCDecoder
+    decoder_class = GFastSSCDecoder
 
     def __init__(
             self,