Skip to content

JSS95/curvesimilarities

Repository files navigation

CurveSimilarities

License CI CD Docs Supported Python Versions PyPI Version

title

A Numpy-friendly package for curve similarity measures.

List of supported measures:

  • Dynamic time warping distance (dtw())
  • (Continuous) Fréchet distance (fd())
  • Discrete Fréchet distance (dfd())
  • Integral Fréchet distance (ifd())

Usage

>>> import numpy as np
>>> from curvesimilarities import fd  # (Continuous) Fréchet distance
>>> fd(np.array([[0, 0], [1, 3], [2, 0]]), np.array([[0, 1], [2, 1]]))
2.0

Installation

CurveSimilarities can be installed using pip.

$ pip install curvesimilarities

Documentation

CurveSimilarities is documented with Sphinx. The manual can be found on Read the Docs:

https://curvesimilarities.readthedocs.io/

If you want to build the document yourself, get the source code and install with [doc] dependency. Then, go to doc directory and build the document:

$ pip install .[doc]
$ cd doc
$ make html

Document will be generated in build/html directory. Open index.html to see the central page.

About

Python package for curve similarity measures.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages