Welcome to msicpe's documentation!
===================================


**msicpe** is a Python library used for practical sessions of Maths Signal, Image  at [CPE Lyon](https://www.cpe.fr/).
Developped and maintained for teaching usage only!

Installation
============

In a Jupyter Notebook
---------------------

```!pip install -U msicpe```

In a local environment
----------------------

```pip install -U msicpe```

Usage example
=============

The example below uses the kurtosis method available in the `tsa` subpackage of `msicpe`.
It requires `numpy.randn` to generate a gaussian distribution of N points.

>>> import numpy as np
>>> from msicpe.tsa import kurtosis
>>> N=10000
>>> x=np.randn(1,N)
>>> kurt=kurtosis(x)
>>> print(kurt)

.. note::

   This project is under active development.

Contents
--------

.. toctree::

   Home <self>
   msicpe