1.. cmsisdsp documentation master file, created by
2   sphinx-quickstart on Mon Feb 14 11:09:26 2022.
3   You can adapt this file completely to your liking, but it should at least
4   contain the root `toctree` directive.
5
6Welcome to CMSIS-DSP PythonWrapper's documentation!
7===================================================
8
9**cmsisdsp** is a Python wrapper for the Arm `CMSIS-DSP API <https://github.com/ARM-software/CMSIS_5/tree/develop/CMSIS/DSP>`_. With **cmsisdsp** you can run the `CMSIS-DSP API <https://github.com/ARM-software/CMSIS_5/tree/develop/CMSIS/DSP>`_ functions in Python. The functions are compatible with NumPy.
10
11The APIs of the functions in package **cmsisdsp** are as close as possible to the C versions to make it easier to migrate the Python implementation of your code to an equivalent C one running on the embedded target.
12
13In addition to the Python interface to the C functions, there are additional submodules.
14
15* :doc:`fixedpoint.py <fixedpoint>` is providing some tools to help generating the fixedpoint values expected
16  by CMSIS-DSP.
17* :doc:`mfcc.py <mfcc>` is generating some tools to generate the MEL filters, DCT and window coefficients
18  expected by the CMSIS-DSP MFCC implementation.
19
20Table of contents
21*****************
22.. toctree::
23
24   Python API to C functions <api>
25   datatype.py <datatype>
26   fixedpoint.py <fixedpoint>
27   mfcc.py <mfcc>
28
29.. note::
30
31   This project is under development.