Metadata-Version: 2.1
Name: derivative
Version: 0.2.0
Summary: Numerical differentiation in python.
Home-page: https://github.com/andgoldschmidt/derivative
License: MIT
Keywords: differentiation,derivative,gradient,prime
Author: Andy Goldschmidt
Author-email: andygold@uw.edu
Requires-Python: >=3.6,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Provides-Extra: docs
Requires-Dist: ipykernel (>=5.2.1,<6.0.0); extra == "docs"
Requires-Dist: jupyter_client (>=6.1.3,<7.0.0); extra == "docs"
Requires-Dist: matplotlib (>=3.2.1,<4.0.0); extra == "docs"
Requires-Dist: nbsphinx (>=0.6.1,<0.7.0); extra == "docs"
Requires-Dist: numpy (>=1.18.3,<2.0.0)
Requires-Dist: scipy (>=1.4.1,<2.0.0)
Requires-Dist: sklearn (>=0.0,<0.1)
Requires-Dist: sphinx (>=3.0.2,<4.0.0); extra == "docs"
Requires-Dist: sphinx_rtd_theme (>=0.4.3,<0.5.0); extra == "docs"
Project-URL: Documentation, https://derivative.readthedocs.io/
Project-URL: Repository, https://github.com/andgoldschmidt/derivative
Description-Content-Type: text/x-rst

.. image:: https://readthedocs.org/projects/derivative/badge/?version=latest
   :target: https://derivative.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status
  
.. image:: https://img.shields.io/badge/License-MIT-blue.svg
   :target: https://lbesson.mit-license.org/
   :alt: MIT License
 

Numerical differentiation of noisy time series data in python
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Numerical differentiation methods for noisy time series data in python includes:

.. code-block:: python

    from derivative import dxdt
    import numpy as np

    t = np.linspace(0,2*np.pi,50)
    x = np.sin(x)

    # 1. Finite differences with central differencing using 3 points.
    result1 = dxdt(x, t, kind="finite_difference", k=1)

    # 2. Savitzky-Golay using cubic polynomials to fit in a centered window of length 1
    result2 = dxdt(x, t, kind="savitzky_golay", left=.5, right=.5, order=3)

    # 3. Spectral derivative
    result3 = dxdt(x, t, kind="spectral")

    # 4. Spline derivative with smoothing set to 0.01
    result4 = dxdt(x, t, kind="spline", s=1e-2)

    # 5. Total variational derivative with regularization set to 0.01
    result5 = dxdt(x, t, kind="trend_filtered", order=0, alpha=1e-2)


1. Symmetric finite difference schemes using arbitrary window size.

2. Savitzky-Galoy derivatives of any polynomial order with independent left and right window parameters.

3. Spectral derivatives with optional filter.

4. Spline derivatives of any order.

5. Polynomial-trend-filtered derivatives generalizing methods like total variational derivatives.

The goal of this package is to provide some common numerical differentiation techniques that showcase improvements that can be made on finite differences when data is noisy. 

This package binds these common differentiation methods to a single easily implemented differentiation interface to encourage user adaptation.


References:
-----------

[1] Numerical differentiation of experimental data: local versus global methods- K. Ahnert and M. Abel

[2] Numerical Differentiation of Noisy, Nonsmooth Data- Rick Chartrand

[3] The Solution Path of the Generalized LASSO- R.J. Tibshirani and J. Taylor

