[WIP] First release

.coveragerc

@@ -0,0 +1,4 @@
+[run]
+omit=
+    *_base.py
+    voicechat_modem_dsp/__main__.py

.gitignore

@@ -104,4 +104,7 @@ venv.bak/
 .mypy_cache/
 
 #Custom additions
-.vscode/
+.vscode/
+*.wav
+#MyPy stubgen
+out/

.travis.yml

@@ -3,25 +3,33 @@ language: python
 notifications:
   email: false
 
-python:
-  - "3.7"
-  - "3.4"
-  - "3.6"
-  - "3.5"
+#TODO: properly troubleshoot mypy permission errors
+matrix:
+  include:
+    - python: '3.8'
+      os: linux
+    - python: '3.7'
+      env: MYPY=true
+      os: linux
+    - python: '3.6'
+      os: linux
+    - python: '3.5'
+      os: linux
+
 cache: pip
 
 install:
-  - if [ $TRAVIS_PYTHON_VERSION = "3.4" ]; then pip install pip==18.0; fi
   - pip install pipenv
   - rm Pipfile.lock # Re-lock dependencies
   - pipenv lock -r > requirements.txt
   - cat requirements.txt
   - pip install -r requirements.txt
-  - pip install pytest coverage
-  - if [ $TRAVIS_PYTHON_VERSION = "3.7" ]; then pip install mypy; fi
+  - pip install -U pytest coverage pytest-cov pytest-xdist # Dev dependencies
+  - if [ "$MYPY" = true ]; then pip install mypy; pip install -e git+https://github.com/numpy/numpy-stubs.git#egg=numpy-stubs; fi
 
 script:
   - sh ./run_tests_coverage.sh
+  - if [ "$MYPY" = true ]; then sh ./run_mypy.sh; fi
 
 after_script:
   - wget -O codecov_upload "https://codecov.io/bash"

Pipfile

@@ -5,10 +5,26 @@ name = "pypi"
 
 [packages]
 numpy = "*"
-scipy = "*"
+scipy = {version = ">=1.4.0"}
 protobuf = "*"
+ipykernel = "*"
+cleo = "*"
+strictyaml = "*"
+matplotlib = "*"
 
 [dev-packages]
 pytest = "*"
-mypy = {version="*", python_version=">='3.5'"}
 coverage = "*"
+Sphinx = "*"
+nbsphinx = "*"
+itikz = "*"
+pytest-xdist = "*"
+pytest-cov = "*"
+
+[dev-packages.mypy]
+version = "*"
+python_version = ">='3.5'"
+
+[dev-packages.numpy-stubs]
+git = "https://github.com/numpy/numpy-stubs.git"
+editable = true

README.md

@@ -1,9 +1,13 @@
 # voicechat-modem-dsp
 
-[![Build Status](https://travis-ci.org/rlee287/voicechat-modem-dsp.svg?branch=master)](https://travis-ci.org/rlee287/voicechat-modem-dsp) 
+[![Build Status](https://travis-ci.com/rlee287/voicechat-modem-dsp.svg?branch=master)](https://travis-ci.com/rlee287/voicechat-modem-dsp) 
 [![codecov](https://codecov.io/gh/rlee287/voicechat-modem-dsp/branch/master/graph/badge.svg)](https://codecov.io/gh/rlee287/voicechat-modem-dsp)
 [![CodeFactor](https://www.codefactor.io/repository/github/rlee287/voicechat-modem-dsp/badge)](https://www.codefactor.io/repository/github/rlee287/voicechat-modem-dsp)
 
 `voicechat-modem` is an implementation of an audio modem communication program that transmits data over a voice/audio channel. The goal is to allow for data transmission and normal speaking over a voice channel simultaneously such that human communication will not interfere with the data transmission.
 
 This is the DSP portion of `voicechat-modem` which modulates and demodulates data. It will write audio to an audio file, and eventually, use a protobuf communication channel to communicate with other programs to allow for live data transmission and receiving.
+
+Requirements:
+ - Python>=3.5
+ - Requirements listed in `Pipfile`

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,53 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'Voicechat Modem (DSP Component)'
+copyright = '2019, rlee287'
+author = 'rlee287'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "nbsphinx","sphinx.ext.mathjax"
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', "**.ipynb_checkpoints", 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'haiku' # default alabaster
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']

docs/index.rst

@@ -0,0 +1,25 @@
+.. Voicechat Modem (DSP Component) documentation master file, created by
+   sphinx-quickstart on Tue Nov 12 21:38:15 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Voicechat Modem (DSP Component)'s documentation!
+===========================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   notebooks/Datastream Upsampling
+   notebooks/Pre-Modulation Gaussian Smoothing
+   notebooks/QAM Modulator
+   notebooks/FSK Modulator
+   specs/config
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd