pypi_description.rst

python-deltasigma

A port of the MATLAB Delta Sigma Toolbox based on free software and very little sleep

The python-deltasigma is a Python package to synthesize, simulate, scale and map to implementable topologies delta sigma modulators.

It aims to provide a 1:1 Python port of Richard Schreier's *excellent* MATLAB Delta Sigma Toolbox, the de facto standard tool for high-level delta sigma simulation, upon which it is very heavily based.

---

Homepage: python-deltasigma.io

Documentation: docs.python-deltasigma.io

Latest version: 0.2

Install

python-deltasigma runs on Linux, Mac OS X and Windows.

Installing requires Python 2.6+ or 3.3+, numpy, scipy (>= 0.11.0) and matplotlib.

Strongly recommended: Cython - for significantly faster delta sigma modulator simulations.

They are packaged by virtually all the major Linux distributions.

I do not run Windows, so I can't really provide more info (sorry), except that people tell me they manage to have a working setup.

When the dependencies are satisfied, run:

pip install deltasigma

to install the latest stable version from the Python Package Index (PYPI), or:

python setup.py install

if you're installing a development version from Git.

Extras

Install the sphinx package to build the documentation yourself.

The test suite requires setuptools, used to access the reference function outputs.

Testing can be automated with nose and triggered with:

python setup.py test

Documentation

In addition to the notebooks found in the examples/ directory, ported from the MATLAB Delta Sigma toolbox:

1. You can find the included package documentation online.

2. The original MATLAB Toolbox provides in-depth documentation, which is very useful to understand what the toolbox is capable of. See DSToolbox.pdf and OnePageStory.pdf (PDF warning).

3. The book:

   Richard Schreier, Gabor C. Temes, Understanding Delta-Sigma Data Converters, ISBN: 978-0-471-46585-0, November 2004, Wiley-IEEE Press

   is probably the most authoritative resource on the topic. Chapter 8-9 show how to use the MATLAB toolkit and the observations apply also to this Python port. Links on amazon, on the Wiley-IEEE press.

   I am not affiliated with neither the sellers nor the authors.

Licensing and copyright notice

All original MATLAB code is Copyright (c) 2009, Richard Schreier. See the LICENSE file for the licensing terms.

The Python code here provided is a derivative work from the above toolkit - a faithful port - and subject to the same license terms.

Credit goes to Richard Schreier for writing the MATLAB Delta Sigma Toolbox, devising algorithms and implementations and doing an excellent work at it.

This package contains some source code from pydsm, also based on the same MATLAB toolbox. The pydsm package is copyright (c) 2012, Sergio Callegari.

When not otherwise specified, the Python code is Copyright 2013, Giuseppe Venturini and the python-deltasigma contributors.

MATLAB is a registered trademark of The MathWorks, Inc.