Metadata-Version: 2.1
Name: vmapper
Version: 0.1.0.dev202308060456
Summary: V-Mapper
Home-page: https://github.com/yusuke-imoto-lab/V-Mapper
Author: Yusuke Imoto
Requires-Python: >=3.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: graphviz (>=0.17)
Requires-Dist: matplotlib (>=3.4.3)
Requires-Dist: numpy (>=1.20)
Requires-Dist: scikit-learn (>=0.24)
Project-URL: Documentation, https://yusuke-imoto-lab.github.io/V-Mapper/
Project-URL: Repository, https://github.com/yusuke-imoto-lab/V-Mapper
Description-Content-Type: text/markdown

# V-Mapper - Velocity Mapper

<div style="text-align:left"><img style="width:50%; height: auto" src="https://github.com/yusuke-imoto-lab/V-Mapper/blob/main/images/Logo_VMapper.png"/></div>
<div style="text-align:left"><img style="width:60%; height: auto" src="https://github.com/yusuke-imoto-lab/V-Mapper/blob/main/images/VMapper_Top.jpg"/></div>

V-Mapper (velocity Mapper) is an extension of Mapper, which is a well-known topological data analysis (TDA)  method for extracting high-dimensional topological structures as a graph \[[Singh et al., 2007](https://doi.org/10.2312/SPBG/SPBG07/091-100)\].
V-Mapper is for high-dimensional data with position and velocity and describes a topological structure and flows on it simultaneously as a weighted directed graph (V-Mapper graph) by embedding given velocity data in the edges of the Mapper graph.

[Y. Imoto and Y. Hiraoka. V-Mapper: topological data analysis for high-dimensional data with velocity, 2023, Nonlinear Theory and Its Applications, IEICE](https://doi.org/10.1587/nolta.14.92). 


## Installation
To install V-Mapper package, use `pip` as follows:

```
$ pip install vmapper
```

## Requirements
* Python3
* numpy
* scipy
* scikit-learn

