https://github.com/jss95/curvesimilarities

Python package for curve similarity measures.
https://github.com/jss95/curvesimilarities

frechet-distance geometry mathematics python

Last synced: 10 days ago
JSON representation

Python package for curve similarity measures.

• Host: GitHub
• URL: https://github.com/jss95/curvesimilarities
• Owner: JSS95
• License: bsd-3-clause
• Created: 2024-05-17T08:13:22.000Z (6 months ago)
• Default Branch: master
• Last Pushed: 2024-06-19T15:56:26.000Z (5 months ago)
• Last Synced: 2024-06-19T20:21:35.317Z (5 months ago)
• Topics: frechet-distance, geometry, mathematics, python
• Language: Python
• Homepage: https://pypi.org/project/curvesimilarities
• Size: 79.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# CurveSimilarities

[![License](https://img.shields.io/github/license/JSS95/curvesimilarities)](https://github.com/JSS95/curvesimilarities/blob/master/LICENSE)

[![CI](https://github.com/JSS95/curvesimilarities/actions/workflows/ci.yml/badge.svg)](https://github.com/JSS95/curvesimilarities/actions/workflows/ci.yml)

[![CD](https://github.com/JSS95/curvesimilarities/actions/workflows/cd.yml/badge.svg)](https://github.com/JSS95/curvesimilarities/actions/workflows/cd.yml)

[![Docs](https://readthedocs.org/projects/curvesimilarities/badge/?version=latest)](https://curvesimilarities.readthedocs.io/en/latest/?badge=latest)

[![Supported Python Versions](https://img.shields.io/pypi/pyversions/curvesimilarities.svg)](https://pypi.python.org/pypi/curvesimilarities/)

[![PyPI Version](https://img.shields.io/pypi/v/curvesimilarities.svg)](https://pypi.python.org/pypi/curvesimilarities/)

![title](https://curvesimilarities.readthedocs.io/en/latest/_images/plot-header.png)

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

```python

>>> 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](https://pypi.org/project/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.